测试驱动开发 (TDD)

概述

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

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

违反规则的字面意思就是违反规则的精神。

何时使用

始终：

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

例外（询问你的人类伙伴）：

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

想着“只跳过 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;
}

红 - 编写失败的测试

编写一个最小测试，展示应该发生什么。

<Good>

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>

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

名称模糊，测试的是 mock 而不是代码 </Bad>

要求：

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

验证红 - 看着它失败

必须。绝不跳过。

npm test path/to/test.test.ts

确认：

• 测试失败（不是错误）
• 失败消息符合预期
• 因为功能缺失而失败（不是拼写错误）

测试通过？ 你正在测试现有行为。修复测试。

测试错误？ 修复错误，重新运行，直到它正确失败。

绿 - 最少代码

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

<Good>

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('unreachable');
}

刚好足以通过 </Good>

<Bad>

async function retryOperation<T>(
  fn: () => Promise<T>,
  options?: {
    maxRetries?: number;
    backoff?: 'linear' | 'exponential';
    onRetry?: (attempt: number) => void;
  }
): Promise<T> {
  // YAGNI
}

过度工程 </Bad>

不要添加功能、重构其他代码，或在测试之外“改进”。

验证绿 - 看着它通过

必须。

npm test path/to/test.test.ts

确认：

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

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

其他测试失败？ 现在修复。

重构 - 清理

仅在绿之后：

• 移除重复
• 改进名称
• 提取 helper

保持测试绿色。不要添加行为。

重复

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

好的测试

| 质量 | 好 | 坏 | |---------|------|-----| | 最少 | 一次一件事。名称中有“and”？拆分它。 | test('validates email and domain and whitespace') | | 清晰 | 名称描述行为 | test('test1') | | 展示意图 | 演示期望的 API | 掩盖代码应该做什么 |

编写或修改任何测试时，请阅读 [writing-good-tests.md](writing-good-tests.md) 中让测试保持诚实的规则：

• 先说出会让测试失败的生产代码变更 — 再写测试
• 断言真实行为，绝不针对 mock 行为
• 将仅用于测试的代码放在测试工具中，不要放在生产类中
• 在 mock 依赖项之前，先理解其副作用

常见的合理化

| 借口 | 现实 | |--------|---------| | “太简单，不需要测试” | 简单代码也会坏。测试只需 30 秒。 | | “我之后再测试” | 之后写的测试会立即通过 — 这证明不了任何东西。它们可能测试了错误的东西、测试了实现而不是行为，或遗漏了你忘记的边界情况。你没有看着它失败，因此你从未证明它能捕获缺陷。先写测试会迫使这种失败发生。 | | “事后测试也能达到同样目标（精神而非仪式）” | 事后测试回答“这段代码做什么？”；先写测试回答“这段代码应该做什么？” 事后写的测试会被你已经写下的代码带偏 — 你验证的是你记得的用例，而不是你本应发现的用例。覆盖率没有证明测试有效。 | | “已经手动测试过了” | 手动测试是临时的：没有记录你覆盖了什么，代码变更时无法重新运行，在压力下很容易遗漏用例。“我试过没问题” ≠ 全面。自动化测试每次都以相同方式运行。 | | “删除 X 小时是浪费” | 沉没成本谬误 — 无论如何这些时间已经花掉了。真正选择：用 TDD 重写（高信心）vs 保留它并事后补测试（低信心，可能有缺陷）。保留无法信任的代码才是浪费。 | | “保留作为参考，先写测试” | 你会去改编它。那是事后测试。删除就是删除。 | | “需要先探索” | 可以。丢弃探索，从 TDD 开始。 | | “测试难 = 设计不清楚” | 倾听测试。难以测试 = 难以使用。 | | “TDD 会拖慢我” | TDD 就是务实路径：在提交前捕获缺陷，防止回归，让你能无惧重构。“务实”的捷径意味着在生产环境调试 — 更慢，不是更快。 | | “手动测试更快” | 手动不能证明边界情况。每次变更你都要重新测试。 | | “现有代码没有测试” | 你正在改进它。为现有代码添加测试。 |

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

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

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

示例：缺陷修复

缺陷： 接受空电子邮件

红

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

验证红

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

绿

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

验证绿

$ npm test
PASS

重构 如果需要，为多个字段提取验证逻辑。

验证清单

在标记工作完成之前：

• [ ] 每个新函数/方法都有测试
• [ ] 在实现前看着每个测试失败
• [ ] 每个测试都因预期原因失败（功能缺失，不是拼写错误）
• [ ] 为每个测试编写了最少的代码使其通过
• [ ] 所有测试通过
• [ ] 输出干净（没有错误、警告）
• [ ] 测试使用真实代码（仅在不可避免时使用 mock）
• [ ] 覆盖了边界情况和错误

无法勾选所有框？你跳过了 TDD。从头开始。

卡住时

| 问题 | 解决方案 | |---------|----------| | 不知道如何测试 | 编写你希望的 API。先写断言。询问你的人类伙伴。 | | 测试太复杂 | 设计太复杂。简化接口。 | | 必须 mock 一切 | 代码耦合太紧。使用依赖注入。 | | 测试设置庞大 | 提取 helper。仍然复杂？简化设计。 |

调试集成

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

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

最终规则

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

没有你的人类伙伴的许可，没有例外。