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 - 观察它失败

必须执行。绝不能跳过。

npm 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 - 观察它通过

必须执行。

npm test path/to/test.test.ts

确认：

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

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

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

REFACTOR - 清理代码

只有通过测试后才能：

• 删除重复内容
• 改进命名
• 提取辅助函数

确保测试继续通过。不要添加行为。

重复

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

好的测试

质量	好	差
精简	只验证一件事。名称里有“和”？拆开。	test('validates email and domain and whitespace')
清晰	名称描述行为	test('test1')
体现意图	展示期望的 API	模糊代码应该执行什么操作

编写或修改任何测试时，请阅读 writing-good-tests.md，了解确保测试真实可靠的规则：

• 在编写测试之前，先指出哪项生产代码的改动会让测试失败
• 断言真实行为，绝不对模拟对象的行为进行断言
• 仅在测试辅助工具中保留测试专用代码，不要放进生产类
• 模拟依赖项之前，先了解其副作用

常见借口

借口	实际情况
"太简单，无需测试"	简单的代码也会出错。写测试只需 30 秒。
"我之后再写测试"	事后编写的测试会立即通过，这什么也证明不了。它们可能测试了错误的东西，测试的是实现而不是行为，或者漏掉你忘记的边界情况。你从未看到它失败，因此无法证明它能发现缺陷。先写测试会迫使测试先失败。
"事后测试能达到同样目的（重精神，不重形式）"	事后测试回答的是"这段代码做了什么？"；先写测试回答的是"这段代码应该做什么？"。事后编写的测试会受到已写代码的影响，你验证的只是自己记得的情况，而不是本可以发现的情况。覆盖率无法证明测试本身有效。
"已经手动测试过了"	手动测试是临时性的：没有记录覆盖了哪些内容，代码变更后无法重新执行，在压力下容易遗漏情况。"我试过，能用"并不等于全面。自动化测试每次都以相同方式运行。
"删掉 X 小时的工作太浪费"	沉没成本谬误——这些时间无论如何都已经花掉了。真正的选择是：用 TDD 重写（高度可信）还是保留代码再补测试（可信度低，很可能有缺陷）。保留你无法信任的代码才是浪费。
"保留作参考，先写测试"	你最终还是会去修改它，那就是事后测试。删除就是删除。
"需要先探索一下"	可以。探索完就丢弃，然后从 TDD 开始。
"测试很难写 = 设计不清晰"	听听测试的反馈。难以测试意味着难以使用。
"TDD 会拖慢速度"	TDD 才是务实的做法：在提交前发现缺陷，防止回归，让你重构时无所顾忌。所谓"务实"的捷径，意味着在生产环境中调试——更慢，而不是更快。
"手动测试更快"	手动测试无法证明边界情况。每次改动你都得重新测试。
"现有代码没有测试"	你正在改进它。为现有代码补充测试。

危险信号——停止并从头开始

• 先写代码，后写测试
• 实现之后才写测试
• 测试立即通过
• 无法解释测试为何失败
• 测试是"之后"才补的
• 以"就这一次"为由找借口
• "我已经手动测试过了"
• "事后测试能达到同样目的"
• "重精神，不重形式"
• "保留作参考"或"修改现有代码"
• "已经花了 X 小时，删掉太浪费"
• "TDD 太教条，我是在务实"
• "这次不一样，因为……"

以上所有情况都意味着：删除代码，从头用 TDD 重新开始。

示例：修复缺陷

缺陷： 接受了空邮箱

RED

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

验证 RED

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

GREEN

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

验证 GREEN

$ npm test
PASS

REFACTOR 如有需要，将多个字段的校验逻辑提取出来。

验证清单

在标记工作完成之前：

• 每个新增的函数/方法都有测试
• 在实现之前，已确认每个测试都失败了
• 每个测试都因预期的原因失败（功能缺失，而非拼写错误）
• 编写了最少的代码让每个测试通过
• 所有测试都通过
• 输出干净（无错误、无警告）
• 测试使用真实代码（仅在不可避免时使用模拟）
• 边界情况和错误都已覆盖

有任何一项未勾选？说明你跳过了 TDD。从头开始。

遇到困难时

问题	解决方案
不知道如何测试	先写出你期望的 API。先写断言。询问你的人类搭档。
测试太复杂	设计太复杂。简化接口。
必须模拟所有依赖	代码耦合度过高。使用依赖注入。
测试准备代码过于庞大	提取辅助函数。仍然复杂？简化设计。

调试集成

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

永远不要在没有测试的情况下修复缺陷。

最终规则

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

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