name: test-driven-development description: 在编写实现代码之前,实施任何功能或修复错误时使用 license: MIT metadata: version: “1.0.0” domain: 架构 triggers: TDD, 测试驱动开发, 红-绿-重构, 测试优先 role: 专家 scope: 实现 output-format: 代码 related-skills: 单元测试-测试生成, 端到端测试模式
测试驱动开发 (TDD)
概述
先写测试代码。观察它失败。编写最少代码以通过。
核心原则: 如果你没有观察测试失败,你就不知道它是否测试了正确的东西。
违反规则的文字就是违反规则的精神。
何时使用
始终:
- 新功能
- 错误修复
- 重构
- 行为变更
例外(咨询你的人类伙伴):
- 临时原型
- 生成代码
- 配置文件
思考“就这一次跳过TDD”?停止。那是合理化借口。
铁律
没有生产代码,除非先有一个失败的测试
在测试之前写代码?删除它。重新开始。
没有例外:
- 不要保留它作为“参考”
- 不要在写测试时“适配”它
- 不要看它
- 删除意味着删除
从测试开始新鲜实现。句号。
红-绿-重构
digraph tdd_cycle {
rankdir=LR;
red [label="红
写失败测试", shape=box, style=filled, fillcolor="#ffcccc"];
verify_red [label="验证失败
正确", shape=diamond];
green [label="绿
最少代码", shape=box, style=filled, fillcolor="#ccffcc"];
verify_green [label="验证通过
全部绿色", shape=diamond];
refactor [label="重构
清理", shape=box, style=filled, fillcolor="#ccccff"];
next [label="下一个", shape=ellipse];
red -> verify_red;
verify_red -> green [label="是"];
verify_red -> red [label="错误
失败"];
green -> verify_green;
verify_green -> refactor [label="是"];
verify_green -> green [label="否"];
refactor -> verify_green [label="保持
绿色"];
verify_green -> next;
next -> red;
}
红 - 写失败测试
写一个最小测试,展示应该发生什么。
<好>
test('重试失败操作3次', async () => {
let attempts = 0;
const operation = () => {
attempts++;
if (attempts < 3) throw new Error('失败');
return '成功';
};
const result = await retryOperation(operation);
expect(result).toBe('成功');
expect(attempts).toBe(3);
});
清晰名称,测试真实行为,一件事 </好>
<坏>
test('重试有效', async () => {
const mock = jest.fn()
.mockRejectedValueOnce(new Error())
.mockRejectedValueOnce(new Error())
.mockResolvedValueOnce('成功');
await retryOperation(mock);
expect(mock).toHaveBeenCalledTimes(3);
});
模糊名称,测试模拟而非代码 </坏>
要求:
- 一个行为
- 清晰名称
- 真实代码(除非不可避免,否则不用模拟)
验证红 - 观察它失败
强制。从不跳过。
npm test path/to/test.test.ts
确认:
- 测试失败(非错误)
- 失败消息符合预期
- 失败因为功能缺失(非拼写错误)
测试通过? 你在测试现有行为。修复测试。
测试错误? 修复错误,重新运行直到正确失败。
绿 - 最少代码
编写最简单代码以通过测试。
<好>
async function retryOperation<T>(fn: () => Promise<T>): Promise<T> {
for (let i = 0; i < 3; i++) {
try {
return await fn();
} catch (e) {
if (i === 2) throw e;
}
}
throw new Error('不可达');
}
仅足够通过 </好>
<坏>
async function retryOperation<T>(
fn: () => Promise<T>,
options?: {
maxRetries?: number;
backoff?: 'linear' | 'exponential';
onRetry?: (attempt: number) => void;
}
): Promise<T> {
// YAGNI
}
过度工程 </坏>
不要添加功能、重构其他代码或“改进”超出测试范围。
验证绿 - 观察它通过
强制。
npm test path/to/test.test.ts
确认:
- 测试通过
- 其他测试仍通过
- 输出纯净(无错误、警告)
测试失败? 修复代码,非测试。
其他测试失败? 立即修复。
重构 - 清理
仅在绿色之后:
- 移除重复
- 改进名称
- 提取帮助函数
保持测试绿色。不要添加行为。
重复
下一个失败测试,针对下一个功能。
好测试
| 质量 | 好 | 坏 |
|---|---|---|
| 最小化 | 一件事。名称中有“和”?分开它。 | test('验证邮件和域名和空格') |
| 清晰 | 名称描述行为 | test('测试1') |
| 展示意图 | 展示期望API | 模糊代码应做什么 |
为什么顺序重要
“我会在之后写测试以验证它工作”
在代码之后写的测试立即通过。立即通过证明不了什么:
- 可能测试错误东西
- 可能测试实现,非行为
- 可能遗漏你忘记的边缘情况
- 你从未看到它捕获错误
测试优先强制你看到测试失败,证明它确实测试了某些东西。
“我已经手动测试了所有边缘情况”
手动测试是临时的。你以为测试了一切但:
- 没有记录你测试了什么
- 当代码变更时无法重新运行
- 在压力下容易忘记案例
- “我尝试时它工作了” ≠ 全面
自动化测试是系统化的。它们每次以相同方式运行。
“删除X小时工作是浪费”
沉没成本谬误。时间已经过去。你现在选择:
- 删除并用TDD重写(X更多小时,高置信度)
- 保留并在之后添加测试(30分钟,低置信度,可能错误)
“浪费”是保留你无法信任的代码。没有真实测试的工作代码是技术债务。
“TDD是教条主义,实用主义意味着适应”
TDD是实用主义:
- 在提交前发现错误(比之后调试更快)
- 防止回归(测试立即捕获中断)
- 文档化行为(测试展示如何使用代码)
- 启用重构(自由更改,测试捕获中断)
“实用主义”捷径 = 生产调试 = 更慢。
“之后测试实现相同目标 - 是精神而非仪式”
不。之后测试回答“这做什么?” 测试优先回答“这应该做什么?”
之后测试受你实现偏差。你测试你构建的,而非要求的。你验证记得的边缘情况,而非发现的。
测试优先强制在实现前发现边缘情况。之后测试验证你记住了所有(你没有)。
30分钟后测试 ≠ TDD。你获得覆盖率,失去证明测试工作的证据。
常见合理化借口
| 借口 | 现实 |
|---|---|
| “太简单而不测试” | 简单代码会中断。测试需30秒。 |
| “我之后会测试” | 测试立即通过证明不了什么。 |
| “之后测试实现相同目标” | 之后测试 = “这做什么?” 测试优先 = “这应该做什么?” |
| “已经手动测试了” | 临时 ≠ 系统化。无记录,无法重新运行。 |
| “删除X小时是浪费” | 沉没成本谬误。保留未验证代码是技术债务。 |
| “保留为参考,先写测试” | 你会适配它。那是之后测试。删除意味着删除。 |
| “需要先探索” | 好。丢弃探索,用TDD开始。 |
| “测试难 = 设计不清晰” | 倾听测试。难以测试 = 难以使用。 |
| “TDD会减慢我” | TDD比调试更快。实用主义 = 测试优先。 |
| “手动测试更快” | 手动不证明边缘情况。你会每次变更重新测试。 |
| “现有代码无测试” | 你在改进它。为现有代码添加测试。 |
红旗 - 停止并重新开始
- 测试前代码
- 实现后测试
- 测试立即通过
- 无法解释为什么测试失败
- 测试“稍后”添加
- 合理化“就这一次”
- “我已经手动测试了它”
- “之后测试实现相同目的”
- “是精神而非仪式”
- “保留为参考”或“适配现有代码”
- “已经花了X小时,删除是浪费”
- “TDD是教条主义,我是实用主义”
- “这个不同因为…”
所有这些意味着:删除代码。用TDD重新开始。
示例:错误修复
错误: 空邮件被接受
红
test('拒绝空邮件', async () => {
const result = await submitForm({ email: '' });
expect(result.error).toBe('邮件必填');
});
验证红
$ npm test
失败:预期 '邮件必填', 得到未定义
绿
function submitForm(data: FormData) {
if (!data.email?.trim()) {
return { error: '邮件必填' };
}
// ...
}
验证绿
$ npm test
通过
重构 如果需要,为多个字段提取验证。
验证清单
标记工作完成前:
- [ ] 每个新函数/方法有测试
- [ ] 在实现前观察每个测试失败
- [ ] 每个测试因预期原因失败(功能缺失,非拼写错误)
- [ ] 编写最少代码以通过每个测试
- [ ] 所有测试通过
- [ ] 输出纯净(无错误、警告)
- [ ] 测试使用真实代码(模拟仅当不可避免)
- [ ] 覆盖边缘情况和错误
无法勾选所有?你跳过了TDD。重新开始。
当卡住时
| 问题 | 解决方案 |
|---|---|
| 不知如何测试 | 写希望API。先写断言。询问你的人类伙伴。 |
| 测试太复杂 | 设计太复杂。简化接口。 |
| 必须模拟一切 | 代码太耦合。使用依赖注入。 |
| 测试设置巨大 | 提取帮助函数。仍复杂?简化设计。 |
调试集成
发现错误?写失败测试重现它。遵循TDD循环。测试证明修复并防止回归。
永不修复错误而没有测试。
测试反模式
当添加模拟或测试工具时,阅读 @testing-anti-patterns.md 以避免常见陷阱:
- 测试模拟行为而非真实行为
- 向生产类添加测试专用方法
- 模拟而不理解依赖
最终规则
生产代码 → 测试存在且先失败
否则 → 非TDD
没有你人类伙伴的许可,无例外。