1、Overview

1.1、Junit5是什么

与以前的JUnit版本不同，JUnit 5是由三个不同子项目的几个不同的模块组成。

JUnit 5 = JUnit Platform（基础平台） + JUnit Jupiter（核心程序） + JUnit Vintage（老版本的支持）

JUnit Platform：是在JVM上启动测试框架（launching testing frameworks）的基础。它还定义了用于开发平台
上运行的测试框架的测试引擎（ TestEngine ）API。此外，该平台还提供了一个控制台启动器（Console
Launcher），可以从命令行启动平台，并为 Gradle 和 Maven 构建插件，以及一个基于JUnit 4的运行器（JUnit 4
based Runner），用于在平台上运行任何 TestEngine 。

JUnit Jupiter：是在JUnit 5中编写测试和扩展的新编程模型（ programming model ）和扩展模型（ extension
model ）的组合。另外，Jupiter子项目还提供了一个TestEngine ，用于在平台上运行基于Jupiter的测试。

JUnit Vintage：提供了一个在平台上运行JUnit 3和JUnit 4的 TestEngine 。

​ 图片来自于网络

1.2、支持的java版本

JUnit 5在运行时需要Java 8(或更高版本)。但是，您仍然可以用老版本JDK编译的代码进行测试。

2、编写Tests

2.1、注解

所有注解在模块junit-jupiter-api的org.junit.jupiter.api包下。

有些注解是实验性质的。Experimental APIs

2.1.1、元注解和注解组合

JUnit Jupiter注解可以用作元注解。这意味着您可以定义自己的组合注解，它将自动继承其元注解的语义。

import org.junit.jupiter.api.Tag;@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Tag("fast")
public @interface Fast {
}@Fast    //自定义组合注解
@Test
void myFastTest() {// ...
}

类似于Spring的注解。

2.2、测试类和测试方法

测试类：任何包含至少一个方法的顶层类，静态成员类，@Nested类。测试类必须是非abstract的，并且有一个构造器。

测试方法：任何直接注解了或者元注解注解了 @Test, @RepeatedTest, @ParameterizedTest, @TestFactory, or @TestTemplate的实例方法。

生命周期（lifecycle）方法：任何直接注解了或者元注解注解了 @BeforeAll, @AfterAll, @BeforeEach, or @AfterEach的方法。

测试方法和生命周期方法可能定义在本类中，从超类继承或从接口继承。另外测试方法和生命周期方法必须是非abstract的，并且不能返回值（@TestFactory除外。）。

Test classes, test methods, and lifecycle methods 不必是 public, 但一定是非 private.

建议忽略public，除非要让其他测试类访问。

标准测试类和测试方法

import static org.junit.jupiter.api.Assertions.fail;
import static org.junit.jupiter.api.Assumptions.assumeTrue;import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;class StandardTests {@BeforeAllstatic void initAll() {}@BeforeEachvoid init() {}@Testvoid succeedingTest() {}@Testvoid failingTest() {fail("a failing test");}@Test@Disabled("for demonstration purposes")void skippedTest() {// not executed}@Testvoid abortedTest() {assumeTrue("abc".contains("Z"));fail("test should have been aborted");}@AfterEachvoid tearDown() {}@AfterAllstatic void tearDownAll() {}}

2.3、显示名称

测试类和测试方法可以通过@DisplayName注解自定义DisplayName（显示名称）。“空格、特殊字符，甚至是表情符号”这些都可以在
测试运行器和测试报告显示出来。

2.3.1、DisplayName生成器

通过注解@DisplayNameGeneration自定义显示名生成器。

可以通过接口DisplayNameGenerator构造生成器。

默认提供的生成器。

@DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class)
@IndicativeSentencesGeneration(separator = " -> ", generator = DisplayNameGenerator.ReplaceUnderscores.class

2.3.2、设置默认Generator

可以在属性文件中通过配置参数junit.jupiter.displayname.generator.default 设置默认Generator，

junit.jupiter.displayname.generator.default = \org.junit.jupiter.api.DisplayNameGenerator$ReplaceUnderscores

优先规则

1. @DisplayName注解
2. @DisplayNameGeneration注解
3. 默认DisplayNameGenerator
4. 调用：org.junit.jupiter.api.DisplayNameGenerator.Standard

2.4、断言

JUnit Jupiter 附带了许多JUnit 4所拥有的断言方法，并添加了一些可以很好地使用Java 8 lambdas的方法。所有的JUnit Jupiter断言都是org.junit.jupiter.Assertions (断言类)中的静态方法。

org.junit.jupiter.api.Assertions.assertAll;
org.junit.jupiter.api.Assertions.assertEquals;
org.junit.jupiter.api.Assertions.assertNotNull;
org.junit.jupiter.api.Assertions.assertThrows;		//抛出异常
org.junit.jupiter.api.Assertions.assertTimeout;		//超时
org.junit.jupiter.api.Assertions.assertTimeoutPreemptively;
org.junit.jupiter.api.Assertions.assertTrue;

assertTimeout：Executable的execute方法执行完成后，再检查execute方法的耗时是否超过预期，这种方法的弊端是必须等待execute方法执行完成才知道是否超时

assertTimeoutPreemptively：方法也是用来检测代码执行是否超时的，但是避免了assertTimeout的必须等待execute执行完成的弊端，避免的方法是用一个新的线程来执行execute方法。假设是XXX线程，当等待时间超过入参timeout的值时，XXX线程就会被中断，并且测试结果是失败。

2.4.1、Kotlin Assertion Suppor

略

2.4.2、第三方断言库

AssertJ,

Hamcrest,

Truth

2.5、Assumptions

假设实际就是指定某个特定条件，假如不能满足假设条件，假设不会导致测试失败，只是终止当前测试。这也是假设与断言的最大区别，因为对于断言而言，会导致测试失败。

JUnit Jupiter 附带了JUnit 4提供的Assumptions（假设）方法的子集，并添加了一些可以很好地使用Java 8 lambdas的方法。所有的JUnit Jupiter假设都是 org.junit.jupiter.Assumptions 类的静态方法。

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assumptions.assumeTrue;
import static org.junit.jupiter.api.Assumptions.assumingThat;import example.util.Calculator;import org.junit.jupiter.api.Test;class AssumptionsDemo {private final Calculator calculator = new Calculator();@Testvoid testOnlyOnCiServer() {assumeTrue("CI".equals(System.getenv("ENV")));// remainder of test}@Testvoid testOnlyOnDeveloperWorkstation() {assumeTrue("DEV".equals(System.getenv("ENV")),() -> "Aborting test: not on developer workstation");// remainder of test}@Testvoid testInAllEnvironments() {//assumption 满足，则会执行后续的executable。assumingThat("CI".equals(System.getenv("ENV")),() -> {// perform these assertions only on the CI serverassertEquals(2, calculator.divide(4, 2));});// perform these assertions in all environmentsassertEquals(42, calculator.multiply(6, 7));}}

2.6、禁用测试

禁用测试类

@Disabled("Disabled until bug #99 has been fixed")
class DisabledClassDemo {@Testvoid testWillBeSkipped() {}}

禁用测试方法

class DisabledTestsDemo {@Disabled("Disabled until bug #42 has been resolved")@Testvoid testWillBeSkipped() {}@Testvoid testWillBeExecuted() {}}

2.7、条件测试执行

ExecutionCondition 扩展接口可以让developer根据条件启用或禁用测试。在包org.junit.jupiter.api.condition中定义了一些基于注解的条件。多个ExecutionCondition被注册，当其中一个返回disabled时，整个测试立即被disabled。每个注解都有disabledReason属性用于指示disabled的原因。

条件注解可以当做元注解。每种条件注解在一个测试上只能使用一次，不论是直接注解，间接注解，元注解。当有多次注解时，只有第一个生效。

2.7.1、Operating System Conditions

@EnabledOnOs、@DisabledOnOs

@Test
@EnabledOnOs(MAC)
void onlyOnMacOs() {// ...
}@TestOnMac
void testOnMac() {// ...
}@Test
@EnabledOnOs({ LINUX, MAC })
void onLinuxOrMac() {// ...
}@Test
@DisabledOnOs(WINDOWS)
void notOnWindows() {// ...
}@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Test
@EnabledOnOs(MAC)
@interface TestOnMac {
}

2.7.2、 Java Runtime Environment Conditions

@EnabledForJreRange、@EnabledOnJre、@DisabledOnJre、@DisabledForJreRange

@Test
@EnabledOnJre(JAVA_8)
void onlyOnJava8() {// ...
}@Test
@EnabledOnJre({ JAVA_9, JAVA_10 })
void onJava9Or10() {// ...
}@Test
@EnabledForJreRange(min = JAVA_9, max = JAVA_11)
void fromJava9to11() {// ...
}@Test
@DisabledOnJre(JAVA_9)
void notOnJava9() {// ...
}@Test
@DisabledForJreRange(min = JAVA_9)
void notFromJava9toCurrentJavaFeatureNumber() {// ...
}

2.7.3、System Property Conditions

@Test
@EnabledIfSystemProperty(named = "os.arch", matches = ".*64.*")
void onlyOn64BitArchitectures() {// ...
}@Test
@DisabledIfSystemProperty(named = "ci-server", matches = "true")
void notOnCiServer() {// ...
}

从 JUnit Jupiter 5.6, @EnabledIfSystemProperty 和@DisabledIfSystemProperty 是可重复注解。

2.7.4、Environment Variable Conditions

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

从 JUnit Jupiter 5.6, @EnabledIfEnvironmentVariable 和@DisabledIfEnvironmentVariable 是可重复注解。

2.7.5、Custom Conditions

根据一个返回值为boolean的方法的返回值禁用或启用测试。

@Test
@EnabledIf("customCondition")
void enabled() {// ...
}@Test
@DisabledIf("customCondition")
void disabled() {// ...
}boolean customCondition() {return true;
}

也可以引用其他类的方法

class ExternalCustomConditionDemo {@Test@EnabledIf("example.ExternalCondition#customCondition")void enabled() {// ...}}class ExternalCondition {static boolean customCondition() {return true;}}

当 @EnabledIf，@DisabledIf注解在类上，引用的方法应该是static的。

2.8、Tagging and Filtering

可以对测试类和方法进行标记。这些标记稍后可以用于过滤 test discovery and execution（测试发现和执行）。

@Tag("fast")
@Tag("model")
class TaggingDemo {@Test@Tag("taxes")void testingTaxCalculation() {}}

2.9、测试执行顺序

在【单元测试的艺术】一书中，作者不建议单元测试之间有顺序依赖。

2.9.1、Method Order

虽然在真正的单元测试中，不建议测试之间有依赖，但是在一些场景需要强制顺序，例如集成测试，功能测试中测试顺序很重要，尤其是和@TestInstance(Lifecycle.PER_CLASS)结合在一起。

为了控制测试方法顺序，可以使用注解@TestMethodOrder或实现MethodOrder接口。

内部集成MethodOrderer实现。

• MethodOrderer.DisplayName: 按DisplayName排序 (see display name generation precedence rules)
• MethodOrderer.MethodName:按方法名称加参数排序
• MethodOrderer.OrderAnnotation: @Order 注解
• MethodOrderer.Random: 随机数值
• MethodOrderer.Alphanumeric: 同MethodOrderer.MethodName; deprecated in favor of MethodOrderer.MethodName, to be removed in 6.0

@TestMethodOrder(OrderAnnotation.class)
class OrderedTestsDemo {@Test@Order(1)void nullValues() {// perform assertions against null values}@Test@Order(2)void emptyValues() {// perform assertions against empty values}@Test@Order(3)void validValues() {// perform assertions against valid values}}

设置默认MethodOrder

属性：junit.jupiter.testmethod.order.default

junit.jupiter.testmethod.order.default = \org.junit.jupiter.api.MethodOrderer$OrderAnnotation

2.9.2、Class Order

为了控制测试类顺序，可以使用注解@TestClassOrder或实现ClassOrder接口。

适用场景：

• “fail fast” 模式：前面失败的测试先执行
• “shortest test plan execution duration” 模式：执行时间长的先执行。
• 其他

内置ClassOrder

• ClassOrderer.ClassName:类名排序
• ClassOrderer.DisplayName: DisplayName排序
• ClassOrderer.OrderAnnotation: @Order annotation
• ClassOrderer.Random: 随机排序

设置默认ClassOrder

属性：junit.jupiter.testclass.order.default

junit.jupiter.testclass.order.default = \org.junit.jupiter.api.ClassOrderer$OrderAnnotation

@TestClassOrder必须放在顶层类上，包括static 嵌套类，@Nested测试类。顶层类的测试顺序是相对的。@Nested测试类是相对于在同一个封闭类中的测试类的。

@TestClassOrder(ClassOrderer.OrderAnnotation.class)
class OrderedNestedTestClassesDemo {@Nested@Order(1)class PrimaryTests {@Testvoid test1() {}}@Nested@Order(2)class SecondaryTests {@Testvoid test2() {}}
}

2.10、测试实例生命周期（Test Instance Lifecycle）

为了隔离地执行单独的测试方法，并且为了避免由于可变测试实例状态而产生的意外副作用，JUnit在执行每个测试方法之前创建了一个新的测试类的实例。这个“per-method”测试实例生命周期是JUnit Jupiter上的默认行为，类似于所有以前的JUnit版本。

如果您希望JUnit Jupiter在同一个测试实例上执行所有的测试方法，只需用@Testinstance(Lifecycle.PER_CLASS)注解您的测试类。当使用此模式时，每个测试类将创建一个新的测试实例。因此，如果您的测试方法依赖于实例变量存储的状态，那么您可能需要在@BeforeEach 或 @AfterEach 方法中重置该状态。

“per-class”模式在默认的“per-method”模式下有一些额外的好处。具体地说，在“per-class”模式下，可以在非静态方法和接口默认方法上声明@BeforeAll 和@AfterAll 。因此，“per-class”模式也使@BeforeAll 和@AfterAll 方法可以在@Nested 测试类中使用。

2.10.1、更改默认的测试实例生命周期（Changing the Default Test Instance Lifecycle）

如果测试类或测试接口没有用@TestInstance 进行注解，JUnit Jupiter 将使用默认的生命周期模式。标准的默认模式是PER_METHOD ;但是，可以更改整个测试计划执行的默认值。改变默认的测试实例的生命周期模式,只需将junit.jupiter.testinstance.lifecycle.default 配置参数设置为TestInstance.Lifecycle 中定义一个枚举常数的名称，名称忽略大小写的情况。这可以作为一个JVM系统属性，在LauncherDiscoveryRequest 中作为配置参数传递给 Launcher ，或者通过JUnit平台配置文件。

-Djunit.jupiter.testinstance.lifecycle.default=per_class

通过JUnit Platform 配置文件设置默认的测试实例生命周期模式是一个更健壮的解决方案，因为配置文件可以与您的项目一起被提交到版本控制系统，因此可以在IDE和您的构建软件中使用

junit.jupiter.testinstance.lifecycle.default = per_class

2.11、Nested Tests

嵌套测试赋予测试者更多的能力来表达几组测试之间的关系。示例：

@DisplayName("A stack")
class TestingAStackDemo {Stack