- 16 个业务模块,856 个测试用例,40 个 E2E 测试 - 单一 React 19 前端 + PlatformSwitcher 二合一切换 - Flask 后端支持 scenario/dcloud_module/dcloud_e2e/dcloud_all 四种任务类型 - E2E 测试面板:API 全链路(8条) + UI 点击(3条) + 分步测试(3个) - SSE 实时日志流 + 飞书告警 + 定时调度 - 完整还原原 ToB 平台 TestPanel E2E 模块
2.7 KiB
2.7 KiB
测试代码编写规范
文档联动关系
本文档是测试代码编写规范入口。详细示例保留在 ../docs/TEST_WRITING_GUIDE.md,本规范定义命名、结构、断言和 fixture 的最低要求。
| 文档或目录 | 关系 | 使用场景 |
|---|---|---|
../README.md |
主索引 | 判断是否需要读取本文档 |
AUTOMATION-SPEC.md |
工程总规范 | 了解目录、运行和报告 |
PAGE-OBJECT-SPEC.md |
Page Object 规范 | 编写 UI 测试时读取 |
API-TEST-SPEC.md |
API 测试规范 | 编写接口测试时读取 |
TEST-CASES-SPEC.md |
用例文档规范 | 同步测试用例文档 |
../docs/TEST_WRITING_GUIDE.md |
详细指南 | 查看完整代码示例 |
1. 基本原则
测试应符合 FIRST 和 AAA:
- Fast:执行尽量快速。
- Independent:测试之间独立。
- Repeatable:可重复运行。
- Self-validating:自动判断通过或失败。
- Timely:功能或缺陷变化时及时更新。
AAA 结构:
Arrange -> Act -> Assert
2. 命名规范
| 对象 | 规则 | 示例 |
|---|---|---|
| 文件 | test_<module>_<type>.py |
test_data_space_api.py |
| 类 | Test<Feature> |
TestSpaceCreation |
| 方法 | test_<action>_<expected_result> |
test_create_space_with_valid_data_succeeds |
| marker | 类型 marker + 模块 marker | @pytest.mark.api, @pytest.mark.data_space |
3. 测试结构
每个测试应尽量包含:
- 清晰 docstring,说明测试目的或 Given/When/Then。
- 明确的前置条件。
- 通过页面对象或 API helper 执行业务动作。
- 可验证的断言。
- 需要创建资源时配套清理。
4. 断言要求
| 测试类型 | 最低断言 |
|---|---|
| UI 测试 | URL、关键元素可见性、状态变化或业务结果 |
| API 测试 | HTTP 状态码、业务状态码、关键字段 |
| Flow 测试 | 每个关键步骤的状态和最终业务结果 |
| E2E 测试 | 完整流程的创建、查询、更新、清理结果 |
| 异常测试 | 错误提示、失败响应、资源状态未被破坏 |
| 边界测试 | 边界参数下的状态码、错误信息或兼容行为 |
禁止用无意义断言替代业务验证,例如仅 assert True。
5. Fixture 使用
- 认证、页面、API 客户端使用公共 fixture。
- 测试数据通过 fixture 创建和清理。
- 避免测试方法之间传递状态。
- 并行执行时,fixture 应按 worker 隔离资源。
6. 文档回写
出现以下情况时,应检查并更新 test_cases/、docs/coverage/ 或 history.md:
- 新增测试文件或测试类型。
- 增删模块用例。
- 修复历史缺陷并补充回归测试。
- 调整测试数据、清理机制或并行策略。
- 发现接口响应结构或页面流程变化。