SuperAPI AI 工具集

test-driven-development

编程与开发

查看项目

更新于 10-16 15:20

技能介绍

概述

本技能为测试驱动开发(Test-Driven Development,TDD)方法论指南,来源于 skills.sh 上的 zed-industries/superpowers 技能包。其核心主张是:先写测试,观看它失败,再编写最小代码使其通过。核心原则为:如果你没有亲眼看到测试失败,你就不知道它是否在测试正确的东西。违反规则的文字表述就是违反规则的精神。

何时使用

适用范围包括:新功能、bug 修复、重构、行为变更。例外情况(需征询人类伙伴)包括:一次性原型、生成的代码、配置文件。当心中出现「这次就跳过 TDD 吧」的念头时,技能建议停下来,认为这是一种合理化借口。

铁律

铁律为:NO PRODUCTION CODE WITHOUT A FAILING TEST FIRST(没有失败的测试就不写生产代码)。如果先写了代码再写测试,则需要删除代码、重新开始。不得将其保留为「参考」、不得在写测试时「改造」它、不得查看它。删除就是删除,从测试出发重新实现。

Red-Green-Refactor 循环

技能使用有向图描述 TDD 循环:RED(写出失败测试)→ 验证失败是否正确 → GREEN(编写最小代码)→ 验证是否通过、全部为绿 → REFACTOR(清理)→ 保持绿色 → 下一个测试。

RED — 写失败测试

编写一个展示预期行为的最小测试。测试要求:单一行为、清晰的名称、真实代码(除非不可避免否则不使用 mock)。技能给出 Good 与 Bad 示例对比:Good 示例测试真实行为、命名清晰、只测一件事;Bad 示例命名模糊、测试的是 mock 而非代码。

验证 RED — 观看它失败

这一步是强制性的,永远不能跳过。运行测试(如 npm test path/to/test.test.ts),确认:测试失败(而非报错)、失败信息符合预期、失败原因是功能缺失(而非拼写错误)。如果测试通过,说明你在测试已有行为,需修正测试;如果测试报错,修正错误后重跑直到正确失败。

GREEN — 最小代码

编写最简单的代码使测试通过。不要添加功能、不要重构其他代码、不要超出测试范围去「改进」。

验证 GREEN — 观看它通过

同样为强制性。确认:测试通过、其他测试仍通过、输出干净(无错误、警告)。若测试失败则修代码而非改测试;若其他测试失败则立即修复。

REFACTOR — 清理

仅在绿灯后进行:消除重复、改进命名、提取辅助函数。保持测试绿色,不添加行为。然后重复:为下一个功能编写下一个失败测试。

好测试的标准

最小:只测一件事,名称中出现「and」就拆分。清晰:名称描述行为。展示意图:演示期望的 API。

为什么顺序很重要

技能反驳了多种常见借口:「我会在写完后加测试来验证它能工作」——写完代码后再写的测试会立即通过,立即通过无法证明任何东西:可能测错东西、可能测实现而非行为、可能漏掉你忘记的边界情况、你从未看到它抓住 bug。测试先行强制你看到测试失败,证明它确实在测试某些东西。「我已经手动测试了所有边界情况」——手动测试是临时的,没有记录、代码变更后无法重跑、压力下容易忘记用例;自动化测试是系统性的。「删除 X 小时的工作是浪费」——这是沉没成本谬误,时间已经花掉了;保留你无法信任的代码才是技术债。「TDD 是教条的,务实意味着变通」——TDD 本身是务实的:在提交前发现 bug(比事后调试更快)、防止回归、文档化行为、支持重构。「写完后测试达到相同目标——重要的是精神而非仪式」——不对,事后测试回答「这做什么」,测试先行回答「这应该做什么」;事后测试受实现偏见影响,测试你构建的东西而非需求。

常见合理化借口反驳表

技能以表格形式列出常见借口与事实对照,例如:「太简单不需要测试」——简单代码也会坏,测试只需 30 秒;「我会事后测试」——立即通过的测试证明不了任何东西;「删除 X 小时是浪费」——沉没成本谬误,保留未验证的代码是技术债;「保留作为参考,先写测试」——你会改造它,那就是事后测试,删除就是删除;「需要先探索」——可以,丢弃探索结果,从 TDD 开始;「测试难写 = 设计不清晰」——听测试的话,难测试就是难使用;「TDD 会拖慢我」——TDD 比调试快;「手动测试更快」——手动无法证明边界情况。「这是不同的因为……」等说法都意味着:删除代码,用 TDD 重新开始。

红线清单 — 停止并重新开始

测试之前写代码、实现后写测试、测试立即通过、无法解释测试为何失败、测试是「稍后」添加的、把「就这一次」合理化、「我已经手动测试过」、认为「事后测试达到相同目的」、认为「重要的是精神而非仪式」、「保留作为参考」或「改造现有代码」、「已经花了 X 小时,删除是浪费」、「TDD 是教条的,我很务实」、「这是不同的因为……」。以上所有情况都意味着:删除代码,用 TDD 重新开始。

示例:Bug 修复

Bug 场景:空邮箱被接受。RED 阶段写出测试 'rejects empty email',期望返回错误 'Email required';验证 RED 时运行 npm test 看到 FAIL: expected 'Email required', got undefined;GREEN 阶段编写 submitForm 函数,检查 data.email?.trim() 为空则返回错误;验证 GREEN 时 npm test 显示 PASS;REFACTOR 阶段如有需要可为多个字段提取校验逻辑。

验证清单

标记工作完成前需检查:每个新函数/方法都有测试、在实现前观看每个测试失败、每个测试因预期原因失败(功能缺失而非拼写错误)、编写最小代码使每个测试通过、所有测试通过、输出干净(无错误、警告)、测试使用真实代码(mock 仅在不可避免时使用)、边界情况和错误已覆盖。无法勾选全部则说明跳过了 TDD,需重新开始。

遇到困难时

技能给出问题与解决方案对照:不知道怎么测试——写下期望的 API、先写断言、询问人类伙伴;测试太复杂——设计太复杂,简化接口;必须 mock 一切——代码耦合过紧,使用依赖注入;测试设置庞大——提取辅助函数,仍然复杂则简化设计。

与调试的整合

发现 bug 时:编写复现它的失败测试,遵循 TDD 循环。测试证明修复并防止回归。永远不要在没有测试的情况下修复 bug。

测试反模式

添加 mock 或测试工具时,需阅读 @testing-anti-patterns.md 以避免常见陷阱:测试 mock 行为而非真实行为、向生产类添加仅用于测试的方法、在不理解依赖的情况下进行 mock。

最终规则

生产代码 → 测试存在且先失败过,否则就不是 TDD。未经人类伙伴许可,没有例外。