TDD测试驱动开发教程 on 重定向学院

TDD实战（一）开发模式

Mon, 08 Jan 2018 12:59:11 +0800

TDD 介绍

TDD是测试驱动开发（Test-Driven Development）的英文简称，是敏捷开发中的一项核心实践和技术，也是一种设计方法论。TDD的原理是在开发功能代码之前，先编写单元测试用例代码，测试代码确定需要编写什么产品代码。TDD虽是敏捷方法的核心实践，但不只适用于XP（Extreme Programming），同样可以适用于其他开发方法和过程。

– 百度百科

准备工具

TDD只是一种开发模式，它并没有用到新的技术。

Java : 因为它是主流的编程语言，应用广泛，相关实践也非常多。
IntelliJ-IDEA : Java 主流IDE（集成开发工具）。
JUnit ： Java 主流单元测试框架，当然，你选择 TestNG 也是完全可以的。
Gradle : 构建工具。

TDD 开发模式

“红灯 – 绿灯 – 重构” 流程是TDD的基石。这个过程就像打乒乓球，快速的在测试代码和实现代码之间切换。

TDD 开的过程：每次只考虑一个需求。首先编写一个测试，看看它是否未通过；然后编写实现这个测试的代码，运行所有测试并验证它们是否全部通过；最后，通过重构改进代码。不断重复这个过程，直到成功实现所有需求。

需求

本系列实战 “井字游戏” ，这是一个非常简单的小游戏。

说明：

是一种在3*3格子上进行的连珠游戏，和五子棋比较类似，由于棋盘一般不画边框，格线排成井字故得名。游戏需要的工具仅为纸和笔，然后由分别代表O和X的两个游戏者轮流在格子里留下标记（一般来说先手者为X）。由最先在任意一条直线上成功连接三个标记的一方获胜。

不会玩的同学可以先去完两把：井字小游戏。

原始封面

TDD实战（二）“井字游戏” 需求一

Mon, 08 Jan 2018 12:55:11 +0800

保证你会玩“井字游戏” 并理解它的规则。

需求1

先定义边界，以及将棋子放在哪些地方非法。

可将棋子放在3×3棋盘上任何没有棋子的地方。

将需求分成三个测试：

如果棋子放在超出了X轴边界的地方，就引发 RuntimeException 异常。
如果棋子放在超出了Y轴边界的地方，就引发 RuntimeException 异常。
如果棋子放在已经有棋子的地方，就引发 RuntimeException 异常。

测试用例 1

默认你已经会使用 JUnit 单元测试框架了，根据上面的三个测试，我们先来完成第一个。

import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;


public class TicTacToeTest {

 @Rule
 public ExpectedException exception = ExpectedException.none();

 private TicTacToe ticTacToe;

 @Before
 public final void before() {
 ticTacToe = new TicTacToe();
 }

 @Test
 public void whenXOutsideBoardThenRuntimeException() {
 exception.expect(RuntimeException.class);
 ticTacToe.play(5, 2);
 }

}

测试调用 TicTacToe 类的 play() 方法，假设第一个参数是 x 轴，第二个参数是 y 轴，前面需求已经规定，棋盘是3×3的规格，所以参数必须不能小于1或大于3。 x 轴为5会引发异常。在 whenXOutsideBoardThenRuntimeException() 测试用例中，预期这被测代码会抛出 RuntimeException异常。

TDD实战（三）“井字游戏” 需求二

Mon, 08 Jan 2018 12:50:11 +0800

需求2

现在处理轮到哪个玩家落子问题。

需要提供一种途径，用于判断接下来该谁落子。

将需求分成三个测试：

玩家 X 先下；
如果上一次是 X 下的，接下来将轮到 O 下。
如果上一次是 O 下的，接下来将轮到 X 下。

测试用例1

import static org.junit.Assert.*;

……

@Test
public void givenFirstTurnWhenNextPlayerThenX(){
 assertEquals('X', ticTacToe.nextPlayer());
}

在这条用例中用到了 JUnit 的断言方法 assertEquals()，通过 nextPlayer() 判断下一个下棋的是否是 X 玩家。

实现代码1

对于当前的测试用例来说，根本不需要检查玩家 X 是否先下，因为就目前而言，只需要让 nextPlayer() 返回 X 就能让测试释通过。

在 TicTacToe 类中添加 nextPlayer() 方法。

public char nextPlayer() {
 return 'X';
}

** 执行测试用例1 检查它是否运行通过。

测试用例2

现在需要确保让玩家轮流下，玩家 X 下棋后，应轮到玩家 O，然后再轮到玩家 X，以此类推：

TDD实战（四）“井字游戏” 需求三

Mon, 08 Jan 2018 12:50:11 +0800

需求3

现在考虑这个游戏的获胜规则，这部分工作会比较麻烦。我们必须检查所可能获胜的情况，只要满足其中一个，就宣布相应玩家获胜。

最先在水平、锤直或对角线上将自己的3个标记连起来的玩家获胜。

测试用例1

首先定义play() 的默认返回值：


@Test
public void whenPlayThenNoWinner(){
 String actual = ticTacToe.play(1,1);
 assertEquals("No winner", actual);
}

如果不满足获胜条件，则无人获胜。

实现代码1

这个用例很容易满足，修改 play() 方法如下：


public String play(int x, int y){
 checkAxis(x);
 checkAxis(y);
 setBox(x, y);
 lastPlayer = nextPlayer();
 return "No winner";
}

** 执行测试用例1 检查它是否运行通过。

测试用例2

处理各种获胜条件。

@Test
public void whenPlayAndWholeHorizontalLineThenWinner(){
 ticTacToe.play(1,1); //X
 ticTacToe.play(1,2); //O
 ticTacToe.play(2,1); //X
 ticTacToe.play(2,2); //O
 String actual = ticTacToe.play(3, 1); //X
 assertEquals("X is the winner", actual);
}

X 玩家最新占满一条水平线，所以 X 玩家获胜。

TDD实战（五）“井字游戏” 需求三

Mon, 08 Jan 2018 12:45:11 +0800

需求3

继续实现需求3，检查所可能获胜的情况，只要满足其中一个，就宣布相应玩家获胜。

最先在水平、锤直或对角线上将自己的3个标记连起来的玩家获胜。

测试用例1

现在我们检查是否有垂直线完全被某个玩家占据。

@Test
public void whenPlayAndWholeVerticalLineThenWinner(){
 ticTacToe.play(2,1); //X
 ticTacToe.play(1,1); //O
 ticTacToe.play(3,1); //X
 ticTacToe.play(1,2); //O
 ticTacToe.play(2,2); //O
 String actual = ticTacToe.play(1,3); //O
 assertEquals("O is the winner", actual);
}

一个玩家的棋子占据整条垂直线就赢了。

实现代码1

这个实现和前面一个类似，前面在水平方向上做检查，现在需要在垂直方向上做同样的检查。

private boolean isWin(){
 int playerTotal = lastPlayer * 3;

 for(int i = 0; i < SIZE; i++){
 if(board[0][i] + board[1][i] + board[2][i] == playerTotal){
 return true;
 }else if(board[i][0] + board[i][1] + board[i][2] == playerTotal){
 return true;
 }
 }
 return false;
}

** 执行测试用例1 检查它是否运行通过。

TDD实战（六）“井字游戏” 需求四

Mon, 08 Jan 2018 12:40:11 +0800

需求4

如果出现平局如何处理。

所有格子都占满则为平局。

测试用例1

可以通过填满棋盘的所有格子测试平局结果。

@Test
public void whenAllBoxesAreFilledThenDraw(){
 ticTacToe.play(1,1); //X
 ticTacToe.play(1,2); //O
 ticTacToe.play(1,3); //X
 ticTacToe.play(2,1); //O
 ticTacToe.play(2,3); //X
 ticTacToe.play(2,2); //O
 ticTacToe.play(3,1); //X
 ticTacToe.play(3,3); //O
 String actual = ticTacToe.play(3,2); //X
 assertEquals("The result is draw", actual);
}

实现测试1

检查是否为平局非常简单 — 只需要检查是否已占满整个棋盘，所以，可以通过遍历数组board实现。

public String play(int x, int y){
 checkAxis(x);
 checkAxis(y);
 lastPlayer = nextPlayer();
 setBox(x, y, lastPlayer);
 if(isWin()){
 return lastPlayer + " is the winner";
 }else if(isDraw()){
 return "The result is draw";
 }else {
 return "No winner";
 }
}

private boolean isDraw(){
 for(int x = 0; x < SIZE; x++){
 for(int y = 0; y < SIZE; y++){
 if(board[x][y] == '\0'){
 return false;
 }
 }
 }
 return true;
}

** 执行测试用例1 检查它是否运行通过。

TDD实战（七）Jacoco 代码覆盖率

Mon, 08 Jan 2018 12:35:11 +0800

最后一节，和TDD没有直关系，我这里要介绍代码覆盖率工具 Jacoco 。

安装 Jacoco

由于整个TDD项目由 Gradle构建，所以在build.gradle文件中添加 Jacoco 插件。

group 'org.tdd.sample'
version '1.0-SNAPSHOT'

apply plugin: 'java'
apply plugin: "jacoco" //Jacoco 插件

sourceCompatibility = 1.8

repositories {
 mavenCentral()
}

dependencies {
 testCompile group: 'junit', name: 'junit', version: '4.12'
}

运行测试

切换到TDD 项目目录。执行：

TDD > gradle clean test jacocoTestReport

BUILD SUCCESSFUL in 2s
5 actionable tasks: 5 executed

测试报告

在项目...\TDD\build\reports\jacoco\test\html目录下生成index.html报告，通过浏览器打开。