test-driven-development

测试驱动开发（TDD）

概述

先写测试。观察它失败。编写最少的代码使其通过。

核心原则： 如果你没有亲眼看到测试失败，就无法确定它测试的是正确内容。

违反规则的字面要求，就是违背规则的精神。

适用场景

始终适用：

• 新功能
• 修复 Bug
• 重构
• 行为变更

例外情况（请咨询与你协作的人）：

• 一次性原型
• 生成的代码
• 配置文件

在想“这次就跳过 TDD 吧”？停下。这是在自我合理化。

铁律

NO PRODUCTION CODE WITHOUT A FAILING TEST FIRST

先写代码再写测试？删掉它。重新开始。

没有例外：

• 不要把它留作“参考”
• 写测试时不要对它进行“改造”
• 不要看它
• 删除就是删除

从测试开始重新实现。就是这样。

红-绿-重构

digraph tdd_cycle {
    rankdir=LR;
    red [label="RED\nWrite failing test", shape=box, style=filled, fillcolor="#ffcccc"];
    verify_red [label="Verify fails\ncorrectly", shape=diamond];
    green [label="GREEN\nMinimal code", shape=box, style=filled, fillcolor="#ccffcc"];
    verify_green [label="Verify passes\nAll green", shape=diamond];
    refactor [label="REFACTOR\nClean up", shape=box, style=filled, fillcolor="#ccccff"];
    next [label="Next", shape=ellipse];

    red -> verify_red;
    verify_red -> green [label="yes"];
    verify_red -> red [label="wrong\nfailure"];
    green -> verify_green;
    verify_green -> refactor [label="yes"];
    verify_green -> green [label="no"];
    refactor -> verify_green [label="stay\ngreen"];
    verify_green -> next;
    next -> red;
}

RED - 编写失败的测试

编写一个最精简的测试，说明应该发生什么。

```typescript test('retries failed operations 3 times', async () => { let attempts = 0; const operation = () => { attempts++; if (attempts < 3) throw new Error('fail'); return 'success'; };

const result = await retryOperation(operation);

expect(result).toBe('success'); expect(attempts).toBe(3); });

名称清晰、测试真实行为、只测一件事
</Good>

<Bad>
```typescript
test('retry works', async () => {
  const mock = jest.fn()
    .mockRejectedValueOnce(new Error())
    .mockRejectedValueOnce(new Error())
    .mockResolvedValueOnce('success');
  await retryOperation(mock);
  expect(mock).toHaveBeenCalledTimes(3);
});

名称含糊、测试的是模拟对象而非代码

要求：

• 一个行为
• 名称清晰
• 使用真实代码（除非无法避免，否则不使用模拟对象）

验证 RED - 观察它失败

必须执行。绝不跳过。

运行项目的测试命令（例如 pnpm test——在 package.json 或 AGENTS.md 中确认正确的命令）：

pnpm test path/to/test.test.ts

确认：

• 测试失败（不是报错）
• 失败信息符合预期
• 失败原因是功能缺失（不是拼写错误）

测试通过了？ 你测试的是现有行为。修正测试。

测试报错了？ 修复错误并重新运行，直到它按预期失败。

GREEN - 编写最少的代码

编写能让测试通过的最简单代码。

```typescript async function retryOperation(fn: () => Promise): Promise { for (let i = 0; i < 3; i++) { try { return await fn(); } catch (e) { if (i === 2) throw e; } } throw new Error('unreachable'); } ``` 只写足以通过测试的代码 ```typescript async function retryOperation( fn: () => Promise, options?: { maxRetries?: number; backoff?: 'linear' | 'exponential'; onRetry?: (attempt: number) => void; } ): Promise { // YAGNI } ``` 过度设计

不要添加功能、重构其他代码，或超出测试范围进行“改进”。

验证 GREEN - 观察它通过

必须执行。

运行项目的测试命令（例如 pnpm test——在 package.json 或 AGENTS.md 中确认正确的命令）：

pnpm test path/to/test.test.ts

确认：

• 测试通过
• 其他测试仍然通过
• 输出干净（没有错误或警告）

测试失败了？ 修复代码，而不是测试。

其他测试失败了？ 立即修复。

REFACTOR - 清理代码

只有通过后才能进行：

• 消除重复
• 改进命名
• 提取辅助函数

保持测试通过。不要添加行为。

重复

为下一个功能编写下一个失败的测试。

好的测试

质量	好	不好
精简	只测一件事。名称里有“和”？拆开它。	test('validates email and domain and whitespace')
清晰	名称描述行为	test('test1')
体现意图	展示期望的 API	未能清楚表明代码应该做什么

为什么顺序很重要

“我会在之后写测试来验证它能正常工作”

在代码之后写的测试会立即通过。立即通过什么也证明不了：

• 可能测错了东西
• 可能测的是实现，而不是行为
• 可能遗漏了你忘记的边界情况
• 你从未看到它捕获到 bug

测试先行迫使你看到测试失败，从而证明它确实测了某些东西。

“我已经手动测过所有边界情况了”

手动测试是临时的。你以为你测了一切，但是：

• 没有记录你测了什么
• 代码变更时无法重新运行
• 在压力下容易忘记用例
• “我试的时候它是好的” ≠ 全面

自动化测试是系统性的。它们每次都以同样的方式运行。

“删掉 X 小时的工作是浪费”

沉没成本谬误。时间已经花掉了。你现在的选择：

• 删掉并用 TDD 重写（再花 X 小时，高信心）
• 保留它并在之后补测试（30 分钟，低信心，很可能有 bug）

真正的“浪费”是保留你无法信任的代码。没有真正测试的可运行代码是技术债。

“TDD 是教条的，务实意味着变通”

TDD 就是务实的：

• 在提交前发现 bug（比提交后再调试更快）
• 防止回归（测试立即捕获破坏）
• 记录行为（测试展示如何使用代码）
• 支持重构（自由修改，测试捕获破坏）

“务实”的捷径 = 在生产环境调试 = 更慢。

“之后写测试能达到同样的目标——重要的是精神而非仪式”

不。之后写测试回答的是“这段代码做什么？”测试先行回答的是“这段代码应该做什么？”

之后写测试会被你的实现带偏。你测的是你构建的东西，而不是需求要求的东西。你验证的是你记得的边界情况，而不是发现出来的边界情况。

测试先行迫使你在实现之前发现边界情况。之后写测试验证你是否记住了一切（你并没有）。

之后写 30 分钟的测试 ≠ TDD。你得到了覆盖率，却失去了测试有效的证明。

常见合理化借口

借口	现实
“太简单了不用测”	简单的代码也会坏。测试只要 30 秒。
“我会之后测”	测试立即通过什么也证明不了。
“之后写测试能达到同样的目标”	之后写测试 = “这段代码做什么？”测试先行 = “这段代码应该做什么？”
“已经手动测过了”	临时 ≠ 系统性。没有记录，无法重新运行。
“删掉 X 小时是浪费”	沉没成本谬误。保留未经验证的代码是技术债。
“留着作参考，先写测试”	你会改编它。那还是在之后测试。删掉就是删掉。
“需要先探索一下”	可以。扔掉探索成果，从 TDD 开始。
“难以测试 = 设计不清晰”	倾听测试。难以测试 = 难以使用。
“TDD 会拖慢我”	TDD 比调试更快。务实 = 测试先行。
“手动测试更快”	手动测试证明不了边界情况。每次变更你都要重新测。
“现有代码没有测试”	你正在改进它。为现有代码添加测试。

危险信号 - 停下来并重新开始

• 测试之前先写代码
• 实现之后才写测试
• 测试立即通过
• 无法解释测试为什么失败
• 测试“稍后”添加
• 合理化“就这一次”
• “我已经手动测过了”
• “之后写测试能达到同样的目的”
• “重要的是精神而非仪式”
• “留着作参考”或“改编现有代码”
• “已经花了 X 小时，删掉是浪费”
• “TDD 是教条的，我是务实的”
• “这次不一样，因为……”

所有这些都意味着：删掉代码。用 TDD 重新开始。

示例：Bug 修复

Bug： 空 email 被接受

RED

test('rejects empty email', async () => {
  const result = await submitForm({ email: '' });
  expect(result.error).toBe('Email required');
});

验证 RED

$ pnpm test
FAIL: expected 'Email required', got undefined

GREEN

function submitForm(data: FormData) {
  if (!data.email?.trim()) {
    return { error: 'Email required' };
  }
  // ...
}

验证 GREEN

$ pnpm test
PASS

REFACTOR 如有需要，为多个字段提取校验逻辑。

验证清单

标记工作完成前：

• 每个新函数／方法都有测试
• 实现前观察每个测试失败
• 每个测试都因预期原因失败（缺少功能，而非拼写错误）
• 编写通过每个测试所需的最少代码
• 所有测试均通过
• 输出干净（没有错误或警告）
• 测试使用真实代码（仅在无法避免时使用模拟）
• 覆盖边界情况和错误

无法勾选所有项？你跳过了 TDD。重新开始。

遇到困难时

问题	解决方案
不知道如何测试	写出你希望使用的 API。先写断言。向你的人类搭档求助。
测试太复杂	设计太复杂。简化接口。
必须模拟所有内容	代码耦合过多。使用依赖注入。
测试设置过于繁琐	提取辅助函数。还是复杂？简化设计。

调试集成

发现 Bug？编写一个能复现它的失败测试。遵循 TDD 循环。测试既能证明修复有效，也能防止回归。

绝不在没有测试的情况下修复 Bug。

测试反模式

添加模拟或测试工具时，请留意常见反模式：

• 测试模拟行为，而非真实行为
• 在生产类中添加仅供测试使用的方法
• 未了解依赖项就进行模拟

最终规则

Production code → test exists and failed first
Otherwise → not TDD

未经你的人类搭档许可，不得例外。