Merge pull request #129 from import-ai/fix/e2e_test

Fix/e2e test

Author: LucienShui

.env.example

@@ -1,4 +1,4 @@
-name: Registry push
+name: CI
 
 on:
   push:
@@ -15,10 +15,10 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  runtime:
+  check-dependencies:
     runs-on: ubuntu-latest
     outputs:
-      runtime_built: ${{ steps.set_output.outputs.runtime_built }}
+      changed: ${{ steps.dep-check.outputs.changed }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -27,16 +27,25 @@ jobs:
         run: git fetch origin main
 
       - name: Check if dependencies changed
-        id: depcheck
+        id: dep-check
         run: |
           if git diff --name-only origin/main | grep -E 'package.json|pnpm-lock.yaml|pnpm-workspace.yaml|runtime.Dockerfile'; then
             echo "changed=true" >> $GITHUB_OUTPUT
           else
             echo "changed=false" >> $GITHUB_OUTPUT
           fi
 
+  runtime:
+    runs-on: ubuntu-latest
+    needs: [check-dependencies]
+    if: needs.check-dependencies.outputs.changed == 'true'
+    outputs:
+      runtime_built: 'true'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
       - name: Docker meta (runtime)
-        if: steps.depcheck.outputs.changed == 'true'
         id: meta_runtime
         uses: docker/metadata-action@v5
         with:
@@ -47,23 +56,19 @@ jobs:
             type=raw,value=latest
 
       - name: Set up QEMU
-        if: steps.depcheck.outputs.changed == 'true'
         uses: docker/setup-qemu-action@v3
 
       - name: Set up Docker Buildx
-        if: steps.depcheck.outputs.changed == 'true'
         uses: docker/setup-buildx-action@v3
 
       - name: Login to ghcr.io Registry
-        if: steps.depcheck.outputs.changed == 'true'
         uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build and push runtime image
-        if: steps.depcheck.outputs.changed == 'true'
         uses: docker/build-push-action@v6
         with:
           context: .
@@ -74,14 +79,70 @@ jobs:
           platforms: |
             linux/amd64
             linux/arm64
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
 
-      - name: Set output
-        id: set_output
-        run: echo "runtime_built=${{ steps.depcheck.outputs.changed }}" >> $GITHUB_OUTPUT
+  test:
+    runs-on: ubuntu-latest
+    needs: [check-dependencies, runtime]
+    if: always() && !cancelled() && !failure()
+    services:
+      postgres:
+        image: postgres:17.5
+        env:
+          POSTGRES_PASSWORD: omnibox
+          POSTGRES_USER: omnibox
+          POSTGRES_DB: omnibox
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+      minio:
+        image: ghcr.io/import-ai/minio-server:RELEASE.2025-04-22T22-12-26Z
+        env:
+          MINIO_ROOT_USER: username
+          MINIO_ROOT_PASSWORD: password
+        ports:
+          - 9000:9000
+          - 9100:9001
+        options: >-
+          --health-cmd "curl -f http://localhost:9000/minio/health/live"
+          --health-interval 30s
+          --health-timeout 20s
+          --health-retries 3
+
+    container:
+      image: ghcr.io/import-ai/omnibox-backend-runtime:latest
+      credentials:
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Prepare .env
+        run: cp example.env .env
+
+      - name: Run unit tests
+        run: pnpm run test
+
+      - name: Run e2e tests
+        env:
+          OBB_POSTGRES_URL: postgres://omnibox:omnibox@postgres:5432/omnibox
+          OBB_MINIO_URL: http://username:password@minio:9000/omnibox
+        run: pnpm run test:e2e
 
   app:
     runs-on: ubuntu-latest
-    needs: [ runtime ]
+    needs: [test]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -123,17 +184,24 @@ jobs:
           platforms: |
             linux/amd64
             linux/arm64
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
 
   webhook:
     runs-on: ubuntu-latest
-    needs: [ app ]
+    needs: [app]
     steps:
       - name: DEV Webhook
-        if: github.event_name == 'push'
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
         run: |
           curl "${{ secrets.DEV_WEBHOOK_URL }}/dev" -H "Authorization: Bearer ${{ secrets.DEV_WEBHOOK_API_KEY }}"
 
       - name: PR Webhook
         if: github.event_name == 'pull_request'
         run: |
           curl "${{ secrets.DEV_WEBHOOK_URL }}/pr?module=backend&pr=pr-${{ github.event.number }}" -H "Authorization: Bearer ${{ secrets.DEV_WEBHOOK_API_KEY }}"
+
+      - name: PROD Webhook
+        if: false && github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        run: |
+          curl "${{ secrets.PROD_WEBHOOK_URL }}/prod?tag=${{ github.ref }}" -H "Authorization: Bearer ${{ secrets.PROD_WEBHOOK_API_KEY }}"

.github/workflows/ci.yaml

@@ -10,7 +10,6 @@ services:
       OBB_DB_HOST: postgres
       OBB_MINIO_ENDPOINT: http://username:password@minio:9000
       OBB_WIZARD_BASE_URL: http://wizard:8000
-      OBB_MEILI_HOST: http://meilisearch:7700
     depends_on:
       postgres:
         condition: service_healthy

base.yaml

@@ -0,0 +1,22 @@
+OBB_PORT=8000
+
+OBB_WIZARD_BASE_URL=http://wizard:8000
+OBB_LOG_LEVELS=error,warn,log
+
+OBB_POSTGRES_URL=postgres://omnibox:omnibox@postgres:5432/omnibox
+OBB_DB_LOGGING=false
+OBB_DB_SYNC=false
+
+OBB_MINIO_URL=http://username:password@minio:9000/omnibox
+
+OBB_JWT_SECRET=your-secret-key
+OBB_JWT_EXPIRE=2678400s
+
+OBB_MAIL_TRANSPORT=smtps://your-email@example.com:your-email-password@smtp.example.com:465
+OBB_MAIL_FROM="No Reply <no-reply@example.com>"
+
+OBB_WECHAT_APP_ID=
+OBB_WECHAT_APP_SECRET=
+OBB_OPEN_WECHAT_APP_ID=
+OBB_OPEN_WECHAT_APP_SECRET=
+OBB_WECHAT_REDIRECT_URI=

example.env

@@ -5,7 +5,7 @@ module.exports = {
   transform: {
     '^.+\\.ts$': 'ts-jest',
   },
-  setupFilesAfterEnv: ['<rootDir>/../jest.setup.js'],
+  setupFilesAfterEnv: ['<rootDir>/../jest.setup.ts'],
   collectCoverageFrom: ['**/*.(t|j)s'],
   coverageDirectory: '../coverage',
   testEnvironment: 'node',

jest.config.js

@@ -0,0 +1,17 @@
+function randomChoice(choices: string) {
+  return choices[Math.floor(Math.random() * choices.length)];
+}
+
+function customAlphabet(alphabet: string, size: number) {
+  return () => {
+    let result = '';
+    for (let i = 0; i < size; i++) {
+      result += randomChoice(alphabet);
+    }
+    return result;
+  };
+}
+
+jest.mock('nanoid', () => ({
+  customAlphabet,
+}));

jest.setup.js

@@ -4,17 +4,16 @@
   "private": true,
   "scripts": {
     "build": "nest build",
-    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
     "start": "nest start",
     "start:dev": "nest start --watch",
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "test": "jest",
     "test:watch": "jest --watch",
-    "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config test/jest-e2e.json"
+    "test:e2e": "jest --config test/jest-e2e.json --runInBand"
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3.3.1",

jest.setup.ts

@@ -37,7 +37,7 @@ import { AttachmentsModule } from 'omniboxd/attachments/attachments.module';
 
 @Module({})
 export class AppModule implements NestModule {
-  static forRoot(extraMigrations: Function[]): DynamicModule {
+  static forRoot(extraMigrations: Array<() => void>): DynamicModule {
     return {
       module: AppModule,
       controllers: [AppController],
@@ -87,11 +87,7 @@ export class AppModule implements NestModule {
           inject: [ConfigService],
           useFactory: (config: ConfigService) => ({
             type: 'postgres',
-            host: config.get('OBB_DB_HOST', 'postgres'),
-            port: config.get('OBB_DB_PORT', 5432),
-            database: config.get('OBB_DB_DATABASE', 'omnibox'),
-            username: config.get('OBB_DB_USERNAME', 'omnibox'),
-            password: config.get('OBB_DB_PASSWORD', 'omnibox'),
+            url: config.get('OBB_POSTGRES_URL'),
             logging: config.get('OBB_DB_LOGGING') === 'true',
             synchronize: config.get('OBB_DB_SYNC') === 'true',
             autoLoadEntities: true,

package.json

@@ -0,0 +1,45 @@
+import { TestClient } from 'test/test-client';
+
+describe('UserController (e2e)', () => {
+  let client: TestClient;
+
+  beforeAll(async () => {
+    client = await TestClient.create();
+  });
+
+  afterAll(async () => {
+    await client.close();
+  });
+
+  it('should login with valid credentials', async () => {
+    const response = await client
+      .post('/api/v1/login')
+      .send({
+        email: client.user.email,
+        password: client.user.password,
+      })
+      .expect(200);
+
+    expect(response.body).toHaveProperty('id');
+    expect(response.body).toHaveProperty('access_token');
+  });
+
+  it('should access protected route with valid token', async () => {
+    return await client
+      .get(`/api/v1/user/${client.user.id}`)
+      .expect(200)
+      .expect((res) => {
+        expect(res.body.username).toBe(client.user.username);
+      });
+  });
+
+  it('should reject invalid token', async () => {
+    return await client
+      .get(`/api/v1/user/${client.user.id}`)
+      .set('Authorization', `Bearer fake-token`)
+      .expect(401)
+      .expect((res) => {
+        expect(res.body).toHaveProperty('message');
+      });
+  });
+});