devbox
知新_RL
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

JUnit5教程-注解

作者：知新_RL | 2024-06-13 11:13:05

赞

踩

junit5教程

 发表于 2017-10-10 |  分类于 JUnit5 Tutorial

junit5 logo

JUnit5提供的注解

Annotations描述
@BeforeEach在方法上注解，在每个测试方法运行之前执行。
@AfterEach在方法上注解，在每个测试方法运行之后执行
@BeforeAll该注解方法会在所有测试方法之前运行，该方法必须是静态的。
@AfterAll该注解方法会在所有测试方法之后运行，该方法必须是静态的。
@Test用于将方法标记为测试方法
@DisplayName用于为测试类或测试方法提供任何自定义显示名称
@Disable用于禁用或忽略测试类或方法
@Nested用于创建嵌套测试类
@Tag用于测试发现或过滤的标签来标记测试方法或类
@TestFactory标记一种方法是动态测试的测试工场

JUnit5 VS JUnit4

junit5 vs junit4

本图来自Ismael在Slideshare分享的JUnit 5 vs JUnit 4

接下来来我们来一个个注解详细介绍。

@BeforeAll

如[JUnit5 VS JUnit4](#JUnit5 VS JUnit4)图中所示，@BeforeAll是替换JUnit4的@BeforeClass。它用于表示在当前测试类中的所有测试之前应该执行注解的方法。

@BeforeAll使用

@BeforeAll
public void init(){
    System.out.println("Before All init() method called");
}

@BeforeAll注解方法必须是静态方法，否则会抛出运行时错误。

org.junit.platform.commons.JUnitException: @BeforeAll method 'public void com.github.tonydeng.junit5.examples.JUnit5AnnotationsExample.init()' must be static.
at org.junit.jupiter.engine.descriptor.LifecycleMethodUtils.assertStatic(LifecycleMethodUtils.java:66)
at org.junit.jupiter.engine.descriptor.LifecycleMethodUtils.lambda$findBeforeAllMethods$0(LifecycleMethodUtils.java:42)
at java.util.ArrayList.forEach(ArrayList.java:1249)
at java.util.Collections$UnmodifiableCollection.forEach(Collections.java:1080)
at org.junit.jupiter.engine.descriptor.LifecycleMethodUtils.findBeforeAllMethods(LifecycleMethodUtils.java:42)

@BeforeAll示例

我们来举个例子。我使用了一个Calculator类并添加了一个add方法。我将使用@RepeatedTest注解测试它5次。此注解将导致add测试运行5次。但@BeforeAll注解方法只能调用一次。

package com.github.tonydeng.junit5.examples;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.RepeatedTest;
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 JUnit5AnnotationsExample {

    @Test
    @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");
    }

    @BeforeAll
    public static void init(){
        System.out.println("Before All init() method called");
    }
}

计算器类是：

package com.github.tonydeng.junit5.examples;

public class Calculator
{
    public int add(int a, int b) {
        return a + b;
    }
}

现在执行测试，您将在控制台输出下方看到：

Before All init() method called

显然，@BeforeAll注解init()方法只调用一次。

@BeforeEach

如[JUnit5 VS JUnit4](#JUnit5 VS JUnit4)图中所示，@BeforeEach注解是替换JUnit4中的@Before注解。它用于表示@Test在当前类中的每个方法之前应该执行注解方法。

@BeforeEach用法

@BeforeEach
public void initEach(){
    System.out.println("Before Each initEach() method called");
}

@BeforeEach 注解方法不能是静态方法，否则会抛出运行时错误。

org.junit.platform.commons.JUnitException: @BeforeEach method 'public static void com.github.tonydeng.junit5.examples.JUnit5AnnotationsExample.initEach()' must not be static.
    at org.junit.jupiter.engine.descriptor.LifecycleMethodUtils.assertNonStatic(LifecycleMethodUtils.java:73)
    at org.junit.jupiter.engine.descriptor.LifecycleMethodUtils.lambda$findBeforeEachMethods$2(LifecycleMethodUtils.java:54)
    at java.util.ArrayList.forEach(ArrayList.java:1249)
    at java.util.Collections$UnmodifiableCollection.forEach(Collections.java:1080)
    at org.junit.jupiter.engine.descriptor.LifecycleMethodUtils.findBeforeEachMethods(LifecycleMethodUtils.java:54)

@BeforeEach示例

我还是使用之前Calculator类的add方法。我将使用@RepeatedTest注解测试它5次。此注解将导致add测试运行5次。对于每次运行的测试方法，@BeforeEach注解方法也应该每次运行。

package com.github.tonydeng.junit5.examples;

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.Test;
import org.junit.jupiter.api.TestInfo;
import org.junit.platform.runner.JUnitPlatform;
import org.junit.runner.RunWith;

@RunWith(JUnitPlatform.class)
public class JUnit5AnnotationsExample {

    @Test
    @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");
    }

    @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");
    }
}

现在执行测试，您将在控制台输出下方看到：

Before All init() method called
Before Each initEach() method called
Before Each initEach() method called
Before Each initEach() method called
Before Each initEach() method called
Before Each initEach() method called
Before Each initEach() method called

显然，每个测试方法调用调用一次@BeforeEach注解initEach()方法。

@AfterEach

如[JUnit5 VS JUnit4](#JUnit5 VS JUnit4)图中所示，@AfterJUnit注解是替换JUnit4中的@Before注解。它用于表示@Test在当前类中的每个方法之前应该执行注解方法。

@AfterEach注解用法

注解方法@AfterEach如下：

@AfterEach
public void cleanUpEach(){
    System.out.println("After Each cleanUpEach() method called");
}

@AfterEach 注解方法不能是静态方法，否则会抛出运行时错误。

org.junit.platform.commons.JUnitException: @AfterEach method 'public static void com.github.tonydeng.junit5.examples.JUnit5AnnotationsExample.cleanUpEach()' must not be static.
    at org.junit.jupiter.engine.descriptor.LifecycleMethodUtils.assertNonStatic(LifecycleMethodUtils.java:73)
    at org.junit.jupiter.engine.descriptor.LifecycleMethodUtils.lambda$findAfterEachMethods$3(LifecycleMethodUtils.java:60)
    at java.util.ArrayList.forEach(ArrayList.java:1249)
    at java.util.Collections$UnmodifiableCollection.forEach(Collections.java:1080)
    at org.junit.jupiter.engine.descriptor.LifecycleMethodUtils.findAfterEachMethods(LifecycleMethodUtils.java:60)

@AfterEach注解示例

我还是使用之前Calculator类的add方法。我将使用@RepeatedTest注解测试它5次。此注解将导致add测试运行5次。对于每次运行的测试方法，@AfterEach注解方法也应该每次运行。

package com.github.tonydeng.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.DisplayName;
import org.junit.jupiter.api.RepeatedTest;
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 JUnit5AnnotationsExample {

    @Test
    @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");
    }

    @AfterAll
    public static void cleanUp(){
        System.out.println("After All cleanUp() method called");
    }

    @AfterEach
    public void cleanUpEach(){
        System.out.println("After Each cleanUpEach() method called");
    }

}

现在执行测试，您将在控制台输出下方看到：

After Each cleanUpEach() method called
After Each cleanUpEach() method called
After Each cleanUpEach() method called
After Each cleanUpEach() method called
After Each cleanUpEach() method called
After Each cleanUpEach() method called
After All cleanUp() method called

显然，每个测试方法调用调用一次@AfterEach注解cleanUpEach()方法。

@AfterAll

如[JUnit5 VS JUnit4](#JUnit5 VS JUnit4)图中所示，@AfterAll注解是替换JUnit4中的@AfterClass注解。它用于表示在当前测试类中的所有测试后应执行注解方法。

@AfterAll注解使用

注解方法@AfterAll如下：

@AfterAll
public static void cleanUp(){
    System.out.println("After All cleanUp() method called");
}

@AfterAll 注解方法必须是静态方法，否则会抛出运行时错误。

org.junit.platform.commons.JUnitException: @AfterAll method 'public void com.github.tonydeng.junit5.examples.JUnit5AnnotationsExample.cleanUp()' must be static.
    at org.junit.jupiter.engine.descriptor.LifecycleMethodUtils.assertStatic(LifecycleMethodUtils.java:66)
    at org.junit.jupiter.engine.descriptor.LifecycleMethodUtils.lambda$findAfterAllMethods$1(LifecycleMethodUtils.java:48)
    at java.util.ArrayList.forEach(ArrayList.java:1249)
    at java.util.Collections$UnmodifiableCollection.forEach(Collections.java:1080)
    at org.junit.jupiter.engine.descriptor.LifecycleMethodUtils.findAfterAllMethods(LifecycleMethodUtils.java:48)

@AfterAll注解示例

我还是使用之前Calculator类的add方法。我将使用@RepeatedTest注解测试它5次。此注解将导致add测试运行5次。但@AfterAll注解方法只能调用一次。

package com.github.tonydeng.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.DisplayName;
import org.junit.jupiter.api.RepeatedTest;
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 JUnit5AnnotationsExample {

    @Test
    @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");
    }

    @AfterAll
    public static void cleanUp(){
        System.out.println("After All cleanUp() method called");
    }

    @AfterEach
    public void cleanUpEach(){
        System.out.println("After Each cleanUpEach() method called");
    }

}

现在执行测试，您将在控制台输出下方看到：

After Each cleanUpEach() method called
After Each cleanUpEach() method called
After Each cleanUpEach() method called
After Each cleanUpEach() method called
After Each cleanUpEach() method called
After Each cleanUpEach() method called
After All cleanUp() method called

显然，@AfterAll注解cleanUp()方法只调用一次。

@RepeatedTest

JUnit5 @RepeatedTest注解能够编写可重复的测试模板，可以多次运行。频率可以配置为@RepeatedTest注解的参数。

@RepeatedTest注解用法

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

@Test
@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.github.tonydeng.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.Test;
import org.junit.jupiter.api.TestInfo;
import org.junit.platform.runner.JUnitPlatform;
import org.junit.runner.RunWith;

@RunWith(JUnitPlatform.class)
public class JUnit5AnnotationsExample {

    @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");
    }

    @Test
    @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");
        System.out.println("===addNumber testcase executed===");
    }

    @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");
    }
}

以上程序的输出：

Before All init() method called

Before Each initEach() method called
===addNumber testcase executed===
After Each cleanUpEach() method called

Before Each initEach() method called
===addNumber testcase executed===
After Each cleanUpEach() method called

Before Each initEach() method called
===addNumber testcase executed===
After Each cleanUpEach() method called

Before Each initEach() method called
===addNumber testcase executed===
After Each cleanUpEach() method called

Before Each initEach() method called
===addNumber testcase executed===
After Each cleanUpEach() method called

Before Each initEach() method called
===addNumber testcase executed===
After Each cleanUpEach() method called

After All cleanUp() method called

使用@RepeatedTest注解定制显示名称

除了指定重复次数之外，您还可以为每次重复提供自定义显示名称。此自定义显示名称可以是静态文本+动态占位符的组合。目前支持3名占有者：

  • {displayName}：显示@RepeatedTest方法名称。
  • {currentRepetition}：当前重复计数。
  • {totalRepetitions}：重复的总数。
@RunWith(JUnitPlatform.class)
public class JUnit5AnnotationsExample
{
    @Test
    @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");
    }
}

在IDE中运行该测试，将会产生类似下图的运行记录：

RepeatedTest Run results

您可以使用两个预定义的格式之一，即RepeatedTest.LONG_DISPLAY_NAME和RepeatedTest.SHORT_DISPLAY_NAME。SHORT_DISPLAY_NAME是未指定的默认格式。

  • RepeatedTest.LONG_DISPLAY_NAME - {displayName} :: repet {currentRepetition} {totalRepetitions}
  • RepeatedTest.SHORT_DISPLAY_NAME - repetition {currentRepetition} {totalRepetitions}
@Test
@DisplayName("Add operation test")
@RepeatedTest(value = 5, name = RepeatedTest.LONG_DISPLAY_NAME)
void addNumber(TestInfo testInfo) {
    Calculator calculator = new Calculator();
    Assertions.assertEquals(2, calculator.add(1, 1), "1 + 1 should equal 2");
}

使用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
    }

    @Test
    @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
    }
}

到目前为止，整个@RepeatedTest功能处于Experimental状态。将来可以更新甚至删除。

@Disabled

@Disabled注解可用于禁用测试套件的测试方法。此注解可以应用于测试类以及单独的测试方法。

它只接受一个可选参数，指示该测试被禁用的原因。

@Disabled测试类

当@Disabled通过测试类应用时，该类中的所有测试方法也将自动禁用。

import org.junit.jupiter.api.Assumptions;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;

@Disabled
public class AppTest {

    @Test
    void testOnDev()
    {
        System.setProperty("ENV", "DEV");
        Assumptions.assumeFalse("DEV".equals(System.getProperty("ENV")));
    }

    @Test
    void testOnProd()
    {
        System.setProperty("ENV", "PROD");
        Assumptions.assumeFalse("DEV".equals(System.getProperty("ENV")));
    }
}

注意运行次数：2/2（2跳过）。

@Disabled测试方法

@Disabled用于表示注解的测试方法当前已禁用，不应执行。

import org.junit.jupiter.api.Assumptions;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;

public class AppTest {

    @Disabled("Do not run in lower environment")
    @Test
    void testOnDev()
    {
        System.setProperty("ENV", "DEV");
        Assumptions.assumeFalse("DEV".equals(System.getProperty("ENV")));
    }

    @Test
    void testOnProd()
    {
        System.setProperty("ENV", "PROD");
        Assumptions.assumeFalse("DEV".equals(System.getProperty("ENV")));
    }
}

注意运行次数：2/2（1跳过）。

@Tag

@Tag可用于从测试计划中过滤测试用例。它可以帮助为不同环境，不同用例或任何特定要求创建多个不同的测试计划。您可以通过在测试计划OR中仅包括那些标记的测试来排除测试计划中的其他测试来执行一组测试。

@Tag注解用法

您可以@Tag在测试类或测试方法或两者上应用注解。

@Tag("development")
public class ClassATest
{
    @Test
    @Tag("userManagement")
    void testCaseA(TestInfo testInfo) {
    }
}
您也可以在单个测试用例上应用多个标签，以便将其包含在多个测试计划中。

public class ClassATest
{
    @Test
    @Tag("development")
    @Tag("production")
    void testCaseA(TestInfo testInfo) {
    }
}

使用@IncludeTags和@ExcludeTags创建测试计划

可以在测试计划中使用@IncludeTags或@ExcludeTags注解来过滤测试或包含测试。

//@IncludeTags example

@RunWith(JUnitPlatform.class)
@SelectPackages("com.github.tonydeng.junit5.examples")
@IncludeTags("production")
public class JUnit5Example
{
}

//@ExcludeTags example

@RunWith(JUnitPlatform.class)
@SelectPackages("com.github.tonydeng.junit5.examples")
@ExcludeTags("production")
public class JUnit5Example
{
}

要添加多个标签，请将所需标注的字符串数组传递给所需的注解。

@RunWith(JUnitPlatform.class)
@SelectPackages("com.github.tonydeng.junit5.examples")
@IncludeTags({"production","development"})
public class JUnit5Example
{
}

不能在单个测试计划中同时包含@IncludeTags和@ExcludeTags注解。

@Tag示例

假设我们有3个测试，我们想在开发环境中运行所有3个测试; 但是想在生产中只运行一个。所以我们将标记测试如下：

public class ClassATest
{
    @Test
    @Tag("development")
    @Tag("production")
    void testCaseA(TestInfo testInfo) { //run in all environments
    }
}

public class ClassBTest
{
    @Test
    @Tag("development")
    void testCaseB(TestInfo testInfo) {
    }
}

public class ClassCTest
{
    @Test
    @Tag("development")
    void testCaseC(TestInfo testInfo) {
    }
}

让我们为这两种环境创建测试计划。

测试在生产环境中运行
@RunWith(JUnitPlatform.class)
@SelectPackages("com.github.tonydeng.junit5.examples")
@IncludeTags("production")
public class ProductionTests
{
}
测试在开发环境中运行
@RunWith(JUnitPlatform.class)
@SelectPackages("com.github.tonydeng.junit5.examples")
@IncludeTags("development")
public class DevelopmentTests
{
}

# junit5 # junit # tutorial # unit testing # annotations

本文内容由网友自发贡献，转载请注明出处：https://www.wpsshop.cn/w/知新_RL/article/detail/712316
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号