/elegant-TDD

TDD 是获得良好的测试防护网的关键实践。其核心要义有二：提升反馈速度、作自动化的回归测试。

Primary LanguageTypeScript

TDD 练习心得

对TDD的认识走过几个阶段，先是狂热好辨，中间有段低落，现在对它充满信心，唯恐练习不足。跟养成任何一个习惯一样，一开始总是有种种不适，觉得这也不会，那也不顺，这是习惯养成第一阶段，此时唯一需要的就是信心和坚持，跟社群一起学习成长可以更快度过这个阶段。过了一两周，你开始初入学习门径，开始辨别到基本功的关节所在（如何拆分任务、如何小步前进、如何编写第一个用例、如何使用快捷键、如何快速获得一个可运行测试的环境……），开始刻意练习，你就会感受到这个新习惯带来的好处：提升效率、活跃思维。

对于初学者来说，关键在于最初的两周，你只需要两件东西：信心和坚持。正如仝校长所说，大道至简，坚持者寡。与诸君共勉。

2020 年 10 月

本仓库有什么

本仓库旨在为初学者提供一系列TDD入门的刻意练习kata、为入门者提供查缺补漏的资料，它主要有两块东西：

  • 一系列TDD的kata练习，以供刻意练习之用
  • README（也就是本首页）是一些精选的、有关TDD的简易学习材料

对于初学者来说，最重要的暂且不是资料，更不是质疑，而是信心和坚持：要对TDD能为你带来效率提升和思维转变有信心，要靠坚决练习来度过一开始（可能有的）不适期。有了这两件东西，你需要做的只是马上开始练习：下面TDD的基本过程一节为你描述了一个简单而完整的TDD流程，并附上了一个视频。看一遍，然后挑src/fizzbuzz这道题开始你的练习。多练几遍，留意下你遇到的问题，再回来看本仓库剩下的部分。

对于入门及进阶者来说，可以看看本README里谈及的TDD其他方面，与自己的练习过程对比、查缺补漏。

练习题

最近还从项目中总结积累了一些实战项目比较常用的业务需求/模式需求，先放这有空做些题来做更加接近实战的练习。

  • 权限类问题：权限可以跟人走、跟物走、跟具体操作走等
  • 状态机问题：涉及一个穷尽的状态表、变迁控制及校验、每个状态的处理方法等问题
    • 比如订单状态：created - submitted - validated - payment - shipping - cancelled等闭环状态
    • 比如金融买卖：submitted - validated - accepted(auto-accepted) - pending - executed/rejected等状态
  • 校验类问题：涉及多种类型校验、校验逻辑实现、结果报告方式等问题
  • 流程类问题：涉及流程状态变更、流程时间节点及时间线、时区、交易日等问题，常见例子是保单、金融资产调仓等
  • 发布-订阅类问题：涉及调度系统如拉取/推送机制、任务状态、重试机制等问题实现，系统可以是通用的，也可以与特殊业务耦合，常见例子是队列、定时作业系统等

TDD的基本过程

What is(is not) TDD / TDD（不）是什么

关于 TDD 是什么及不是什么的问题，文字之辩未免无力，将目前的结论总结如下，请放到实践的视角下来看它。TDD 需要其他设施的支撑，如任务分解、自动化测试、重构等，这里厘清下它们关系：

  • 任务分解 是一种思维方法，以符合人脑思考（一次一件事）的方式帮你高效地拆分、跟踪问题，回答了「你怎么知道你做完了」这个问题
  • 自动化测试 是代码质量、团队交流的唯一保障，否则重构、保留业务知识等都不可能进行
  • TDD 本身 是一种快速反馈的工具。同样验证一个任务，你可以去浏览器看实际效果，你可以用 mock 数据，也可以用先行的自动化测试，其本质在于追求极致的反馈速度

上一阶段的论断：TDD 只是一种管理代码的方法论，其问题域在于「帮你在明确了需求的前提下，更快速高效地产出好的代码」。如今看来总体是对的。需求明确这个事情依赖任务分解、kick-off 和个人经验等过程来快速得到反馈；更快速高效则是一个目标。

另外则是 TDD 不是什么的问题。大熊说，非彼无我，非我无所取。既然这个「我」是指「高效拆分问题、快速反馈、自动化验证」，那么「彼」自然是除此以外的所有东西，比如代码质量，比如设计质量。还是那句话，如果你不知道何谓好的代码，那你该去看书多撸码学习；如果你不知道什么是好的设计，自然别指望一种方法论能帮你学会设计本身。TDD 能做的是把你脑中之物更清晰地表达、更高效地实现出来，脑中若无物，正确方式应是赶紧补补。

Key of TDD / TDD 的关节

我认为 TDD 其内涵不是也远广于类似「红绿循环」此类口诀，但关节要点却十分明快，无非两样技术：任务分解 与 快速反馈，其中每样技术都可辅以刻意练习的方式来提高。

Tasking / 任务分解

任务分解是 TDD 的前置条件，TDD 需要的测试用例要从这里来。所以说一上来不做任务分解就红绿循环是错的。新人刚拿到一个编程任务时，很容易陷入细节不知所止，或者觉得心里没底不知道怎么做，不知道要做多久。其本质上是对工作任务（及自己状态）的混沌、不可见。通过任务分解的方式，强迫你去将大的任务完全穷尽地分解成独立的子问题，最后所得列表即唯一确定地描述了工作任务本身，帮助你将内在混沌的思路可视化出来。

因此，如上所述，分解出来的任务需要符合这两个条件：

  • 完全穷尽
  • 彼此独立

只有（尽力地）保证你分解的任务列表完全、穷尽地描述了原问题域，你才能放心地将任务列表作为「工作是否完成」的唯一标准。这种信心将是这个工具发挥威力的保障，相信实践越多的同学体会越深；而彼此独立这个事情，才不会导致任务之间互相依赖、递归完成，反而增加复杂度。

在具体的分解方式上，主要有两种：模块化、基于接口（契约）的分解法，以及场景化的分解法。前者得到的列表类似函数式编程，后者可能适用更抽象、更模式化的场景应用。有时也会混用，具体关节只有实践之后具体问题具体交流。总之，无论采用什么方法，最终都是为了得到一个完全穷尽、相互独立的任务列表，请牢记此主旨。

在分解这个事情上，没有统一的做法，并且分解出来的任务也很依赖现有技术栈及规范等的实现，可以说它是一种游走于接口与实现之间的尺度。因此无唯一答案的特性，仝老师称其为一项艺术，而非科学。我则觉得这给个人发挥留下了空间，是其变化多端的魅力所在。类似下棋。

以下是我最近做的一个任务分解列表。里面有一些计时信息，这个我们后面「刻意练习」的部分再聊。

- [ ]「订单记录」入口 - 30min:49min
  - [ ] 普通会员成功登陆后，应该看不到「我行产品」和「第三方产品」入口及「订单记录」标题 :34min
  - [ ] 会员用户（审批岗和经办岗）成功登陆后，应能看到「我行产品」和「第三方产品」入口及「订单记录」标题
    - [ ] 两个入口均是可点击的 :9min 虚拟机挂球了运行不起来
    - [ ] 点击后将跳转到「预留订单」页
  - [ ] 行内会员成功登陆后，应该看不到「我行产品」和「第三方产品」入口及「订单记录」标题
  - [ ] - 重构一下 `Entry` 和 `Section`，至少搬个地方吧，把 styles 也都弄出去 :6min
- [ ] 「预留订单」页：对于能够查看到「我行产品」和「第三方产品」的会员用户来说： 340min
  - [ ] header 的部分应显示标题「预留订单」- 2min 0min
  - [ ] header 部分应显示一个「返回」按钮，点击后应该返回「我的」页面 - 2min 0min 框架自动完成
  - [ ] 用户进入「预留订单」页时，应默认获取所有今日订单 - 15min
  - [ ] 「今日订单」 50min
    - [ ] 如果 API 返回的数据中有今日的订单，那么 45min
      - [ ] 所有订单应显示成一个订单列表 - 10min
      - [ ] 订单列表应该有一个标题：「今日订单」 - 10min
      - [ ] 订单列表的每项应该包含如下信息：订单标题、预留额度、剩余时间、订单状态 - 5min
      - [ ] 订单列表的每一项应该可以点击，点击后将跳转到该订单的「订单详情」页面 - 5min
      - [ ] 如果今日订单中有「预留成功」状态的订单，那么应该显示如下的 banner：「您有 \${n} 个待处理订单\n 请"会员经办岗"尽快登录招赢通网站发起购买」 - 10min
      - [ ] 如果今日订单中没有「预留成功」状态的订单，那么不显示上面的 banner - 5min
    - [ ] 如果 API 返回的数据中没有今日的订单，那么不显示订单列表，也不显示列表标题：「今日订单」 - 5min
  - [ ] 「最近七日订单」 120min
    - [ ] 在「今日订单」列表下面，应该显示一个「最近七日订单」按钮 - 5min
      - [ ] 点击按钮，应该获取最近七日订单，默认获取 20 条订单数据 - 10min
      - [ ] 若有最近七日的订单，则订单列表应显示一行标题：近 7 日的订单 - 5min
      - [ ] 若有最近七日的订单，应以订单列表的形式展现，每条订单项展示的信息内容为：订单标题、预留额度、剩余时间、订单状态 - 10min
      - [ ] 若有最近七日的订单，则订单列表的每一项都应是可以点击的，点击后跳转到该订单的「订单详情」页面 - 5min
      - [ ] 若无最近七日的订单，则不展示任何订单列表，也不展示标题：近 7 日的订单 - 5min
    - [ ] 点击「最近七日订单」按钮后： 25min
      - [ ] 若还有更多订单，则按钮依然显示，并且文字变为「加载更多订单」 - 20min
      - [ ] 若已没有更多订单，则按钮不显示 - 5min
    - [ ] 在「最近七日订单」按钮下面，应始终显示一行文字："如需查看全部订单，请登录招赢通网站"【待确认】，无论「最近七日订单」按钮是否显示 - 5min
    - [ ] 若点击了「加载更多订单」获取到更多的订单，应追加在原来列表的后面 - 25min
    - [ ] 若点击了「加载更多订单」获取到更多的订单，并且获取到原来重复的订单，则应进行去重，仅显示一条订单 - 25min
  - [ ] 订单加载效果： 25min
    - [ ] 无论刚进入页面正在获取「今日订单」时，还是点击了「最近七日订单」在获取最近订单时，页面均应显示 loading 效果 - 20min
    - [ ] 加载结束后，应该取消显示效果 - 5min
  - [ ] 预留额度处时钟效果： 125min
    - [ ] 时钟应该能实时变化 - 90min
    - [ ] 如果用户停留在界面期间订单剩余时间走完了，此时「预留成功」状态不会实时改变，可以仍然是「预留成功」，样式也不需发生变化 - 5min
    - [ ] 基于上一小条的情况下，如果用户点击了该订单，跳转到了「订单详情」页并从详情页点击「返回」再次回到「预留订单」页面，此时应看到这条订单状态已经变为「已实效」，同时剩余时间与订单状态的样式均有改变 - 30min
- [ ] 「订单详情」页 42min
  - [ ] 用户进入「订单详情」页时，应获取该订单的详情 - 20min
  - [ ] header 部分应显示标题「订单详情」 - 2min
  - [ ] header 部分应显示一个「返回」按钮，点击后应该返回「预留订单」页面 - 5min
  - [ ] 订单详情页应该显示该订单的如下信息：订单标题、额度预留剩余时间、产品代码、产品简称、预留额度、付款账户、状态、经办人、产品类型、开户行、户名、发起时间 - 15min
  - [ ] 订单详情页处处不可点击 - 0min
- [ ] 以上「订单记录」、「预留订单」及「订单详情」任务列表对于「我行产品」和「第三方产品」均一致 - 120min 重构
- [ ] 样式 - 120min
  - [ ] 「我行产品」、「第三方产品」入口样式
  - [ ] 「预留订单」页样式
  - [ ] 「订单详情」页样式

Feedback in a quicker way / 快速反馈

待写。

Key & Methods of design 设计的道与术

怎么样算是好的设计呢？首先要问，为什么要设计，它旨在解决/应对什么问题？回答是，变化。其实整个 TDD 的核心理念基础，也是认定变化必然、频繁存在。因此我们通过减少无效未来需求和减少变化发生时带来的变更成本两种方式来应对。TDD 顺便解决了第一个问题，而设计则是为了要解决第二个问题。

The key of design 设计之道

那么，如何减少变化发生时带来的变更成本呢？目前软件工程普遍认可的一种方式是：每次修改只改动与变化相关的地方。这就必然要求软件模块之间高内聚、低耦合，基于这种认知，目前的 5 条 SOLID 原则可以认为是整个设计模式体系的提纲挈领：

  • Single Responsibility Principle: 单一职责原则。
  • Open-Closed Principle: 开闭原则。
  • Dependency Inversion Principle: 依赖倒转原则。
  • Interface Segregation Principle: 接口隔离原则。
  • Liskov Substitution Principle: 里氏替换原则。

其要义均是隔离变化，尽量使每个模块（单元/类/方法）职责单一、相互独立，只有一个改变的理由。

The method of design 设计之术

  • 重构
  • 设计模式

Tech Stack & Credits 技术栈 与 道谢

Getting Started 运行项目

  • 安装：git clone git@github.com:linesh-simplicity/elegant-tdd.git
  • 依赖安装：npm install
  • 运行 checkstyle：npm run lint
  • 运行所有测试：npm test
  • 运行覆盖率检查：npm report

Reference 参考

好像不错的一个系列，可以看看：http://randycoulman.com/blog/2015/07/21/getting-testy-anti-patterns/

Best Materials 最精华资料

Argues 论战

My takes 我的思考

算不得精华，但毕竟是我的思考过程，我的仓库我就做主了。

Inspirations 其他