test-driven-development

测试驱动开发（TDD）

概述

先写测试。看着它失败。写最少的代码让它通过。

核心原则： 如果你没有看着测试失败，你就不知道它测试的是不是正确的东西。

违反规则的文字就是违反规则的精神。

何时使用

用于行为变更，且可重复的测试能够证明需求或复现缺陷的场景。先检查仓库的测试运行器和现有覆盖率。对于文案、生成产物或低影响的配置，使用相应的针对性验证，而不是强行编造一个单元测试。

保留现有工作

在可行的情况下，先写失败的回归测试再进行修复，并验证它因预期原因而失败。如果实现已经存在，保留它并添加特征化/回归测试。不要为了重建理想的测试优先历史而删除用户的工作、重置分支或重写可用的代码。如实说明测试是否先于修复。

红-绿-重构

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('succeeds on the third attempt', async () => { let attempts = 0; const operation = async () => { 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);
});

名称含糊，测试 mock 而非代码

要求：

• 一个行为
• 清晰的名称
• 真实代码（除非不可避免，否则不用 mock）

验证 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	掩盖代码应该做什么

为什么顺序很重要

失败的测试可以在实现之前暴露被误解的需求。修复之后写的测试仍然可以有价值，但它对原始缺陷的敏感度需要证据。时机和覆盖率百分比都不能证明断言是有意义的。

如果失败是由缺失的导入、不可用的服务或错误的 fixture 引起的，在解读结果之前先修复这些设置。在可行的情况下使用真实边界；当 mock 能隔离外部依赖同时保留被测契约时，它是有用的。

示例：缺陷修复

缺陷： 接受了空邮箱

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 如有需要，为多个字段提取验证逻辑。

验证清单

在标记工作完成之前：

• 变更的行为和由此产生的失败路径都有适当的测试
• 回归敏感性得到证明；测试的时机被如实报告
• 每个测试都因预期原因失败（功能缺失，而不是拼写错误）
• 编写最小代码以使每个测试通过
• 所有测试通过
• 输出无异常（没有错误、警告）
• 测试使用真实代码（仅在不可避免时使用 mock）
• 边界情况和错误已覆盖

记录任何未满足的检查项及其后果。不要为了完成清单而删除工作或声称一个未被观察到的失败。

遇到困难时

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

调试集成

发现 Bug？编写能复现它的失败测试。遵循 TDD 循环。测试证明修复并防止回归。

对于 Bug 修复，优先使用可复现的回归测试；当测试无法合理地触发失败时，使用另一个显式的验证器。

测试反模式

在添加 mock 或测试工具时，阅读 @testing-anti-patterns.md 以避免常见陷阱：

• 测试 mock 行为而不是真实行为
• 向生产类添加仅用于测试的方法
• 在不理解依赖的情况下进行 mock

输入和预期结果

你需要用户可见的需求、当前实现、一个已知的运行器和一个受控的测试夹具。在空邮箱示例中，失败必须是“缺少验证”，而不是网络中断。预期：回归测试在缺陷行为上失败，并在最小修复后通过，同时现有的有效提交仍然正常工作。

局限性

• 通过的单元测试不能证明浏览器、打包运行时或提供商集成行为。
• 重试示例假设操作可安全重试；生产环境的重试需要显式的幂等性、取消和可重试错误策略。
• 测试优先的顺序并不能防止错误的需求或过度 mock。检查断言和真实边界。
• 保留无关的变更，并使用项目现有的测试命令，而不是假设每个 npm test 都接受相同的参数。