Junit5系列-Junit5中DisabledCondition条件测试执行

洋仔聊编程

发布于 2019-01-15 16:28:12

1.5K0

发布于 2019-01-15 16:28:12

简介

JUnit Jupiter中的ExecutionCondition扩展API允许开发人员以编程方式启用或禁用容器或测试。这种情况最简单的例子是内置的DisabledCondition，它支持 @Disabled注释，也就是@Disabled注解介绍博文。

除了@Disabled之外，JUnit Jupiter还支持 org.junit.jupiter.api.condition类中的其他几个注解去允许开发人员以注解声明的方式启用或禁用容器和测试的条件包。

下面介绍的所有注解也可以作为元注解使用，以便用来创建自定义注解。

例如，演示中的@TestOnMac注解就是将@Test和@EnabledOnOs结合在一个单独的、可重用的注解中。

规定操作系统条件

可以通过@EnabledOnOs和@DisabledOnOs注解在特定操作系统上启用或禁用容器或测试。

下面为demo，其中的每个断言方法的作用，根据注解名几乎就可以知道了：

@Test
@EnabledOnOs(MAC)
void onlyOnMacOs() {
    // ...
}

@TestOnMac
void testOnMac() {
    // ...
}

@Test
@EnabledOnOs({ LINUX, MAC })
void onLinuxOrMac() {
    // ...
}

@Test
@DisabledOnOs(WINDOWS)
void notOnWindows() {
    // ...
}

正如上述所说，其中@TestOnMac这个注解，就是根据已经有的注解作为元注解，组合而成的新注解，其源码为：

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.EnabledOnOs;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import static org.junit.jupiter.api.condition.OS.MAC;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Test
@EnabledOnOs(MAC)
public @interface TestOnMac {
}

规定Java 运行环境条件

可以通过@EnabledOnJre和@DisabledOnJre注解在特定版本的Java运行时环境（JRE）上启用或禁用容器或测试。

@Test
@EnabledOnJre(JAVA_8)
void onlyOnJava8() {
    // ...
}

@Test
@EnabledOnJre({ JAVA_9, JAVA_10 })
void onJava9Or10() {
    // ...
}

@Test
@DisabledOnJre(JAVA_9)
void notOnJava9() {
    // ...
}

规定系统属性条件

通过 @EnabledIfSystemProperty 和 @DisabledIfSystemProperty 注解，

可以根据命名的JVM系统属性的值启用或禁用容器或测试。

其中通过matches属性提供的值将被解释为正则表达式。

@Test
@EnabledIfSystemProperty(named = "os.arch", matches = ".*64.*")
void onlyOn64BitArchitectures() {
    // ...
}

@Test
@DisabledIfSystemProperty(named = "ci-server", matches = "true")
void notOnCiServer() {
    // ...
}

规定环境变量条件

可以根据底层操作系统中命名的环境变量的值通过 @EnabledIfEnvironmentVariable和 @DisabledIfEnvironmentVariable 注解来启用或禁用容器或测试。

其中通过matches属性提供的值将被解释为正则表达式。

@Test
@EnabledIfEnvironmentVariable(named = "ENV", matches = "staging-server")
void onlyOnStagingServer() {
    // ...
}

@Test
@DisabledIfEnvironmentVariable(named = "ENV", matches = ".*development.*")
void notOnDeveloperWorkstation() {
    // ...
}

规定脚本依赖条件

JUnit Jupiter提供了根据对通过 @EnabledIf 或 @DisabledIf 注释配置的脚本的评估来启用或禁用容器或测试的能力。脚本可以用JavaScript、Groovy或任何其他脚本语言编写，这些脚本语言都支持 JSR 223 定义的Java Scripting API。

注意：这两个注解目前都属于实验性功能，请谨慎使用。

如果脚本的逻辑仅依赖于当前的操作系统、当前的Java运行时环境版本、特定的JVM系统属性或特定的环境变量，则应该考虑使用专门用于此目的的内置注释之一。

@Test // Static JavaScript expression.
@EnabledIf("2 * 3 == 6")
void willBeExecuted() {
    // ...
}

@RepeatedTest(10) // Dynamic JavaScript expression.
@DisabledIf("Math.random() < 0.314159")
void mightNotBeExecuted() {
    // ...
}

@Test // Regular expression testing bound system property.
@DisabledIf("/32/.test(systemProperty.get('os.arch'))")
void disabledOn32BitArchitectures() {
    assertFalse(System.getProperty("os.arch").contains("32"));
}

@Test
@EnabledIf("'CI' == systemEnvironment.get('ENV')")
void onlyOnCiServer() {
    assertTrue("CI".equals(System.getenv("ENV")));
}

@Test // Multi-line script, custom engine name and custom reason.
@EnabledIf(value = {
                "load('nashorn:mozilla_compat.js')",
                "importPackage(java.time)",
                "",
                "var today = LocalDate.now()",
                "var tomorrow = today.plusDays(1)",
                "tomorrow.isAfter(today)"
            },
            engine = "nashorn",
            reason = "Self-fulfilling: {result}")
void theDayAfterTomorrow() {
    LocalDate today = LocalDate.now();
    LocalDate tomorrow = today.plusDays(1);
    assertTrue(tomorrow.isAfter(today));
}

脚本绑定

下面的名称绑定到每个脚本上下文，因此可以在脚本中使用。访问器通过一个简单的 String get(String name) 方法提供对类似地图的结构的访问。

序号	名称	类型	描述
1	systemEnvironment	accessor	操作系统环境变量访问器
2	systemProperty	accessor	JVM系统属性访问器
3	junitConfigurationParameter	accessor	配置参数取值
4	junitDisplayName	String	测试或者容器的展示名称
5	junitTags	Set	测试或者容器的所有标签信息
6	junitUniqueId	String	测试或者容器的唯一标识