单元测试工具 TestNG 使用

本文首发于 https://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 的使用。