JUnit5学习之四：按条件执行 (2)

按系统属性设置条件

注解EnabledIfSystemProperty指定系统属性的key和期望值(模糊匹配)，只有当前系统有此属性并且值也匹配，测试方法才会执行；

注解DisabledIfSystemProperty指定系统属性的key和期望值(模糊匹配)，只要当前系统有此属性并且值也匹配，测试方法就不会执行；

测试代码如下：

@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)); }

上述测试方法执行结果如下：

按环境变量设置条件

注解EnabledIfEnvironmentVariable指定环境变量的key和期望值(模糊匹配)，只有当前系统有此环境变量并且值也匹配，测试方法才会执行；

注解DisabledIfEnvironmentVariable指定环境变量的key和期望值(模糊匹配)，只要当前系统有此环境变量并且值也匹配，测试方法就不会执行；

测试代码如下：

@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)); }

上述测试方法执行结果如下：

自定义条件(从junit5.7版本开始)

前面的条件注解很丰富，但终究是固定、有限的，无法满足所有场景，它们不够用时，咱们还可以自定义前提条件，即EnabledIf和DisabledIf注解；

有两个关键点要格外注意，首先是EnabledIf和DisabledIf的package，注意是org.junit.jupiter.api.condition，不要用这个：org.springframework.test.context.junit.jupiter.EnabledIf，一旦用错，执行测试时会抛出异常；

第二个要注意的是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是个很简单的方法，被用来做是否执行单元测试的判断条件：

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)); }

上述测试方法执行结果如下：

6. 前面的代码中，EnabledIf和DisabledIf注解被用来修饰方法，其实它们还可以修饰类，用于控制整个类是否执行单元测试，不过修饰类的时候，对应的自定义方法必须是static类型；
7. 前面的代码中，customCondition方法和使用它的EnabledIf注解在同一个类中，其实它们也可以在不同的类中，不过此时EnabledIf注解的value要给出：包名、类名、方法名，如下所示，注意类名和方法名之间的连接符是#：

@Test @Order(12) @DisabledIf("com.example.Conditions#customCondition") @DisplayName("自定义：customCondition返回true就不执行") void withoutCustomConditionTest() { assertEquals(2, Math.addExact(1, 1)); }