Files
junhong_cmp_fiber/openspec/changes/unify-test-infrastructure/specs/test-infrastructure/spec.md
huang 23eb0307bb
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 5m30s
feat: 实现门店套餐分配功能并统一测试基础设施
新增功能:
- 门店套餐分配管理(shop_package_allocation):支持门店套餐库存管理
- 门店套餐系列分配管理(shop_series_allocation):支持套餐系列分配和佣金层级设置
- 我的套餐查询(my_package):支持门店查询自己的套餐分配情况

测试改进:
- 统一集成测试基础设施,新增 testutils.NewIntegrationTestEnv
- 重构所有集成测试使用新的测试环境设置
- 移除旧的测试辅助函数和冗余测试文件
- 新增 test_helpers_test.go 统一任务测试辅助

技术细节:
- 新增数据库迁移 000025_create_shop_allocation_tables
- 新增 3 个 Handler、Service、Store 和对应的单元测试
- 更新 OpenAPI 文档和文档生成器
- 测试覆盖率:Service 层 > 90%

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-28 10:45:16 +08:00

3.9 KiB
Raw Blame History

Test Infrastructure Specification

统一的测试基础设施规范,定义集成测试的标准化模式。

ADDED Requirements

Requirement: 集成测试环境结构体

系统 SHALL 提供 IntegrationTestEnv 结构体,封装集成测试所需的所有依赖。

结构体字段:

  • TX *gorm.DB - 自动回滚的数据库事务
  • Redis *redis.Client - 全局 Redis 连接
  • Logger *zap.Logger - 测试用日志记录器
  • TokenManager *auth.TokenManager - Token 管理器
  • App *fiber.App - 配置好的 Fiber 应用实例

Scenario: 创建集成测试环境

  • WHEN 测试调用 testutils.NewIntegrationTestEnv(t)
  • THEN 返回包含所有依赖的 IntegrationTestEnv 实例
  • AND 事务在测试结束后自动回滚
  • AND Redis 测试键在测试结束后自动清理

Scenario: 环境自动清理

  • WHEN 测试函数执行完毕(无论成功或失败)
  • THEN 数据库事务自动回滚
  • AND 测试相关的 Redis 键自动删除
  • AND 无需手动调用 teardown 函数

Requirement: Fiber App 标准配置

集成测试环境中的 Fiber App MUST 使用与生产环境一致的配置。

配置内容:

  • ErrorHandler: 使用 errors.SafeErrorHandler
  • 路由注册: 使用 routes.RegisterRoutes
  • 认证中间件: 模拟用户上下文

Scenario: ErrorHandler 配置正确

  • WHEN API 返回错误
  • THEN 响应格式与生产环境一致JSON 格式,包含 code、message、data

Scenario: 路由注册完整

  • WHEN 创建测试环境
  • THEN 所有 API 路由都已注册
  • AND 可以测试任意 API 端点

Requirement: 测试用户上下文

系统 SHALL 提供便捷的方式设置测试用户上下文。

Scenario: 创建超级管理员上下文

  • WHEN 测试需要超级管理员权限
  • THEN 可以通过 env.AsSuperAdmin() 获取带认证的请求
  • AND 请求自动包含有效的 Token

Scenario: 创建指定用户类型上下文

  • WHEN 测试需要特定用户类型(平台用户、代理、企业)
  • THEN 可以通过 env.AsUser(account) 设置用户上下文
  • AND 后续请求使用该用户的权限

Requirement: 禁止使用 testcontainers

集成测试 MUST NOT 使用 testcontainers 或其他 Docker 容器方式。

Scenario: 测试不依赖 Docker

  • WHEN 运行集成测试
  • THEN 不需要 Docker 环境
  • AND 测试可以在任何有数据库连接的环境中运行

Requirement: 禁止使用 DELETE 清理

集成测试 MUST NOT 使用 DELETE FROM ... WHERE ... 语句清理测试数据。

Scenario: 数据清理通过事务回滚

  • WHEN 测试创建数据
  • THEN 数据通过事务回滚自动清理
  • AND 不需要编写任何清理代码

Requirement: 测试数据唯一性

测试生成的数据用户名、手机号、商户代码等MUST 保证唯一性。

Scenario: 并行测试不冲突

  • WHEN 多个测试并行运行
  • THEN 每个测试生成的数据都是唯一的
  • AND 不会出现 "duplicate key" 错误

Scenario: 使用唯一标识生成器

  • WHEN 测试需要生成手机号
  • THEN 使用 testutils.GenerateUniquePhone()testutil.GenerateUniquePhone()
  • AND 生成的手机号在整个测试运行期间唯一

Requirement: 测试文件统一模式

所有集成测试文件 MUST 遵循统一的结构模式。

标准模式:

func TestXxx(t *testing.T) {
    env := testutils.NewIntegrationTestEnv(t)
    // 测试代码...
    // 无需 defer teardown
}

Scenario: 标准测试结构

  • WHEN 编写新的集成测试
  • THEN 使用 testutils.NewIntegrationTestEnv(t) 创建环境
  • AND 不需要手动清理或 defer 语句

Scenario: 子测试共享环境

  • WHEN 测试包含多个子测试 (t.Run)
  • THEN 在父测试中创建环境
  • AND 所有子测试共享同一个环境