如何配置GitLab Pipeline结合Jest与Prisma？测试实践咨询

一、GitLab 运行测试的必要性及最佳实践 #

为什么必须在 GitLab 运行测试，而非仅本地？ #

本地测试只能覆盖个人环境，但团队协作中存在诸多不可控因素：

• 不同开发人员的 Node 版本、依赖包版本、系统配置可能存在差异，你本地跑通的测试，他人环境或 CI 环境可能失败。
• 代码合并后容易出现冲突、逻辑矛盾，只有在 GitLab CI 中执行测试，才能在代码流入主分支前提前发现问题。
• 强制通过 CI 测试环节，能有效防止未经验证的代码上线，降低线上故障风险。

GitLab 运行 Jest 的最佳实践 #

• 标准化 CI 配置：
  示例 .gitlab-ci.yml 配置：

  stages:
    - install
    - test
  
  install_dependencies:
    stage: install
    image: node:20
    script:
      - npm install
    cache:
      paths:
        - node_modules/
  
  run_tests:
    stage: test
    image: node:20
    script:
      - npm run test -- --maxWorkers=2 # 并行测试提升效率
      - npm run test:coverage # 生成覆盖率报告（可选）
    cache:
      paths:
        - node_modules/
    artifacts:
      reports:
        junit: jest-junit.xml # 生成JUnit报告，GitLab可直接展示测试结果
    only:
      - main
      - merge_requests
  

• 严格隔离测试环境：使用单独的测试数据库（比如给数据库名加_test后缀），绝对禁止连接生产数据库执行测试。
• 并行测试优化：通过 Jest 的--maxWorkers参数或 GitLab CI 并行作业配置，缩短整体测试耗时。
• 分支保护机制：设置主分支仅允许测试通过的代码合并，强制守住代码质量关卡。
• 依赖缓存：缓存node_modules目录，避免每次 CI 都重复安装依赖，节省执行时间。

二、Prisma 测试数据清理：isTest 字段是否为最佳实践？ #

isTest 字段的优劣势 #

给表添加isTest字段确实能标记测试数据，清理时精准过滤，但它并非最佳方案：

• 劣势：需要给所有测试涉及的表新增字段，增加 Schema 复杂度；每次创建测试数据都要手动设置isTest: true，容易遗漏导致清理不彻底。
• 适用场景：仅当测试环境与生产环境无法完全隔离（不推荐此场景）时，用它可避免误删生产数据。

更优的替代方案 #

1. 事务回滚（首推）

每个测试用例在事务中执行，测试结束后回滚，数据不会残留，执行速度最快。
示例配置（在jest.setup.js中）：

import { PrismaClient } from '@prisma/client';

let prisma;

beforeEach(async () => {
  prisma = new PrismaClient();
  // 开启事务
  await prisma.$executeRaw`BEGIN`;
});

afterEach(async () => {
  // 回滚事务
  await prisma.$executeRaw`ROLLBACK`;
  await prisma.$disconnect();
});

// 测试用例中直接使用prisma即可，所有操作都会被回滚

也可使用jest-prisma-plugin简化配置，它会自动处理事务的开启与回滚。

2. 单独测试数据库 + 全表清空

使用专门的测试数据库，测试前清空所有表数据，无需修改 Schema：

beforeEach(async () => {
  const prisma = new PrismaClient();
  // 获取所有模型名称
  const modelNames = Object.keys(prisma).filter(key => !key.startsWith('$'));
  // 逐个清空表
  for (const model of modelNames) {
    await prisma[model].deleteMany({});
  }
  await prisma.$disconnect();
});

⚠️ 务必确保连接的是测试数据库，否则会清空生产数据！

3. 数据库重置

每次测试前重建整个数据库，适合需要绝对干净初始状态的场景：

beforeEach(async () => {
  const prisma = new PrismaClient();
  // 重置数据库Schema
  await prisma.$executeRaw`DROP SCHEMA public CASCADE; CREATE SCHEMA public;`;
  // 重新运行迁移
  await prisma.migrate.deploy();
  await prisma.$disconnect();
});

缺点是执行速度较慢，适合测试用例较少的项目。

针对你当前代码的优化建议 #

你当前beforeEach中的deleteMany没有where条件，若连接的是测试数据库没问题，但风险极高（误连生产库会清空所有数据）。建议：

• 优先改用事务回滚方案，无需修改现有测试代码，安全且高效。
• 若坚持用清空表的方式，必须确保连接测试数据库，或给测试数据添加唯一标识（比如固定slug前缀），清理时精准匹配。

内容的提问来源于stack exchange，提问作者onlyinc