使用 JUnit 和 Maven Surefire 插件测试 Java 类

Maven Surefire 插件在 Maven 构建过程的测试阶段或当 test 被指定为 Maven 目标时运行。以下目录结构和最小 pom.xml 文件将配置 Maven 以运行测试。

项目根目录中的目录结构：

─ project_root 
  ├─ pom.xml
  ├─ src
  │  ├─ main
  │  │  └─ java
  │  └─ test
  │     └─ java
  └─ target
     └─ ...

pom.xml 内容：

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>company-app</artifactId>
  <version>0.0.1</version>
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
</project>

在项目的 src/test/java/com/example/app 目录中创建一个名为 PlusTenTest.java 的文件，其中包含以下内容：

package com.example.app;

import static org.junit.Assert.assertEquals;
import org.junit.Test;

public class PlusTenTest {
    
    @Test
    public void incrementTest() {
        int result = PlusTen.increment(10);
        assertEquals("PlusTen.increment(10) result", 20, result);
    }
}

注释 @Test 告诉 JUnit 它应该在 Maven 构建过程的 test 阶段运行 incrementTest() 作为测试。现在在 src/main/java/com/example/app 中创建 PlusTen.java：

package com.example.app;

public class PlusTen {
    public static int increment(int value) {
        return value;
    }
}

通过打开命令提示符，导航到项目的根目录并调用以下命令来运行测试：

mvn -Dtest=com.example.app.PlusTenTest test

Maven 将编译该程序并在 PlusTenTest 中运行测试方法 incrementTest()。测试将失败，并显示以下错误：

...
Tests run: 1, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 0.005 sec <<< FAILURE! - in com.example.app.PlusTenTest
incrementTest(com.example.app.PlusTenTest)  Time elapsed: 0.004 sec  <<< FAILURE!
java.lang.AssertionError: PlusTen.increment(10) result expected:<20> but was:<10>
at org.junit.Assert.fail(Assert.java:88)
at org.junit.Assert.failNotEquals(Assert.java:743)
at org.junit.Assert.assertEquals(Assert.java:118)
at org.junit.Assert.assertEquals(Assert.java:555)
at com.example.app.PlusTenTest.incrementTest(PlusTenTest.java:12)

Results :

Failed tests:   
  PlusTenTest.incrementTest:12 PlusTen.increment(10) result expected:<20> but was:<10>

Tests run: 1, Failures: 1, Errors: 0, Skipped: 0

[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.749 s
[INFO] Finished at: 2016-09-02T20:50:42-05:00
[INFO] Final Memory: 14M/209M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test (default-test) on project app: There are test failures.
...

Maven Surefire 插件在项目目录中创建一个/target/surefire-reports/目录，其中包含文件 com.example.app.PlusTenTest.txt 和 TEST-com.example.app.PlusTenTest.xml，其中包含上面输出开头的错误详细信息。

按照测试驱动的开发模式，修改 PlusTen.java 以使 increments() 方法正常工作：

package com.example.app;

public class PlusTen {
    public static int increment(int value) {
        return value + 10;
    }
}

再次调用该命令：

mvn -Dtest=com.example.app.PlusTenTest test

测试通过：

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.028 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.753 s
[INFO] Finished at: 2016-09-02T20:55:42-05:00
[INFO] Final Memory: 17M/322M
[INFO] ------------------------------------------------------------------------

恭喜！ 你已使用 JUnit 和 Maven Surefire 插件测试了 Java 类。