ci: 优化后端测试流程，通过 Docker Compose 管理测试数据库并使部分环境变量可选。

Author: OSpoon

.github/workflows/ci.yml

@@ -36,22 +36,6 @@ jobs:
   backend-test:
     name: Backend Tests
     runs-on: ubuntu-latest
-    services:
-      postgres:
-        image: postgres:alpine
-        env:
-          POSTGRES_DB: nexquery_test
-          POSTGRES_USER: adonis
-          POSTGRES_PASSWORD: password
-        ports:
-          - 5432:5432
-        # Set health checks to wait until postgres has started
-        options: >-
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-
     steps:
       - uses: actions/checkout@v4
 
@@ -69,11 +53,14 @@ jobs:
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
+      - name: Start Test Database
+        run: docker compose -f docker-compose.test.yml up -d --wait
+
       - name: Run Backend Tests
         run: pnpm backend:test
         env:
           DB_HOST: localhost
-          DB_PORT: 5432
+          DB_PORT: 5433
           DB_USER: adonis
           DB_PASSWORD: password
           DB_DATABASE: nexquery_test

backend/start/env.ts

@@ -14,10 +14,10 @@ import { Env } from '@adonisjs/core/env'
 // eslint-disable-next-line antfu/no-top-level-await
 export default await Env.create(new URL('../', import.meta.url), {
   NODE_ENV: Env.schema.enum(['development', 'production', 'test'] as const),
-  PORT: Env.schema.number(),
+  PORT: Env.schema.number.optional(),
   APP_KEY: Env.schema.string(),
-  HOST: Env.schema.string({ format: 'host' }),
-  LOG_LEVEL: Env.schema.enum(['fatal', 'error', 'warn', 'info', 'debug', 'trace', 'silent']),
+  HOST: Env.schema.string.optional({ format: 'host' }),
+  LOG_LEVEL: Env.schema.enum.optional(['fatal', 'error', 'warn', 'info', 'debug', 'trace', 'silent']),
 
   /*
   |----------------------------------------------------------
@@ -35,12 +35,12 @@ export default await Env.create(new URL('../', import.meta.url), {
   | Variables for configuring mail connection
   |----------------------------------------------------------
   */
-  SMTP_HOST: Env.schema.string(),
-  SMTP_PORT: Env.schema.number(),
+  SMTP_HOST: Env.schema.string.optional(),
+  SMTP_PORT: Env.schema.number.optional(),
   SMTP_USERNAME: Env.schema.string.optional(),
   SMTP_PASSWORD: Env.schema.string.optional(),
 
-  FRONTEND_URL: Env.schema.string(),
+  FRONTEND_URL: Env.schema.string.optional(),
 
   /*
   |----------------------------------------------------------
@@ -65,8 +65,8 @@ export default await Env.create(new URL('../', import.meta.url), {
   | Variables for Vector Database (Qdrant)
   |----------------------------------------------------------
   */
-  QDRANT_HOST: Env.schema.string({ format: 'host' }),
-  QDRANT_PORT: Env.schema.number(),
+  QDRANT_HOST: Env.schema.string.optional({ format: 'host' }),
+  QDRANT_PORT: Env.schema.number.optional(),
   QDRANT_API_KEY: Env.schema.string.optional(),
 
   /*
@@ -92,9 +92,9 @@ export default await Env.create(new URL('../', import.meta.url), {
   | Variables for configuring the limiter package
   |----------------------------------------------------------
   */
-  LIMITER_STORE: Env.schema.enum(['database', 'memory'] as const),
+  LIMITER_STORE: Env.schema.enum.optional(['database', 'memory'] as const),
 
-  REDIS_HOST: Env.schema.string({ format: 'host' }),
-  REDIS_PORT: Env.schema.number(),
+  REDIS_HOST: Env.schema.string.optional({ format: 'host' }),
+  REDIS_PORT: Env.schema.number.optional(),
   REDIS_PASSWORD: Env.schema.string.optional(),
 })

docker-compose.test.yml

@@ -1,3 +1,5 @@
+name: nexquery-ai-test
+
 services:
   postgres:
     image: postgres:alpine
@@ -6,4 +8,9 @@ services:
       POSTGRES_USER: adonis
       POSTGRES_PASSWORD: password
     ports:
-      - '5433:5432'
+      - "5433:5432"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U adonis -d nexquery_test"]
+      interval: 5s
+      timeout: 5s
+      retries: 5

package.json

@@ -18,6 +18,7 @@
     "backend:dev": "pnpm --filter backend dev",
     "backend:build": "pnpm --filter backend build",
     "backend:test": "pnpm --filter backend test",
+    "backend:test:docker": "docker compose -f docker-compose.test.yml up -d --wait && DB_PORT=5433 DB_HOST=127.0.0.1 DB_USER=adonis DB_PASSWORD=password DB_DATABASE=nexquery_test pnpm backend:test && docker compose -f docker-compose.test.yml down -v",
     "backend:migrate": "pnpm --filter backend exec node ace migration:run",
     "backend:seed": "pnpm --filter backend exec node ace db:seed",
     "backend:fresh": "pnpm --filter backend exec node ace migration:fresh --seed",