# 后端测试 ## 什么时候使用这个技能触发该技能的具体情况： * **新功能开发** ：首先使用 TDD（测试驱动开发）编写测试 * **添加 API 端点**：测试 REST API 的成功和失败案例 * **错误修复**：添加测试以防止回归 * **重构之前**：编写保证现有行为的测试 * **CI/CD 设置** ：构建自动化测试管道 ## 输入格式从用户处收集的格式和必需/可选信息： ### 必填信息 * **框架** ：Express、Django、FastAPI、Spring Boot 等。 * **测试工具** ：Jest、Pytest、Mocha/Chai、JUnit 等。 * **测试目标** ：API端点、业务逻辑、数据库操作等。 ### 可选信息 * **数据库** ：PostgreSQL、MySQL、MongoDB（默认：内存数据库） * **模拟库**：jest.mock、sinon、unittest.mock（默认：框架内置） * **覆盖目标**：80%、90% 等（默认值：80%） * **E2E工具**：Supertest、TestClient、RestAssured（可选） ### 输入示例测试 Express.js API 的用户身份验证端点： - 框架：Express + TypeScript - 测试工具：Jest + Supertest - 目标：POST /auth/register、POST /auth/login - DB：PostgreSQL（内存中用于测试） - 覆盖率：90%或以上 ## 说明精确遵循分步任务顺序。 ### 第1步：设置测试环境安装并配置测试框架和工具。 **任务**： * 安装测试库 * 配置测试数据库（内存中或单独的数据库） * 单独的环境变量（.env.test） * 配置jest.config.js或pytest.ini **示例**（Node.js + Jest + Supertest）： npm install --save-dev jest ts-jest @types/jest supertest @types/supertest **jest.config.js**：模块. 导出 = { 预设：'ts-jest'，测试环境：'节点'，根：['/src']， testMatch: ['**/__tests__/**/*.test.ts'], 收集覆盖范围：[ 'src/**/*.ts', '!src/**/*.d.ts', '!src/__tests__/**' ], 覆盖阈值：{ 全局：{ 分支机构：80个，功能：80，线路：80，声明：80 } }, setupFilesAfterEnv: ['/src/__tests__/setup.ts'] }; **setup.ts**（全局测试配置）：从 '../database' 导入 { db }; // 每次测试前重置数据库 beforeEach(异步() => { 等待 db.migrate.latest(); 等待 db.seed.run(); }); // 每次测试后清理 afterEach(异步() => { 等待 db.migrate.rollback(); }); // 所有测试完成后关闭连接毕竟（异步（）=> { 等待 db.destroy(); }); ### 第 2 步：编写单元测试（业务逻辑）为各个函数和类编写单元测试。 **任务**： * 测试纯函数（无依赖） * 通过模拟隔离依赖关系 * 测试边缘情况（边界值、异常） * AAA 模式（安排-执行-断言） **决策标准**： * 无外部依赖（DB、API）->纯单元测试 * 存在外部依赖项 -> 使用 Mock/Stub * 复杂逻辑 -> 测试各种输入情况 **示例**（密码验证功能）： // src/utils/password.ts 导出函数 validatePassword(密码: string): { valid: boolean;错误：字符串[] } { 常量错误：字符串[] = []； if (密码.length < 8) { error.push('密码必须至少8个字符'); } if (!/[A-Z]/.test(密码)) { error.push('密码必须包含大写字母'); } if (!/[a-z]/.test(密码)) { error.push('密码必须包含小写字母'); } if (!/\d/.test(密码)) { error.push('密码必须包含数字'); } if (!/[!@#$%^&*]/.test(密码)) { error.push('密码必须包含特殊字符'); } 返回 { 有效：errors.length === 0, 错误 }; } // src/__tests__/utils/password.test.ts 从 '../../utils/password' 导入 { validatePassword } ；描述（'验证密码'，（）=> { it('应该接受有效的密码', () => { const 结果 = validatePassword('密码123!'); 期望(结果.有效).toBe(真); 期望(结果.错误).toHaveLength(0); }); it('应拒绝短于 8 个字符的密码', () => { const 结果 = validatePassword('Pass1!'); 期望(结果.有效).toBe(假); Expect(result.errors).toContain('密码必须至少为 8 个字符'); }); it('应该拒绝不带大写的密码', () => { const 结果 = validatePassword('密码123!'); 期望(结果.有效).toBe(假); Expect(result.errors).toContain('密码必须包含大写字母'); }); it('应该拒绝不带小写的密码', () => { const 结果 = validatePassword('PASSWORD123!'); 期望(结果.有效).toBe(假); Expect(result.errors).toContain('密码必须包含小写字母'); }); it('应该拒绝没有数字的密码', () => { const 结果 = validatePassword('密码！'); 期望(结果.有效).toBe(假); Expect(result.errors).toContain('密码必须包含数字'); }); it('应该拒绝没有特殊字符的密码', () => { const 结果 = validatePassword('密码123'); 期望(结果.有效).toBe(假); Expect(result.errors).toContain('密码必须包含特殊字符'); }); it('应返回无效密码的多个错误', () => { const 结果 = validatePassword('pass'); 期望(结果.有效).toBe(假); 期望（结果.errors.length）.toBeGreaterThan（1）; }); }); ### 步骤 3：集成测试（API 端点）为 API 端点编写集成测试。 **任务**： * 测试HTTP请求/响应 * 成功案例 (200, 201) * 失败案例（400、401、404、500） * 认证/授权测试 * 输入验证测试 **清单**： * 验证状态码 * 验证响应体结构 * 确认数据库状态变化 * 验证错误信息 **示例**（Express.js + Supertest）： // src/__tests__/api/auth.test.ts 从“超级测试”导入请求；从“../../app”导入应用程序；从 '../../database' 导入 { db }; 描述('POST /auth/register', () => { it('应该成功注册新用户', async () => { const 响应 = 等待请求（应用程序） .post('/api/auth/register') .发送({ 电子邮件：'test@example.com'，用户名：'测试用户'，密码：'密码123！' }); 期望(响应.状态).toBe(201); 期望(response.body).toHaveProperty('用户'); 期望(response.body).toHaveProperty('accessToken'); 期望(response.body.user.email).toBe('test@example.com'); // 验证记录是否确实保存到数据库中 const user = wait db.user.findUnique({ 其中：{ email: 'test@example.com' } }); 期望（用户）。toBeTruthy（）； Expect(user.username).toBe('testuser'); }); it('应该拒绝重复的电子邮件', async () => { // 创建第一个用户等待请求（应用程序） .post('/api/auth/register') .发送({ 电子邮件：'test@example.com'，用户名：'user1', 密码：'密码123！' }); // 使用同一电子邮件进行第二次尝试 const 响应 = 等待请求（应用程序） .post('/api/auth/register') .发送({ 电子邮件：'test@example.com'，用户名：'user2', 密码：'密码123！' }); 期望（响应。状态）。toBe（409）; Expect(response.body.error).toContain('已经存在'); }); it('应该拒绝弱密码', async () => { const 响应 = 等待请求（应用程序） .post('/api/auth/register') .发送({ 电子邮件：'test@example.com'，用户名：'测试用户'，密码：'弱' }); 期望(响应.状态).toBe(400); 期望(response.body.error).toBeDefined(); }); it('应该拒绝缺失字段', async () => { const 响应 = 等待请求（应用程序） .post('/api/auth/register') .发送({ 电子邮件：'test@example.com' // 用户名、密码省略 }); 期望(响应.状态).toBe(400); }); }); 描述('POST /auth/login', () => { beforeEach(异步() => { // 创建测试用户等待请求（应用程序） .post('/api/auth/register') .发送({ 电子邮件：'test@example.com'，用户名：'测试用户'，密码：'密码123！' }); }); it('应该使用有效凭据登录', async () => { const 响应 = 等待请求（应用程序） .post('/api/auth/login') .发送({ 电子邮件：'test@example.com'，密码：'密码123！' }); 期望(响应.状态).toBe(200); 期望(response.body).toHaveProperty('accessToken'); 期望(response.body).toHaveProperty('refreshToken'); 期望(response.body.user.email).toBe('test@example.com'); }); it('应该拒绝无效密码', async () => { const 响应 = 等待请求（应用程序） .post('/api/auth/login') .发送({ 电子邮件：'test@example.com'，密码：'密码错误123！' }); 期望(响应.状态).toBe(401); Expect(response.body.error).toContain('无效凭据'); }); it('应该拒绝不存在的用户', async () => { const 响应 = 等待请求（应用程序） .post('/api/auth/login') .发送({ 电子邮件：'nonexistent@example.com', 密码：'密码123！' }); 期望(响应.状态).toBe(401); }); }); ### 步骤 4：身份验证/授权测试测试 JWT 令牌和基于角色的访问控制。 **任务**： * 无token访问时确认401 * 使用有效令牌确认访问成功 * 测试过期令牌处理 * 基于角色的权限测试 **示例**：描述('受保护的路线', () => { 让 accessToken: 字符串; 让 adminToken: 字符串; beforeEach(异步() => { // 普通用户令牌 const userResponse = 等待请求（应用程序） .post('/api/auth/register') .发送({ 电子邮件：'user@example.com'，用户名：'用户'，密码：'密码123！' }); accessToken = userResponse.body.accessToken; // 管理令牌 const adminResponse = 等待请求（应用程序） .post('/api/auth/register') .发送({ 电子邮件：'admin@example.com', 用户名：'管理员'，密码：'密码123！' }); // 将数据库中的角色更新为“admin” 等待 db.user.update({ 其中：{电子邮件：'admin@example.com'}，数据：{角色：'管理员'} }); // 再次登录获取新的token const loginResponse = 等待请求（应用程序） .post('/api/auth/login') .发送({ 电子邮件：'admin@example.com', 密码：'密码123！' }); adminToken = loginResponse.body.accessToken; }); 描述('GET /api/auth/me', () => { it('应该返回带有有效令牌的当前用户', async () => { const 响应 = 等待请求（应用程序） .get('/api/auth/me') .set('授权', `承载${accessToken}`); 期望(响应.状态).toBe(200); 期望(response.body.user.email).toBe('user@example.com'); }); it('应该拒绝没有令牌的请求', async () => { const 响应 = 等待请求（应用程序） .get('/api/auth/me'); 期望(响应.状态).toBe(401); }); it('应该拒绝带有无效令牌的请求', async () => { const 响应 = 等待请求（应用程序） .get('/api/auth/me') .set('授权', '持有无效令牌'); 期望（响应。状态）。toBe（403）; }); }); 描述（'删除/ api / users /：id（仅限管理员）'，（）=> { it('应该允许管理员删除用户', async () => { const targetUser = wait db.user.findUnique({ 其中：{ email: 'user@example.com' } }); const 响应 = 等待请求（应用程序） .delete(`/api/users/${targetUser.id}`) .set('授权', `承载${adminToken}`); 期望(响应.状态).toBe(200); }); it('应禁止非管理员删除用户', async () => { const targetUser = wait db.user.findUnique({ 其中：{ email: 'user@example.com' } }); const 响应 = 等待请求（应用程序） .delete(`/api/users/${targetUser.id}`) .set('授权', `承载${accessToken}`); 期望（响应。状态）。toBe（403）; }); }); }); ### 步骤 5：模拟和测试隔离模拟外部依赖关系以隔离测试。 **任务**： * 模拟外部API * 模拟邮件发送 * 模拟文件系统 * 模拟时间相关函数 **示例**（模拟外部 API）： // src/services/emailService.ts 导出异步函数 sendVerificationEmail(email: string, token: string): Promise { const 响应 = 等待 fetch('https://api.sendgrid.com/v3/mail/send', { 方法：'POST'， headers: { '授权': `承载 ${process.env.SENDGRID_API_KEY}` }, 正文：JSON.stringify({ 至：电子邮件，主题：“验证您的电子邮件”， html: `验证` }) }); 如果（！response.ok）{ throw new Error('发送邮件失败'); } } // src/__tests__/services/emailService.test.ts 从'../../services/emailService'导入{sendVerificationEmail}； // 模拟获取 global.fetch = jest.fn(); 描述（'发送验证电子邮件'，（）=> { 之前（（）=> { （获取为 jest.Mock）.mockClear(); }); it('应该成功发送电子邮件', async () => { （作为 jest.Mock 获取）.mockResolvedValueOnce({ 好的：是的，状态：200 }); 等待期望（sendVerificationEmail（'test@example.com'，'token123'）） .resolves .toBeUndefine(); 期望（获取）.toHaveBeenCalledWith（ 'https://api.sendgrid.com/v3/mail/send', 期望.objectContaining({ 方法：“发布” }) ）； }); it('如果电子邮件发送失败应该抛出错误', async () => { （作为 jest.Mock 获取）.mockResolvedValueOnce({ 好的：假的，状态：500 }); 等待期望（sendVerificationEmail（'test@example.com'，'token123'）） .拒绝 .toThrow('发送邮件失败'); }); }); ## 输出格式定义输出必须遵循的确切格式。 ### 基本结构项目/ ├── src/ │ ├── __测试__/ │ │ ├── setup.ts # 全局测试配置 │ │ ├── 实用程序/ │ │ │ └──password.test.ts # 单元测试 │ │ ├── 服务/ │ │ │ └── emailService.test.ts │ │ └── API/ │ │ ├── auth.test.ts # 集成测试 │ │ └── users.test.ts │ └── ... ├── jest.config.js └── package.json ### 测试运行脚本（package.json） { “脚本”：{ “测试”：“开玩笑”， “测试：手表”：“玩笑--手表”， “测试：覆盖率”：“开玩笑——覆盖率”， “测试：ci”：“开玩笑--ci--覆盖率--maxWorkers = 2” } } ### 覆盖率报告 $ npm 运行测试：覆盖率 --------------------------|---------|----------|---------|---------| 文件| % 语句 | % 分支 | % 函数 | % 行 | --------------------------|---------|----------|---------|---------| 所有文件 | 92.5 | 92.5 88.3 | 88.3 95.2 | 95.2 92.8 | 92.8 授权/ | 95.0 | 95.0 90.0 | 90.0 100.0 | 100.0 95.0 | 95.0 中间件.ts | 95.0 | 95.0 90.0 | 90.0 100.0 | 100.0 95.0 | 95.0 路线.ts | 95.0 | 95.0 90.0 | 90.0 100.0 | 100.0 95.0 | 95.0 实用程序/ | 90.0 | 90.0 85.0 | 85.0 90.0 | 90.0 90.0 | 90.0 密码.ts | 90.0 | 90.0 85.0 | 85.0 90.0 | 90.0 90.0 | 90.0 --------------------------|---------|----------|---------|---------| ## 约束条件必须严格遵守的规则和禁令。 ### 必需的规则（必须） 1. **测试隔离**：每个测试必须可以独立运行 * 使用 beforeEach/afterEach 重置状态 * 不依赖于测试执行顺序 2. **明确的测试名称**：名称必须传达测试验证的内容 * ✅“应该拒绝重复的电子邮件” * ❌“测试1” 3. **AAA模式**：安排（设置）-行动（执行）-断言（验证）结构 * 提高可读性 * 明确测试意图 ### 禁止（不得） 1. **无生产数据库**：测试必须使用单独的数据库或内存数据库 * 丢失真实数据的风险 * 无法隔离测试 2. **没有真正的外部API调用** ：模拟所有外部服务 * 消除网络依赖 * 加快测试速度 * 降低成本 3. **禁止睡眠/超时滥用**：使用假定时器进行基于时间的测试 * jest.useFakeTimers() * 防止测试速度减慢 ### 安全规则 * **无硬编码秘密**：切勿在测试代码中硬编码 API 密钥或密码 * **单独的环境变量** ：使用 .env.test 文件 ## 示例 ### 示例 1：Python FastAPI 测试 (Pytest) **情况**：测试 FastAPI REST API **用户请求**：使用 pytest 测试使用 FastAPI 构建的用户 API。 **最终结果**： # 测试/conftest.py 导入pytest 从 fastapi.testclient 导入 TestClient 从 sqlalchemy 导入 create_engine 从 sqlalchemy.orm 导入 sessionmaker 从 app.main 导入应用程序从 app.database 导入 Base，get_db # 用于测试的内存 SQLite SQLALCHEMY_DATABASE_URL = "sqlite:///./test.db" 引擎 = create_engine(SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False}) TestSessionLocal = sessionmaker（自动提交=假，自动刷新=假，绑定=引擎） @pytest.fixture(范围=“函数”) def db_session(): Base.metadata.create_all(bind=engine) db = 测试会话本地() 尝试：产量数据库最后： db.close() Base.metadata.drop_all(bind=engine) @pytest.fixture(范围=“函数”) def 客户端（db_session）： def override_get_db(): 尝试：产生 db_session 最后： db_session.close() app.dependency_overrides[get_db] = override_get_db 产量测试客户端（应用程序） app.dependency_overrides.clear() # 测试/test_auth.py def test_register_user_success(客户端): 响应 = client.post("/auth/register", json={ “电子邮件”：“test@example.com”， “用户名”：“测试用户”， "password": "密码123！" }) 断言response.status_code == 201 在response.json()中断言“access_token” 断言response.json()["用户"]["电子邮件"] == "test@example.com" def test_register_duplicate_email（客户端）： # 第一个用户 client.post("/auth/register", json={ “电子邮件”：“test@example.com”， “用户名”：“用户1”， "password": "密码123！" }) # 重复的电子邮件响应 = client.post("/auth/register", json={ “电子邮件”：“test@example.com”， “用户名”：“用户2”， "password": "密码123！" }) 断言response.status_code == 409 在response.json()[“detail”]中断言“已经存在” def test_login_success(客户端): # 注册 client.post("/auth/register", json={ “电子邮件”：“test@example.com”， “用户名”：“测试用户”， "password": "密码123！" }) # 登录响应 = client.post("/auth/login", json={ “电子邮件”：“test@example.com”， "password": "密码123！" }) 断言response.status_code == 200 在response.json()中断言“access_token” def test_protected_route_without_token(客户端): 响应 = client.get("/auth/me") 断言response.status_code == 401 def test_protected_route_with_token(客户端): # 注册并获取token register_response = client.post("/auth/register", json={ “电子邮件”：“test@example.com”， “用户名”：“测试用户”， "password": "密码123！" }) 令牌 = register_response.json()["access_token"] # 访问受保护的路由响应 = client.get("/auth/me", headers={ “授权”：f“承载{令牌}” }) 断言response.status_code == 200 断言 response.json()["email"] == "test@example.com" ## 最佳实践 ### 质量改进 1. **TDD（测试驱动开发）**：在编写代码之前先编写测试 * 明确要求 * 改进设计 * 自然实现高覆盖率 2. **Given-When-Then 模式**：以 BDD 风格编写测试 it('当找不到用户时应该返回404', async () => { // 给定：一个不存在的用户 ID const nonExistentId = '不存在的 uuid'; // 何时：尝试查找该用户 const response = wait request(app).get(`/user/${nonExistentId}`); // 然后：404响应期望（响应。状态）。toBe（404）; }); 3. **测试夹具**：可重复使用的测试数据常量有效用户 = { 电子邮件：'test@example.com'，用户名：'测试用户'，密码：'密码123！' }; ### 效率提升 * **并行执行** ：使用 Jest 的 `--maxWorkers` 选项加速测试 * **快照测试** ：保存 UI 组件或 JSON 响应的快照 * **覆盖率阈值** ：在 jest.config.js 中强制执行最小覆盖率 ## 常见问题 ### 问题 1：测试之间共享状态导致测试失败 **症状**：单独通过但一起运行时失败 **原因**：由于缺少 beforeEach/afterEach 而共享数据库状态 **修复**： beforeEach(异步() => { 等待 db.migrate.rollback(); 等待 db.migrate.latest(); }); ###问题2：“Jest在测试运行后一秒没有退出” **症状**：测试完成后进程不退出 **原因**：数据库连接、服务器等未清理 **修复**：毕竟（异步（）=> { 等待 db.destroy(); 等待服务器.close(); }); ### 问题 3：异步测试超时 **症状**：“超时 - 未调用异步回调” **原因**：缺少 async/await 或未处理的 Promise **修复**： // 不好它（'应该工作'，（）=> { 请求(应用程序).get('/用户'); // 承诺未处理 }); // 好 it('应该工作', async () => { 等待请求(app).get('/users'); }); ## 参考文献 ### 官方文档 * [Jest 文档]() * [Pytest文档]() * [Supertest GitHub]() ###学习资源 * [与 Kent C. Dodds 一起测试 JavaScript]() * [测试驱动开发示例 (Kent Beck)]() ### 工具 * [Istanbul/nyc]() \- 代码覆盖率 * [nock]() \- HTTP 模拟 * [faker.js]() \- 测试数据生成 ## 元数据 ### 版本 * **当前版本**：1.0.0 * **最后更新** : 2025-01-01 * **兼容平台**：Claude、ChatGPT、Gemini ###相关技能 * [api-design]()：设计 API 和测试 * [authentication-setup](): 测试身份验证系统 ### 标签 `#testing` `#backend` `#Jest` `#Pytest` `#unit-test` `#integration-test` `#TDD` `#API-test`

后端测试

包含技能