JUnit5學習之四：按條件執行
阿新 • • 發佈：2021-02-25
### 歡迎訪問我的GitHub
[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)
內容：所有原創文章分類彙總及配套原始碼，涉及Java、Docker、Kubernetes、DevOPS等；
### 關於《JUnit5學習》系列
《JUnit5學習》系列旨在通過實戰提升SpringBoot環境下的單元測試技能，一共八篇文章，連結如下：
1. [基本操作](https://blog.csdn.net/boling_cavalry/article/details/108810587)
2. [Assumptions類](https://blog.csdn.net/boling_cavalry/article/details/108861185)
3. [Assertions類](https://blog.csdn.net/boling_cavalry/article/details/108899437)
4. [按條件執行](https://blog.csdn.net/boling_cavalry/article/details/108909107)
5. [標籤(Tag)和自定義註解](https://blog.csdn.net/boling_cavalry/article/details/108914091)
6. [引數化測試(Parameterized Tests)基礎](https://blog.csdn.net/boling_cavalry/article/details/108930987)
7. [引數化測試(Parameterized Tests)進階](https://blog.csdn.net/boling_cavalry/article/details/108942301)
8. [綜合進階（終篇）](https://blog.csdn.net/boling_cavalry/article/details/108952500)
### 本篇概覽
本文是《JUnit5學習》系列的第四篇，有時咱們希望測試方法僅在一定條件下才執行，例如有的測試方法只適合Linux環境，這就是按條件執行的需求，本篇的主要內容就是學習如何為測試方法設定前提條件，只有滿足了這些條件測試才會被執行，本篇大綱如下：
1. 自定義測試方法的執行順序
2. 按作業系統設定條件
3. 按JAVA環境設定條件
4. 按系統屬性設定條件
5. 按環境變數設定條件
6. 自定義條件
### 原始碼下載
1. 如果您不想編碼，可以在GitHub下載所有原始碼，地址和連結資訊如下表所示：
| 名稱 | 連結 | 備註|
| :-------- | :----| :----|
| 專案主頁| https://github.com/zq2599/blog_demos | 該專案在GitHub上的主頁 |
| git倉庫地址(https)| https://github.com/zq2599/blog_demos.git | 該專案原始碼的倉庫地址，https協議 |
| git倉庫地址(ssh)| [email protected]:zq2599/blog_demos.git | 該專案原始碼的倉庫地址，ssh協議 |
2. 這個git專案中有多個資料夾，本章的應用在junitpractice資料夾下，如下圖紅框所示：
3. junitpractice是父子結構的工程，本篇的程式碼在conditional子工程中，如下圖：
### 自定義測試方法的執行順序
今天要寫的測試方法很多，為了管理好這些方法，在學習按條件執行之前先來看看如何控制測試方法的執行順序：
1. 給測試類添加註解TestMethodOrder，註解的value是OrderAnnotation.class
2. 給每個測試方法新增Order註解，value值是數字，越小的value越優先執行
3. 使用方法如下圖所示：
- 接下來的實戰中，咱們就用上述方法控制測試方法的執行順序；
### 按作業系統設定條件
1. 註解EnabledOnOs指定多個作業系統，只有當前作業系統是其中的一個，測試方法才會執行；
2. 註解DisabledOnOs指定多個作業系統，只要當前作業系統是其中的一個，測試方法就不會執行；
3. 測試程式碼如下：
```java
@Test
@Order(1)
@EnabledOnOs(OS.WINDOWS)
@DisplayName("作業系統：只有windows才會執行")
void onlyWindowsTest() {
assertEquals(2, Math.addExact(1, 1));
}
@Test
@Order(2)
@EnabledOnOs({OS.WINDOWS, OS.LINUX})
@DisplayName("作業系統：windows和linux都會執行")
void windowsORLinuxTest() {
assertEquals(2, Math.addExact(1, 1));
}
@Test
@Order(3)
@DisabledOnOs({OS.MAC})
@DisplayName("作業系統：只有MAC才不會執行")
void withoutMacTest() {
assertEquals(2, Math.addExact(1, 1));
}
```
4. 我這裡是windows作業系統，上述三個方法執行結果如下：
### 按JAVA環境設定條件
1. 註解EnabledOnJre指定多個JRE版本，只有當前JRE是其中的一個，測試方法才會執行；
2. 註解DisabledOnJre指定多個JRE版本，只要當前JRE是其中的一個，測試方法就不會執行；
3. 註解EnabledForJreRange指定JRE版本的範圍，只有當前JRE在此範圍內，測試方法才會執行；
4. 註解DisabledForJreRange指定JRE版本的範圍，只要當前JRE在此範圍內，測試方法就不會執行；
5. 測試程式碼如下：
```java
@Test
@Order(4)
@EnabledOnJre({JRE.JAVA_9, JRE.JAVA_11})
@DisplayName("Java環境：只有JAVA9和11版本才會執行")
void onlyJava9And11Test() {
assertEquals(2, Math.addExact(1, 1));
}
@Test
@Order(5)
@DisabledOnJre({JRE.JAVA_9})
@DisplayName("Java環境：JAVA9不執行")
void withoutJava9Test() {
assertEquals(2, Math.addExact(1, 1));
}
@Test
@Order(6)
@EnabledForJreRange(min=JRE.JAVA_8, max=JRE.JAVA_11)
@DisplayName("Java環境：從JAVA8到1之間的版本都會執行")
void fromJava8To11Test() {
assertEquals(2, Math.addExact(1, 1));
}
```
6. 我這裡是JDK8，執行結果如下：
### 按系統屬性設定條件
1. 註解EnabledIfSystemProperty指定系統屬性的key和期望值(模糊匹配)，只有當前系統有此屬性並且值也匹配，測試方法才會執行；
2. 註解DisabledIfSystemProperty指定系統屬性的key和期望值(模糊匹配)，只要當前系統有此屬性並且值也匹配，測試方法就不會執行；
3. 測試程式碼如下：
```java
@Test
@Order(7)
@EnabledIfSystemProperty(named = "os.arch", matches = ".*64.*")
@DisplayName("系統屬性：64位作業系統才會執行")
void only64BitArch() {
assertEquals(2, Math.addExact(1, 1));
}
@Test
@Order(8)
@DisabledIfSystemProperty(named = "java.vm.name", matches = ".*HotSpot.*")
@DisplayName("系統屬性：HotSpot不會執行")
void withOutHotSpotTest() {
assertEquals(2, Math.addExact(1, 1));
}
```
4. 上述測試方法執行結果如下：
### 按環境變數設定條件
1. 註解EnabledIfEnvironmentVariable指定環境變數的key和期望值(模糊匹配)，只有當前系統有此環境變數並且值也匹配，測試方法才會執行；
2. 註解DisabledIfEnvironmentVariable指定環境變數的key和期望值(模糊匹配)，只要當前系統有此環境變數並且值也匹配，測試方法就不會執行；
3. 測試程式碼如下：
```java
@Test
@Order(9)
@EnabledIfEnvironmentVariable(named = "JAVA_HOME", matches = ".*")
@DisplayName("環境變數：JAVA_HOME才會執行")
void onlyJavaHomeExistsInEnvTest() {
assertEquals(2, Math.addExact(1, 1));
}
@Test
@Order(10)
@DisabledIfEnvironmentVariable(named = "GOPATH", matches = ".*")
@DisplayName("環境變數：有GOPATH就不執行")
void withoutGoPathTest() {
assertEquals(2, Math.addExact(1, 1));
}
```
4. 上述測試方法執行結果如下：
### 自定義條件(從junit5.7版本開始)
1. 前面的條件註解很豐富，但終究是固定、有限的，無法滿足所有場景，它們不夠用時，咱們還可以自定義前提條件，即EnabledIf和DisabledIf註解；
2. 有兩個關鍵點要格外注意，首先是EnabledIf和DisabledIf的package，注意是org.junit.jupiter.api.condition，不要用這個：org.springframework.test.context.junit.jupiter.EnabledIf，一旦用錯，執行測試時會丟擲異常；
3. 第二個要注意的是EnabledIf和DisabledIf對應的junit版本，它們是從5.7版本版本才開始的，而本文用的SpringBoot版本是2.3.4.RELEASE，間接依賴的junit版本是5.6.2，因此，必須在pom.xml中做下圖紅框中的修改，將間接依賴去掉，並主動依賴5.7.0，才能將junit從5.6.2升級到5.7，這樣才能用上EnabledIf和DisabledIf：
4. EnabledIf的用法很簡單，value是個存在的方法的名字，該方法必須返回boolean型別，demo如下，customCondition是個很簡單的方法，被用來做是否執行單元測試的判斷條件：
```java
boolean customCondition() {
return true;
}
@Test
@Order(11)
@EnabledIf("customCondition")
@DisplayName("自定義：customCondition返回true就執行")
void onlyCustomConditionTest() {
assertEquals(2, Math.addExact(1, 1));
}
@Test
@Order(12)
@DisabledIf("customCondition")
@DisplayName("自定義：customCondition返回true就不執行")
void withoutCustomConditionTest() {
assertEquals(2, Math.addExact(1, 1));
}
```
5. 上述測試方法執行結果如下：
6. 前面的程式碼中，EnabledIf和DisabledIf註解被用來修飾方法，其實它們還可以修飾類，用於控制整個類是否執行單元測試，不過修飾類的時候，對應的自定義方法必須是static型別；
7. 前面的程式碼中，customCondition方法和使用它的EnabledIf註解在同一個類中，其實它們也可以在不同的類中，不過此時EnabledIf註解的value要給出：包名、類名、方法名，如下所示，注意類名和方法名之間的連線符是#：
```java
@Test
@Order(12)
@DisabledIf("com.example.Conditions#customCondition")
@DisplayName("自定義：customCondition返回true就不執行")
void withoutCustomConditionTest() {
assertEquals(2, Math.addExact(1, 1));
}
```
- 以上就是常用的按條件執行單元測試的各種例項了，希望本文能給您提供參考，助您在各種場景更加精確的控制用例的執行邏輯；
### 你不孤單，欣宸原創一路相伴
1. [Java系列](https://xinchen.blog.csdn.net/article/details/105068742)
2. [Spring系列](https://xinchen.blog.csdn.net/article/details/105086498)
3. [Docker系列](https://xinchen.blog.csdn.net/article/details/105086732)
4. [kubernetes系列](https://xinchen.blog.csdn.net/article/details/105086794)
5. [資料庫+中介軟體系列](https://xinchen.blog.csdn.net/article/details/105086850)
6. [DevOps系列](https://xinchen.blog.csdn.net/article/details/105086920)
### 歡迎關注公眾號：程式設計師欣宸
> 微信搜尋「程式設計師欣宸」，我是欣宸，期待與您一同暢遊Java世界...
[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blo