单元测试工具 TestNG 使用

本文首发于 jaychen.cc
做者 jaychen

写一篇小文，介绍一下 Java 下单元测试工具 TestNG 的使用，代码在 IDEA 环境在编写。

单元测试，顾名思义，对系统中原子性的功能进行测试，通常状况下是单元测试是针对某个功能函数的测试。编写单元测试是系统开发中重要的一环，也是一项科学优雅的装 X 方式。并且，编写单元测试代码并非一件很麻烦的事情，只要稍微学习就能够掌握这项技能。

TestNG 使用

快速体验

在开始以前，须要引入 TestNG 库，使用 maven 直接引入，在 pom.xml 添加依赖

<dependency>
    <groupId>org.testng</groupId>
    <artifactId>testng</artifactId>
    <version>6.8</version>
    <scope>test</scope>
</dependency>复制代码

使用 IDEA 新建一个项目，目录结构以下:

├── pom.xml
├── src
│   ├── main
│   │   ├── java
│   │   └── resources
│   └── test复制代码

新建一个 Demo.java 类，包含以下简单代码

public class Demo {
    public int add(int a, int b) {
        return a + b;
    }

    public int sub(int a, int b) {
        return a - b;
    }
}复制代码

在 IDEA 下使用快捷键 Ctrl + Shift + t 为其生成测试类

这里能够看到，咱们选择了 TestNG 做为单元测试库，IDEA 自动为咱们生成了单元测试类的类名，其命名规则为：被测试类+Test。最后勾选要进行测试的方法，这里我只选择 add 方法。

肯定以后，会在 src/test/java 目录下生成对应的类文件，能够看到已经生成了 DemoTest.java 文件，其内容以下

public class DemoTest {
    @Test
    public void testAdd() throws Exception {

    }
}复制代码

此时，咱们就能够开始编写测试代码。这里，单元测试的目的是为了测试 Demo#add 这个函数的功能是否准确正常，因此咱们在 testAdd 中编写代码

@Test
public void testAdd() throws Exception {
    Demo d = new Demo();
    assertEquals(7, d.add(3, 4));
}复制代码

这里，使用了 assertEquals 进行断言，这句话至关于说：d.add(3,4) 的结果应该是 7，你帮我执行下 add 看看是否是返回 7。好了，一个单元测试的用例完成，以后就能够直接运行该测试方法，能够看到输出以下：

[TestNG] Running:
===============================================
Default Suite
Total tests run: 1, Failures: 0, Skips: 0
===============================================复制代码

代表这个测试经过，函数功能没错。若是咱们把代码改为 assertEquals(d.add(3, 4), 8);，那么就会出现以下提示

Expected :8
Actual   :7
 <Click to see difference>


    at org.testng.Assert.fail(Assert.java:94)
    at org.testng.Assert.failNotEquals(Assert.java:494)
    ...........
===============================================
Default Suite
Total tests run: 1, Failures: 1, Skips: 0
===============================================复制代码

代表 add 方法的返回结果和指望的不一样，方法可能存在 bug。

这里要注意一个问题，上面咱们对 add 进行一次测试经过，不表明 add 方法就不存在 bug。assertEquals(d.add(3, 4), 7); 只是一个测试用例。这里要理清一个概念：为 add 函数编写了一个单元测试函数 testAdd，以后咱们须要使用多个测试用例来测试 add 函数是否存在 bug。为了证实 add 没有 bug，须要考虑全部可能的状况，包括 输入为0，输入的 a，b 参数为负数 等等尽可能的覆盖全部可能性。因此一个严谨的测试应该以下：

@Test
public void testAdd() throws Exception {
    Demo d = new Demo();
    assertEquals(d.add(3, 4), 7);
    assertEquals(d.add(-3, 4), 1);
    assertEquals(d.add(-3, -4), -7);
    assertEquals(d.add(0, 4), 4);
    assertEquals(d.add(0, 0), 0);
}复制代码

高级用法

上面的例子只是简单用法，旨在让初学者能够快速上手了解 TestNG 的 用法，下面介绍一些高级用法来帮助咱们更好的进行单元测试。

@BeforeClass/@AfterClass 和 @BeforeMethod/@AfterMethod

除了 @Test 注解，TestNG 还有两对经常使用的注解：@BeforeClass/@AfterClass 和 @BeforeMethod/@AfterMethod。这些注解的关系以下图：

从上图能够看出，@BeforeMethod/@AfterMethod 是在 @Test 注解函数执行以前/以后执行的钩子函数。在执行每个 @Test 注解函数执行以前/以后都会执行 @BeforeMethod/@AfterMethod 注解函数。

@BeforeClass/@AfterClass 的做用和 @BeforeMethod/@AfterMethod 相似，不一样的是，@BeforeClass/@AfterClass 是在初始化类的时候执行，这就意味着 @BeforeClass/@AfterClass 只会执行一次，而 @BeforeMethod/@AfterMethod 执行次数和 @Test 注解函数个数同样。

public class DemoTest {

    @BeforeClass
    public static void beforeClass() {
        System.out.println("before test....");
    }

    @BeforeMethod
    public void beforeTest() {
        System.out.println("before test...");
    }

    @Test
    public void testAdd() {

        int res = new Dao().add(1, 2);
        Assert.assertEquals(res, 3);
    }

    @Test
    public void testSub() {
        int res = new Dao().sub(1, 2);
        Assert.assertEquals(res, -1);
    }

    @AfterMethod
    public void afterTest() {
        System.out.println("after test....");
    }

    @AfterClass
    public static void afterClass() {
        System.out.println("after class....");
    }
}复制代码

执行上面的代码，能够看到 beforeClass/afterClass 只执行一次，而 beforeMethod/afterMethod 执行了两次。

这里还须要提一点：@BeforeClass/@AfterClass 注解的函数必须使用 static 修饰。

除了使用 assertEquals 断言函数测试结果以外，TestNG 还提供了一些额外的测试状况。

超时测试

在 @Test 注解中添加 timeOut 参数就能够进行超时测试，@Test(timeOut=10) 表示测试方法的运行时间应该低于 10ms，若是超时者测试失败。超时测试对于网络链接类的测试至关有用。超时测试具体用法以下

@Test(timeOut = 1)
public void testSub() {
    int i =0;
    while (i < 1000000000) {
        i++;
    }
}复制代码

异常测试

异常测试用于测试方法是否有抛出异常，经过 @Test(expected=NullPointerException.class) 来指定方法必须抛出 NullPointerException，若是没有抛出异常或者抛出其余异常则测试失败。

@Test(expectedExceptions = NullPointerException.class)
public void testSub() {
    throw new  NullPointerException();
}复制代码

依赖测试

有时候须要测试方法按照一个特定的顺序被调用，这个时候须要使用 @Test 注解的 dependsOnMethods 参数来指定依赖方法和方法的执行顺序

// test1 执行以前会先执行 test2， test3
@Test(dependsOnMethods = {"test2","test3"})
public void test1(){

}
@Test
public void test2(){

}
@Test
public void test3(){

}复制代码

好了，TestNg 的使用就到这里了，其实单元测试并非一件麻烦的事情，花上一些时间学习一下很快就很上手。过了 TestNg 下次说下 Mockito 的使用。