Ana Sayfa Keşfet Yardım
Üye Ol Giriş Yap
178-template-164
/
mini-starter
şundan çatallanmış 155-template-138/mini-starter
2
0
Çatalla 0
Dosyalar
Ağaç: 20668bd27c
Dallar Biçim İmleri
mini-starter
/
docs
/
stories
/
004.001.story.md

004.001.story.md 6.1 KB
Geçmiş Ham

Story 004.001: 实际请求测试基础设施

父史诗: 史诗004 - API实际请求测试基础设施 docs/prd/epic-004-api-actual-request-testing.md

Status

Ready for Review

Story

As a 质量保证工程师 I want 建立实际HTTP请求测试的基础设施 so that 我可以在真实数据库环境下验证API端点的行为，确保系统功能的正确性

Acceptance Criteria

  1. 配置测试数据库环境 - 建立独立的测试数据库实例，连接成功率100%
  2. 创建测试数据准备和清理工具 - 实现自动化的测试数据种子和清理机制
  3. 实现测试专用的数据库连接 - 测试环境启动时间<5秒，连接稳定性100%
  4. 用户API实际请求测试实现 - 核心用户管理端点测试覆盖率100%
  5. CI/CD流水线集成 - 测试结果自动报告上传，失败时发送通知

Tasks / Subtasks

  • 配置测试数据库环境 (AC: #1)
    • 设置独立的测试数据库实例配置
    • 配置数据库连接参数和环境变量
    • 验证数据库连接成功率和稳定性
  • 创建测试数据准备和清理工具 (AC: #2)
    • 实现测试数据种子函数
    • 创建自动化数据清理机制
    • 开发测试数据工厂函数
  • 实现测试专用的数据库连接 (AC: #3)
    • 优化测试环境启动流程
    • 实现连接池管理和性能优化
    • 建立测试服务器启动和关闭流程
  • 创建核心测试工具和工具函数 (AC: #2, #4)
    • 实现认证用户创建工具
    • 开发API请求包装器
    • 创建测试断言工具函数
  • 实现用户API的实际请求测试 (AC: #4)
    • 用户创建和读取测试
    • 用户更新和删除测试
    • 用户搜索和过滤测试
  • 集成到CI/CD流水线 (AC: #5)
    • 配置GitHub Actions测试工作流
    • 设置测试报告生成和上传
    • 配置测试失败通知机制

Dev Notes

技术栈和测试框架 [Source: architecture/tech-stack.md#测试框架]

  • 测试框架: Vitest 2.x + Supertest 6.x
  • 测试位置: src/server/api/__integration_tests__/ 目录
  • 数据库: 使用真实PostgreSQL数据库连接进行测试
  • 覆盖率目标: 核心API端点测试覆盖率100%

项目结构指导 [Source: architecture/source-tree.md#API测试]

  • 遵循架构设计: API测试文件应位于对应API端点的 __tests__ 文件夹中
  • 目录结构: 真实集成测试放到 src/server/api/users/__tests__/
  • 测试分离: Mock集成测试保留在 src/server/api/__integration_tests__/
  • 测试工具函数位于 src/server/__test_utils__/

现有测试基础设施 [Source: 现有代码分析]

  • 已有测试工具: src/server/__test_utils__/api-client.ts
  • 已有测试工具: src/server/__test_utils__/test-db.ts
  • 已有Mock集成测试示例: src/server/api/__integration_tests__/users.integration.test.ts (当前使用mock数据)
  • 需要创建新的实际集成测试文件: src/server/api/users/__tests__/users.integration.test.ts
  • 使用真实数据库连接而不是mock，遵循架构文档结构

测试标准要求 [Source: architecture/coding-standards.md#测试标准]

  • 测试文件命名: *.integration.test.ts
  • 测试组织: 使用describe/it块结构
  • 断言风格: Expect语法
  • 测试数据: 使用工厂函数创建测试数据

API端点信息 [Source: api-design-integration.md]

  • 认证: JWT Bearer Token认证机制
  • 版本控制: /api/v1/ 前缀
  • 用户管理端点:
    • GET /api/v1/users - 获取用户列表
    • POST /api/v1/users - 创建用户
    • GET /api/v1/users/:id - 获取用户详情
    • PUT /api/v1/users/:id - 更新用户
    • DELETE /api/v1/users/:id - 删除用户

安全考虑 [Source: architecture/security-integration.md]

  • 测试环境使用独立的测试数据库，与生产环境完全隔离
  • 测试数据库访问权限严格控制，仅限测试用户访问
  • 测试数据不包含真实用户信息，使用生成的测试数据
  • 敏感测试数据（如认证token）进行加密处理
  • 测试完成后自动清理所有测试数据，确保无残留
  • 测试环境网络隔离，防止对生产环境的意外访问

Testing

测试策略

  • 测试类型: 集成测试（实际HTTP请求 + 真实数据库）
  • 测试范围: 所有核心用户管理API端点
  • 测试数据: 使用工厂模式创建测试用户和数据
  • 清理机制: 每个测试用例后清理测试数据

测试验证点

  • HTTP状态码验证
  • 响应数据结构验证
  • 数据库状态验证
  • 错误处理验证
  • 性能基准验证（响应时间 < 200ms）

测试报告

  • Vitest测试报告生成
  • 覆盖率报告集成
  • CI/CD流水线测试结果展示

Change Log

Date Version Description Author
2025-09-17 1.0 初始故事创建 Bob (SM)

Dev Agent Record

Agent Model Used

  • Developer Agent (James)

Debug Log References

  • 创建了集成测试数据库工具: src/server/__test_utils__/integration-test-db.ts
  • 创建了集成测试工具函数: src/server/__test_utils__/integration-test-utils.ts
  • 实现了用户API集成测试: src/server/api/users/__tests__/users.integration.test.ts
  • 配置了CI/CD工作流: .github/workflows/integration-tests.yml
  • 更新了测试脚本: package.json

Completion Notes List

  1. ✅ 配置了真实的PostgreSQL测试数据库环境
  2. ✅ 创建了测试数据工厂和清理工具
  3. ✅ 实现了测试专用的数据库连接管理
  4. ✅ 开发了完整的集成测试工具函数集
  5. ✅ 实现了用户API所有端点的实际请求测试
  6. ✅ 集成了GitHub Actions CI/CD流水线
  7. ✅ 支持测试报告生成和覆盖率统计
  8. ✅ 配置了测试失败通知机制

File List

  • src/server/__test_utils__/integration-test-db.ts - 集成测试数据库工具
  • src/server/__test_utils__/integration-test-utils.ts - 集成测试工具函数
  • src/server/api/users/__tests__/users.integration.test.ts - 用户API集成测试
  • .github/workflows/integration-tests.yml - CI/CD集成测试工作流
  • package.json - 更新了测试脚本配置

QA Results