在 Maven 項目中運行 JUnit 5 測試用例

鏡像下載、域名解析、時間同步請點擊阿里巴巴開源鏡像站

一、編寫JUnit 5測試用例

如果你是Java開發者，那麼對於JUnit應該就不陌生。JUnit是Java單元測試的基礎工具。
JUnit目前最新的版本是JUnit 5.x，為了幫助廣大的Java開發者使用最新版JUnit，接下來將為大家講解如何編寫JUnit 5測試用例。

1. 引入JUnit 5依賴

相比較JUnit 4而言，JUnit 5一個比較大的改變是JUnit 5擁有與JUnit 4不同的全新的API。JUnit 5分成了三部分：

JUnit 5 = JUnit Platform + JUnit Jupiter + JUnit Vintage

JUnit Platform是在JVM上啟動測試框架的基礎。它還定義了TestEngine API，用於開發在平臺上運行的測試框架。此外，該JUnit Platform還提供了一個控制檯啟動器（用於從命令行啟動該平臺）和一個基於JUnit 4的運行器，用於在基於JUnit 4的環境中在該平臺上運行任何TestEngine。流行的IDE（IntelliJ IDEA，Eclipse，NetBeans和Visual Studio Code等）和構建工具（Gradle，Maven和Ant等）中也存在對JUnit平臺的一流支持。
JUnit Jupiter是新編程模型和擴展模型的組合，用於在JUnit 5中編寫測試和擴展。Jupiter子項目提供了一個TestEngine，用於在平臺上運行基於Jupiter的測試。
JUnit Vintage提供了一個TestEngine，用於在平臺上運行基於JUnit 3和基於JUnit 4的測試。

因此，在Maven中，JUnit 5分模塊的，意味著你可以按需引入上面定義的任意模塊。這使得引入JUnit 5依賴就有了多個選擇。
一般而言，力求省事，就可以通過引入junit-jupiter依賴。junit-jupiter就是常用JUnit 5模塊的聚合包。

<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter</artifactId>
    <version>${junit-jupiter.version}</version>
    <scope>test</scope>
</dependency>

2. 編寫測試用例

下面是一段簡單的Java程序：

/**
 * Welcome to https://waylau.com
 */
package com.waylau.java.demo;
/**
 * Hello World.
 * 
 * @since 1.0.0 2020年4月12日
 * @author <a href="https://waylau.com">Way Lau</a>
 */
public class HelloWorld {
    private String words;
    public HelloWorld(String words) {
        this.words = words;
    }
    
    public String getWords() {
        return words;
    }
}

按照管理，我們會在Maven工程的test目錄，創建一個與之對應的單元測試用例：

/**
 * Welcome to https://waylau.com
 */
package com.waylau.java.demo;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
/**
 * HelloWorld Test.
 * 
 * @since 1.0.0 2020年4月12日
 * @author <a href="https://waylau.com">Way Lau</a>
 */
class HelloWorldTests {
    @Test
    void testGetWords() {
        var words = "Hello World";
        var hello = new HelloWorld(words);
        
        assertEquals(words, hello.getWords());
    }
}

上述用例非常簡單，就是想測試下，HelloWorld的getWords方法，是否與預期的一致。
這裡需要強調的是JUnit 5和JUnit 4的不同點：

JUnit 5使用的API是org.junit.jupiter.api.*包下
測試方法（比如上例testGetWords），可以不加public。

二、運行JUnit 5測試用例

上如上文所講，在大多數主流的IDE中，都提供了對JUnit 5的支持。因此可以選擇在IDE中運行，也可以通過Maven執行測試。

1. 在IDE中運行

以Eclipse IDE為例，右鍵類或者方法，選擇“Run As -> JUnit Test”即可。如下圖所示。
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-tONJQN3t-1587044607054)(../images/post/20200412-ide.jpg)]

2. 通過Maven執行測試

在Maven中執行測試用例的命令如下：

mvn test

如果你執行了上述命令，會得到下面的測試結果

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running com.waylau.java.demo.HelloWorldTests
Tests run: 0, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.002 sec
Results :
Tests run: 0, Failures: 0, Errors: 0, Skipped: 0
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.983 s
[INFO] Finished at: 2020-04-12T11:22:16+08:00
[INFO] ------------------------------------------------------------------------

上面結果沒有失敗的用例，但同時你也發現了沒有成功的用例。因為根本沒有執行測試用例。
這是因為，在Maven中並不能直接識別JUnit 5測試用例。如何解決？此時，還需要額外加多Maven Surefire或Maven Failsafe兩個插件。

<build>
    <plugins>
        <plugin>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>${maven-surefire-plugin.version}</version>
        </plugin>
        <plugin>
            <artifactId>maven-failsafe-plugin</artifactId>
            <version>${maven-failsafe-plugin.version}</version>
        </plugin>
    </plugins>
</build>

在Maven中再次執行測試用例，會得到下面的測試結果：

[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running com.waylau.java.demo.HelloWorldTests
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.045 s - in com.waylau.java.demo.HelloWorldTests
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  4.116 s
[INFO] Finished at: 2020-04-12T11:30:29+08:00
[INFO] ------------------------------------------------------------------------

可以看到，HelloWorldTests類已經得到了測試執行。

“ 阿里巴巴開源鏡像站提供全面，高效和穩定的鏡像下載服務。釘釘搜索 ' 21746399 ‘ 加入鏡像站官方用戶交流群。”