JUnit 5 中 @RepeatedTest 的指南
上次更新:2024 年 1 月 8 日
1. 概述
在这篇快速的文章中,我们将研究 JUnit 5 中引入的 @RepeatedTest 注解。它提供了一种强大的方法来编写我们想要重复多次的任何测试。
如果您想了解更多关于 JUnit 5 的信息,请查看我们的其他文章 解释基础知识 和 JUnit 5 指南。
2. Maven 依赖和设置
首先需要注意的是,JUnit 5 需要 Java 8 才能运行。让我们看一下 Maven 依赖
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<version>5.11.0-M2</version>
<scope>test</scope>
</dependency>
这是我们需要添加到我们的测试中使用的主要 JUnit 5 依赖项。请在这里查看该工件的最新版本。
3. 一个简单的 @RepeatedTest 示例
创建一个重复测试很简单——只需将 @RepeatedTest 注解放在测试方法之上
@RepeatedTest(3)
void repeatedTest(TestInfo testInfo) {
System.out.println("Executing repeated test");
assertEquals(2, Math.addExact(1, 1), "1 + 1 should equal 2");
}
请注意,我们没有使用标准的 @Test 注解,而是使用 @RepeatedTest 注解来进行单元测试。上面的测试将被执行三次,就像编写了三次相同的测试一样。
测试报告(报告文件或 IDE 的 JUnit 选项卡中的结果)将显示所有执行情况
repetition 1 of 3(repeatedTest(TestInfo))
repetition 2 of 3(repeatedTest(TestInfo))
repetition 3 of 3(repeatedTest(TestInfo))
4. 设置 failureThreshold
JUnit Jupiter 版本 5.10 引入了 failureThreshold 作为 @RepeatedTest 注解的属性。 它可以帮助我们设置测试重复失败的次数,然后自动跳过剩余的重复。
值得注意的是,默认值为 Integer.MAX_VALUE。此外,失败阈值必须是一个正整数,并且小于重复值。
此外,重复测试在测试可能偶尔由于系统测试的随机性或不稳定性而失败时非常有用。 对于一个不稳定的测试,单次失败就足以跳过剩余的重复。
这是一个示例代码,用于测试随机性,并在测试失败两次时跳过剩余的重复
@RepeatedTest(value = 10, failureThreshold = 2)
void whenGeneratingRandomNumber_thenNumberShouldBeWithinRange() {
int number = random.nextInt(10);
assertTrue(number < 8);
}
在上面的代码中,我们随机生成一个介于零和九之间的整数。然后,我们断言生成的数字小于八。 此外,我们将重复值设置为十,并将failureThreshold 设置为二。 这意味着我们的测试将被重复最多十次,并且一旦有两个重复失败,就会停止
如果没有阈值的重复测试,只要至少有一个重复失败就会失败。 该阈值确保测试尽早失败,并且当我们已经知道整个测试将失败时,不会执行额外的重复。
5. @RepeatedTest 的生命周期支持
@RepeatedTest 的每次执行都将像一个普通的 @Test 一样,并具有完整的 JUnit 测试生命周期支持。这意味着,在每次执行期间,将调用@BeforeEach 和 @AfterEach 方法。 要演示这一点,请在测试类中添加适当的方法
@BeforeEach
void beforeEachTest() {
System.out.println("Before Each Test");
}
@AfterEach
void afterEachTest() {
System.out.println("After Each Test");
System.out.println("=====================");
}
如果我们运行之前的测试,结果将在控制台上显示
Before Each Test
Executing repeated test
After Each Test
=====================
Before Each Test
Executing repeated test
After Each Test
=====================
Before Each Test
Executing repeated test
After Each Test
=====================
正如我们所看到的,@BeforeEach 和 @AfterEach 方法在每次执行周围被调用。
6. 配置测试名称
在第一个例子中,我们观察到测试报告的输出不包含任何标识符。这可以通过name属性进一步配置
@RepeatedTest(value = 3, name = RepeatedTest.LONG_DISPLAY_NAME)
void repeatedTestWithLongName() {
System.out.println("Executing repeated test with long name");
assertEquals(2, Math.addExact(1, 1), "1 + 1 should equal 2");
}
输出现在将包含方法名称以及重复索引
repeatedTestWithLongName() :: repetition 1 of 3(repeatedTestWithLongName())
repeatedTestWithLongName() :: repetition 2 of 3(repeatedTestWithLongName())
repeatedTestWithLongName() :: repetition 3 of 3(repeatedTestWithLongName())
另一个选项是使用RepeatedTest.SHORT_DISPLAY_NAME, 这将生成测试的简短名称
repetition 1 of 3(repeatedTestWithShortName())
repetition 2 of 3(repeatedTestWithShortName())
repetition 3 of 3(repeatedTestWithShortName())
但是,如果我们确实需要使用我们自定义的名称,这是完全可行的
@RepeatedTest(value = 3, name = "Custom name {currentRepetition}/{totalRepetitions}")
void repeatedTestWithCustomDisplayName(TestInfo testInfo) {
assertEquals(2, Math.addExact(1, 1), "1 + 1 should equal 2");
}
{currentRepetition} 和 {totalRepetitions} 是当前重复次数和总重复次数的占位符。这些值由 JUnit 在运行时自动提供,不需要额外的配置。输出结果与我们预期的基本一致
Custom name 1/3(repeatedTestWithCustomDisplayName())
Custom name 2/3(repeatedTestWithCustomDisplayName())
Custom name 3/3(repeatedTestWithCustomDisplayName())
7. 访问RepetitionInfo
除了name属性之外,JUnit 还提供对测试代码中重复元数据的访问。这是通过将RepetitionInfo参数添加到我们的测试方法来实现的
@RepeatedTest(3)
void repeatedTestWithRepetitionInfo(RepetitionInfo repetitionInfo) {
System.out.println("Repetition #" + repetitionInfo.getCurrentRepetition());
assertEquals(3, repetitionInfo.getTotalRepetitions());
}
输出将包含每次执行的当前重复索引
Repetition #1
Repetition #2
Repetition #3
RepetitionInfo 由RepetitionInfoParameterResolver提供,并且仅在@RepeatedTest的上下文中可用。
8. 结论
在本快速教程中,我们探讨了 JUnit 提供的@RepeatedTest 注解,并学习了配置它的不同方法。
支持本文的代码可在 GitHub 上获取。 一旦你以 Baeldung Pro 会员 身份登录,就开始学习并在项目上进行编码。















