Laptoy

SpringBoot2-核心技术：Junit5单元测试

Java工程师的进阶之路

一、简介
- 1.1、介绍
- 1.2、使用JUnit4
- 1.3、使用Junit5
二、常用注解
- 2.1、介绍
- 2.2、测试
三、断言机制
- 3.1、简介
- 3.2、简单断言
- 3.3、数组断言
- 3.4、组合断言
- 3.5、异常断言
- 3.6、超时断言
- 3.7、快速失败
四、前置条件
五、嵌套测试
六、参数化测试
七、迁移指南

一、简介

1.1、介绍

Spring Boot 2.2.0 版本开始引入 JUnit 5 作为单元测试默认库 Junit5官方文档

作为最新版本的JUnit框架，JUnit5与之前版本的JUnit框架有很大的不同。由三个不同子项目的几个不同模块组成。

JUnit 5 = JUnit Platform + JUnit Jupiter + JUnit Vintage

JUnit Platform：Junit Platform是在JVM上启动测试框架的基础，不仅支持Junit自制的测试引擎，其他测试引擎也都可以接入。
JUnit Jupiter：JUnit Jupiter提供了JUnit5的新的编程模型，是JUnit5新特性的核心。内部包含了一个测试引擎，用于在Junit Platform上运行。
JUnit Vintage：由于JUint已经发展多年，为了照顾老的项目，JUnit Vintage提供了兼容JUnit4.x，JUnit3.x的测试引擎。

1.2、使用JUnit4

注意：

SpringBoot 2.4 以上版本移除了默认对 Vintage 的依赖。如果需要兼容JUnit4需要自行引入（不能使用JUnit4的功能 @Test）
JUnit 5’s Vintage已经从 spring-boot-starter-test 从移除。如果需要继续兼容Junit4需要自行引入Vintage依赖：

<dependency>
    <groupId>org.junit.vintagegroupId>
    <artifactId>junit-vintage-engineartifactId>
    <scope>testscope>
    <exclusions>
        <exclusion>
            <groupId>org.hamcrestgroupId>
            <artifactId>hamcrest-coreartifactId>
        exclusion>
    exclusions>
dependency>

1.3、使用Junit5

1、使用添加JUnit 5，添加对应的starter：


<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-testartifactId>
    <scope>testscope>
dependency>

2、Spring的JUnit 5的基本单元测试模板（Spring的JUnit4的是@SpringBootTest+@RunWith(SpringRunner.class)）：

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;//注意不是org.junit.Test（这是JUnit4版本的）
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringBootApplicationTests {

    @Autowired
    private Component component;
    
    @Test
    //@Transactional 标注后连接数据库有回滚功能
    public void contextLoads() {
		Assertions.assertEquals(5, component.getFive());
    }
}

二、常用注解

2.1、介绍

注解官方文档

@Test：表示方法是测试方法。但是与JUnit4的@Test不同，他的职责非常单一不能声明任何属性，拓展的测试将会由Jupiter提供额外测试
@ParameterizedTest：表示方法是参数化测试。
@RepeatedTest：表示方法可重复执行。
@DisplayName：为测试类或者测试方法设置展示名称。
@BeforeEach：表示在每个单元测试之前执行。
@AfterEach：表示在每个单元测试之后执行。
@BeforeAll：表示在所有单元测试之前执行。
@AfterAll：表示在所有单元测试之后执行。
@Tag：表示单元测试类别，类似于JUnit4中的@Categories。
@Disabled：表示测试类或测试方法不执行，类似于JUnit4中的@Ignore。
@Timeout：表示测试方法运行如果超过了指定时间将会返回错误。
@ExtendWith：为测试类或测试方法提供扩展类引用。

2.2、测试

1、测试注解，可以看出特殊注解比普通@Test先执行

import org.junit.jupiter.api.*;

@DisplayName("junit5功能测试类")
public class JUnit5Test {

    @DisplayName("测试displayname注解")
    @Test
    void testDisplayName() {
        System.out.println(1);
    }

    @Disabled
    @DisplayName("测试方法2")
    @Test
    void test2() {
        System.out.println(2);
    }

    @RepeatedTest(2)
    void test3() {
        System.out.println(5);
    }

    /**
     * 规定方法超时时间。超出时间测试出异常
     */
//    @Timeout(value = 500, unit = TimeUnit.MILLISECONDS)
//    @Test
//    void testTimeout() throws InterruptedException {
//        Thread.sleep(600);
//    }

    @BeforeEach
    void testBeforeEach() {
        System.out.println("测试就要开始了...");
    }

    @AfterEach
    void testAfterEach() {
        System.out.println("测试结束了...");
    }

    @BeforeAll
    static void testBeforeAll() {
        System.out.println("所有测试就要开始了...");
    }

    @AfterAll
    static void testAfterAll() {
        System.out.println("所有测试已经结束了...");
    }
}

2、使用@SpringBootTest可以使该测试类能够导入组件（如导入JdbcTemplate）

@SpringBootTest
@DisplayName("junit5功能测试类")
public class JUnit5Test {

    @Autowired
    JdbcTemplate jdbcTemplate;

    @DisplayName("测试displayname注解")
    @Test
    void testDisplayName() {
        System.out.println(jdbcTemplate);
    }
}

三、断言机制

3.1、简介

断言Assertion是测试方法中的核心部分，用来对测试需要满足的条件进行验证。这些断言方法都是 org.junit.jupiter.api.Assertions 的静态方法
检查业务逻辑返回的数据是否合理。所有的测试运行结束以后，会有一个详细的测试报告

JUnit 5 内置的断言可以分成如下几个类别：

3.2、简单断言

用来对单个值进行简单的验证。如：

方法	说明
assertEquals	判断两个对象或两个原始类型是否相等
assertNotEquals	判断两个对象或两个原始类型是否不相等
assertSame	判断两个对象引用是否指向同一个对象
assertNotSame	判断两个对象引用是否指向不同的对象
assertTrue	判断给定的布尔值是否为 true
assertFalse	判断给定的布尔值是否为 false
assertNull	判断给定的对象引用是否为 null
assertNotNull	判断给定的对象引用是否不为 null

1、assertEquals

@Test
void test01() {
    int result = 2 + 3;
    // 第一个参数是预期值，当预期值与传入的结果不同时报错
    assertEquals(6, result,"业务逻辑计算失败");
}

2、assertSame

@DisplayName("测试简单断言")
@Test
void test01() {
    Object o1 = new Object();
    Object o2 = new Object();
    assertSame(o1, o2,"两个对象不一样");
}

3、前面的断言失败，后面的代码及断言都不会执行

@Test
void test01() {
    int result = 2 + 3;
    assertEquals(6, result,"业务逻辑计算失败");
    Object o1 = new Object();
    Object o2 = new Object();
    assertSame(o1, o2,"两个对象不一样");
}

3.3、数组断言

通过 assertArrayEquals 方法来判断两个对象或原始类型的数组是否相等。

@Test
void array() {
	assertArrayEquals(new int[]{1, 2}, new int[] {1, 2});
}

3.4、组合断言

assertAll()方法接受多个 org.junit.jupiter.api.Executable 函数式接口的实例作为要验证的断言，可以通过 lambda 表达式很容易的提供这些断言。

@Test
void all() {
    assertAll("Math",
            () -> assertEquals(2, 1, "结果不是2"),
            () -> assertTrue(false, "结果不为true")
    );
}

此种方式能够使多个断言都执行

3.5、异常断言

在JUnit4时期，想要测试方法的异常情况时，需要用@Rule注解的ExpectedException变量还是比较麻烦的。而JUnit5提供了一种新的断言方式Assertions.assertThrows()，配合函数式编程就可以进行使用。

@Test
void exceptionTest() {
    // 断言一定会出现该异常，但是结果却是没发生该异常
    assertThrows(ArithmeticException.class, () -> {
        int i = 10 / 2;
    }, "业务逻辑居然正常运行？");
}

3.6、超时断言

JUnit5还提供了Assertions.assertTimeout()为测试方法设置了超时时间。

@Test
void timeoutTest() {
    //如果测试方法时间超过1s将会异常
    assertTimeout(Duration.ofMillis(1000), () -> Thread.sleep(1500));
}

3.7、快速失败

通过 fail 方法直接使得测试失败。

@Test
void shouldFail() {
	fail("This should fail");
}

四、前置条件

JUnit 5 中的前置条件（assumptions【假设】）类似于断言，不同之处在于不满足的断言assertions会使得测试方法失败，而不满足的前置条件只会使得测试方法的执行终止。

前置条件可以看成是测试方法执行的前提，当该前提不满足时，就没有继续执行的必要。

@Test
public void simpleAssume() {
    assumeTrue(false, "结果不是true");
    System.out.println(111);	// 不输出
}

assumeTrue 和 assumFalse 确保给定的条件为 true 或 false，不满足条件会使得测试执行终止。

assumingThat 的参数是表示条件的布尔值和对应的 Executable 接口的实现对象。只有条件满足时，Executable 对象才会被执行；当条件不满足时，测试执行并不会终止。

五、嵌套测试

官方文档

JUnit 5 可以通过 Java 中的内部类和 @Nested 注解实现嵌套测试，从而可以更好的把相关的测试方法组织在一起。在内部类中可以使用@BeforeEach 和@AfterEach注解，而且嵌套的层次没有限制。

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;

import java.util.EmptyStackException;
import java.util.Stack;

import static org.junit.jupiter.api.Assertions.*;

class TestingAStackDemo {

    Stack<Object> stack;

    @Test
    @DisplayName("new Stack()")
    void isInstantiatedWithNew() {
        new Stack<>();
        assertNull(stack);
    }

    @Nested
    @DisplayName("when new")
    class WhenNew {

        @BeforeEach
        void createNewStack() {
            stack = new Stack<>();
        }

        @Test
        @DisplayName("is empty")
        void isEmpty() {
            assertTrue(stack.isEmpty());
        }

        @Test
        @DisplayName("throws EmptyStackException when popped")
        void throwsExceptionWhenPopped() {
            assertThrows(EmptyStackException.class, stack::pop);
        }

        @Test
        @DisplayName("throws EmptyStackException when peeked")
        void throwsExceptionWhenPeeked() {
            assertThrows(EmptyStackException.class, stack::peek);
        }

        @Nested
        @DisplayName("after pushing an element")
        class AfterPushing {

            String anElement = "an element";

            @BeforeEach
            void pushAnElement() {
                stack.push(anElement);
            }

            @Test
            @DisplayName("it is no longer empty")
            void isNotEmpty() {
                assertFalse(stack.isEmpty());
            }

            @Test
            @DisplayName("returns the element when popped and is empty")
            void returnElementWhenPopped() {
                assertEquals(anElement, stack.pop());
                assertTrue(stack.isEmpty());
            }

            @Test
            @DisplayName("returns the element when peeked but remains not empty")
            void returnElementWhenPeeked() {
                assertEquals(anElement, stack.peek());
                assertFalse(stack.isEmpty());
            }
        }
    }
}

六、参数化测试