JUnit 5 @RepeatedTest注解示例

使用JUnit 5 @RepeatedTest注解可以编写可重复运行的测试模板,这些模板可以多次运行。可以将频率配置为@RepeatedTest注解的参数。

1. @RepeatedTest注解用法

要创建可重复的测试模板方法,请使用注解该方法@RepeatedTest

@DisplayName("Add operation test")
@RepeatedTest(5)
void addNumber(TestInfo testInfo) {
    Calculator calculator = new Calculator();
    Assertions.assertEquals(2, calculator.add(1, 1), "1 + 1 should equal 2");
}

在上面的代码中,addNumber()测试将重复5次。

请注意,每次重复测试的行为都类似于常规@Test方法的执行,并且完全支持相同的生命周期回调和扩展。这意味着对于每个单独的调用@BeforeEach,带@AfterEach注解的方法将在适合测试生命周期的位置被调用。

package com.how2codex.junit5.examples;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.RepeatedTest;
import org.junit.jupiter.api.RepetitionInfo;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestInfo;
import org.junit.platform.runner.JUnitPlatform;
import org.junit.runner.RunWith;
@RunWith(JUnitPlatform.class)
public class RepeatedTestExample {
    
    @BeforeAll
    public static void init(){
        System.out.println("Before All init() method called");
    }
    
    @BeforeEach
    public void initEach(){
        System.out.println("Before Each initEach() method called");
    }
    @DisplayName("Add operation test")
    @RepeatedTest(5)
    void addNumber(TestInfo testInfo, RepetitionInfo repetitionInfo)
    {
        System.out.println("Running addNumber test -> " + repetitionInfo.getCurrentRepetition());
        Assertions.assertEquals(2, Calculator.add(1, 1), "1 + 1 should equal 2");
    }
    
    @AfterEach
    public void cleanUpEach(){
        System.out.println("After Each cleanUpEach() method called");
    }
    
    @AfterAll
    public static void cleanUp(){
        System.out.println("After All cleanUp() method called");
    }
}

上面程序的输出:

在所有init()方法之前

在每个调用initEach()方法之前
在每个cleanUpEach()方法之后

在每个调用initEach()方法之前
运行addNumber测试-> 1
在每个cleanUpEach()方法之后

在每个调用initEach()方法之前
运行addNumber测试-> 2
在每个cleanUpEach()方法之后

在每个调用initEach()方法之前
运行addNumber测试-> 3
在每个cleanUpEach()方法之后

在每个调用initEach()方法之前
运行addNumber测试-> 4
在每个cleanUpEach()方法之后

在每个调用initEach()方法之前
运行addNumber测试-> 5
在每个cleanUpEach()方法之后

在所有cleanUp()方法之后

2.自定义显示测试名称

除了指定重复次数之外,您还可以为每个重复次数指定一个自定义显示名称。此自定义显示名称可以是静态文本+动态占位符的组合。当前,支持3个占位符:

  • {displayName}:显示@RepeatedTest方法的名称。
  • {currentRepetition}:当前的重复计数。
  • {totalRepetitions}:重复总数。
@RunWith(JUnitPlatform.class)
public class JUnit5AnnotationsExample
{
    @DisplayName("Add operation test")
    @RepeatedTest(value = 5, name = "{displayName} - repetition {currentRepetition} of {totalRepetitions}")
    void addNumber(TestInfo testInfo) {
        Assertions.assertEquals(2, Calculator.add(1, 1), "1 + 1 should equal 2");
    }
}

运行以上测试将在下面输出:

JUnit 5重复测试显示名称
JUnit 5重复测试显示名称

您可以使用两种预定义格式之一,即RepeatedTest.LONG_DISPLAY_NAMERepeatedTest.SHORT_DISPLAY_NAMESHORT_DISPLAY_NAME如果未指定,则为默认格式。

  • RepeatedTest.LONG_DISPLAY_NAME – {displayName} :: :: {totalRepetitions}的重复{currentRepetition}
  • RepeatedTest.SHORT_DISPLAY_NAME – {totalRepetitions}的重复{currentRepetition}
@DisplayName("Add operation test")
@RepeatedTest(value = 5, name = RepeatedTest.LONG_DISPLAY_NAME)
void addNumber(TestInfo testInfo) {
    Assertions.assertEquals(2, Calculator .add(1, 1), "1 + 1 should equal 2");
}

3. RepetitionInfo接口

RepetitionInfo用于注入约一个重复测试的当前重复成信息@RepeatedTest@BeforeEach@AfterEach方法。

@RunWith(JUnitPlatform.class)
public class JUnit5AnnotationsExample {
    
    @BeforeEach
    public void initEach(RepetitionInfo info){
        int currentRepetition = info.getCurrentRepetition();
        int totalRepetitions = info.getTotalRepetitions();
        //Use information as needed
    }
    @DisplayName("Add operation test")
    @RepeatedTest(value = 5, name="{displayName} :: repetition {currentRepetition} of {totalRepetitions}")
    void addNumber(TestInfo testInfo) {
        Calculator calculator = new Calculator();
        Assertions.assertEquals(2, calculator.add(1, 1), "1 + 1 should equal 2");
    }
    
    @AfterEach
    public void cleanUpEach(RepetitionInfo info){
        int currentRepetition = info.getCurrentRepetition();
        int totalRepetitions = info.getTotalRepetitions();
        //Use information as needed
    }
}

如果您有任何疑问,请在评论区留言,我会一一解答。

学习愉快!

saigon has written 1440 articles

Leave a Reply