JUnit 5 指南

1. 概述

JUnit 是 Java 生态系统中最为流行的单元测试框架之一。 JUnit 5 版本包含许多令人兴奋的创新，目标是支持 Java 8 及以上版本的新特性，并支持多种不同的测试风格。

2. Maven 依赖

设置 JUnit 5.x.0 相当简单；我们只需要将以下依赖项添加到我们的pom.xml

<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-engine</artifactId>
    <version>5.11.0-M2</version>
    <scope>test</scope>
</dependency>

此外，现在可以直接在 Eclipse 以及 IntelliJ 中运行 JUnit Platform 上的单元测试。当然，我们也可以使用 Maven Test 目标来运行测试。

另一方面，IntelliJ 默认支持 JUnit 5。因此，在 IntelliJ 上运行 JUnit 5 相当容易。我们只需右键单击 -> 运行，或 Ctrl-Shift-F10。

重要的是要注意，此版本需要 Java 8 才能工作。

3. 架构

JUnit 5 包含来自三个不同子项目的几个不同的模块。

3.1. JUnit Platform

该平台负责在 JVM 上启动测试框架。它定义了 JUnit 及其客户端之间（例如构建工具）的稳定且强大的接口。

该平台可以轻松地将客户端与 JUnit 集成，以发现和执行测试。

它还定义了 TestEngine API，用于开发在 JUnit 平台运行的测试框架。 通过实现自定义 TestEngine，我们可以将第三方测试库直接插入 JUnit。

3.2. JUnit Jupiter

该模块包括用于在 JUnit 5 中编写测试的新编程和扩展模型。与 JUnit 4 相比，新的注释有

• @TestFactory – 表示该方法是动态测试的测试工厂
• @DisplayName – 定义测试类或测试方法的自定义显示名称
• @Nested – 表示注释的类是一个嵌套的非静态测试类
• @Tag – 声明用于过滤测试的标签
• @ExtendWith – 注册自定义扩展
• @BeforeEach – 表示注释的方法将在每个测试方法之前执行（先前为@Before）
• @AfterEach – 表示注释的方法将在每个测试方法之后执行（先前为@After）
• @BeforeAll – 表示注释的方法将在当前类中的所有测试方法之前执行（先前为@BeforeClass）
• @AfterAll – 表示注释的方法将在当前类中的所有测试方法之后执行（先前为@AfterClass）
• @Disabled – 禁用测试类或方法（先前为@Ignore）

3.3. JUnit Vintage

JUnit Vintage 支持在 JUnit 5 平台上运行基于 JUnit 3 和 JUnit 4 的测试。

4. 基本注释

为了讨论新的注释，我们将本节分为以下负责执行的组：测试之前、测试期间（可选）和测试之后

4.1. @BeforeAll 和 @BeforeEach

下面是将在主测试用例之前执行的简单代码示例

@BeforeAll
static void setup() {
    log.info("@BeforeAll - executes once before all test methods in this class");
}

@BeforeEach
void init() {
    log.info("@BeforeEach - executes before each test method in this class");
}

需要注意的是，带有 @BeforeAll 注解的方法需要是静态的，否则代码将无法编译。

4.2. @DisplayName 和 @Disabled

现在让我们来看新的可选测试方法

@DisplayName("Single test successful")
@Test
void testSingleSuccessTest() {
    log.info("Success");
}

@Test
@Disabled("Not implemented yet")
void testShowSomething() {
}

正如我们所见，我们可以使用新的注解来更改方法的显示名称或禁用该方法，使用注释进行标记。

4.3. @AfterEach 和 @AfterAll

最后，让我们讨论与测试执行后操作相关的方法

@AfterEach
void tearDown() {
    log.info("@AfterEach - executed after each test method.");
}

@AfterAll
static void done() {
    log.info("@AfterAll - executed after all test methods.");
}

请注意，带有 @AfterAll 注解的方法也需要是静态方法。

5. 断言和假设

JUnit 5 试图充分利用 Java 8 的新特性，特别是 lambda 表达式。

5.1. 断言

断言已移动到 org.junit.jupiter.api.Assertions, 并且得到了显著改进。如前所述，我们现在可以在断言中使用 lambda 表达式

@Test
void lambdaExpressions() {
    List numbers = Arrays.asList(1, 2, 3);
    assertTrue(numbers.stream()
      .mapToInt(Integer::intValue)
      .sum() > 5, () -> "Sum should be greater than 5");
}

虽然上面的例子很简单，但使用 lambda 表达式进行断言消息的一个优点是它被惰性求值，如果消息构建成本很高，可以节省时间和资源。

现在也可以使用 assertAll() 对断言进行分组，这将使用 MultipleFailuresError 报告组内的任何失败断言

 @Test
 void groupAssertions() {
     int[] numbers = {0, 1, 2, 3, 4};
     assertAll("numbers",
         () -> assertEquals(numbers[0], 1),
         () -> assertEquals(numbers[3], 3),
         () -> assertEquals(numbers[4], 1)
     );
 }

这意味着现在可以更安全地进行更复杂的断言，因为我们将能够精确定位任何故障的位置。

5.2. 假设

假设用于仅在满足某些条件时运行测试。这通常用于测试的正确运行所必需的外部条件，但这些条件与正在测试的内容没有直接关系。

我们可以使用 assumeTrue()、assumeFalse() 和 assumingThat():声明假设

@Test
void trueAssumption() {
    assumeTrue(5 > 1);
    assertEquals(5 + 2, 7);
}

@Test
void falseAssumption() {
    assumeFalse(5 < 1);
    assertEquals(5 + 2, 7);
}

@Test
void assumptionThat() {
    String someString = "Just a string";
    assumingThat(
        someString.equals("Just a string"),
        () -> assertEquals(2 + 2, 4)
    );
}

如果假设失败，将抛出 TestAbortedException，并且测试将被简单地跳过。

假设也理解 lambda 表达式。

6. 异常测试

JUnit 5 中有两种异常测试方法，我们可以使用 assertThrows() 方法来实现这两种方法

@Test
void shouldThrowException() {
    Throwable exception = assertThrows(UnsupportedOperationException.class, () -> {
      throw new UnsupportedOperationException("Not supported");
    });
    assertEquals("Not supported", exception.getMessage());
}

@Test
void assertThrowsException() {
    String str = null;
    assertThrows(IllegalArgumentException.class, () -> {
      Integer.valueOf(str);
    });
}

第一个示例验证抛出异常的详细信息，第二个示例验证异常的类型。

7. 测试套件

为了继续使用 JUnit 5 的新功能，我们将探讨将多个测试类聚合到测试套件中的概念，以便我们可以一起运行这些类。JUnit 5 提供了两个注解，@SelectPackages 和 @SelectClasses, 来创建测试套件。

请记住，在早期阶段，大多数 IDE 不支持这些功能。

让我们看看第一个

@Suite
@SelectPackages("com.baeldung")
@ExcludePackages("com.baeldung.suites")
public class AllUnitTest {}

@SelectPackage 用于指定运行测试套件时要选择的包的名称。在我们的例子中，它将运行所有测试。第二个注解，@SelectClasses，用于指定运行测试套件时要选择的类

@Suite
@SelectClasses({AssertionTest.class, AssumptionTest.class, ExceptionTest.class})
public class AllUnitTest {}

例如，上面的类将创建一个包含三个测试类的套件。请注意，这些类不必在同一个包中。

8. 动态测试

我们想介绍的最后一个主题是 JUnit 5 的动态测试功能，该功能允许我们在运行时生成和运行测试用例。与在编译时定义固定数量测试用例的静态测试相反，动态测试允许我们在运行时动态定义测试用例。

动态测试可以通过带有 @TestFactory 注解的工厂方法生成。 让我们看一下代码

@TestFactory
Stream<DynamicTest> translateDynamicTestsFromStream() {
    return in.stream()
      .map(word ->
          DynamicTest.dynamicTest("Test translate " + word, () -> {
            int id = in.indexOf(word);
            assertEquals(out.get(id), translate(word));
          })
    );
}

这个例子非常简单易懂。 我们想使用两个 ArrayList，分别命名为 in 和 out，来翻译单词。 工厂方法必须返回一个 Stream、Collection、Iterable 或 Iterator。 在我们的例子中，我们选择了一个 Java 8 Stream。

请注意，@TestFactory 方法不能是私有或静态的。 测试的数量是动态的，并且取决于 ArrayList 的大小。

9. 结论

在本文中，我们快速概述了 JUnit 5 带来的变化。

我们探讨了 JUnit 5 架构的重大变化，以及它与平台启动器、IDE、其他单元测试框架、构建工具的集成等。 此外，JUnit 5 与 Java 8 的集成度更高，特别是与 Lambda 和 Stream 概念的集成。