Junit5学习笔记

一、Junit5常用测试注解

①.@DisplayName：为测试类或者测试方法设置展示名称。

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

②.@BeforeEach :表示在每个单元测试之前执行

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

③.@AfterEach :表示在每个单元测试之后执行

@AfterEach
    void testAfterEach(){
        System.out.println("测试就要结束啦……");
    }

④.@BeforeAll :表示在所有单元测试之前执行

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

⑤.@AfterAll :表示在所有单元测试之后执行

@AfterAll
    static void testAfterAll(){
        System.out.println("所有测试就要结束啦……");
    }

⑥.@Disabled :表示测试类或测试方法不执行，类似于JUnit4中的@Ignore。

@DisplayName("测试方法二")
    @Test
//    禁用注解
    @Disabled
    void test2(){
        System.out.println("测试方法二");
    }

⑦.@Timeout :表示测试方法运行如果超过了指定时间将会返回错误

@Timeout(value = 1000,unit = TimeUnit.MILLISECONDS)
    @Test
    void testTimeout() throws InterruptedException {
        Thread.sleep(1001);
    }

⑧.@ExtendWith :为测试类或测试方法提供扩展类引用。类似于Junit4的@RunWith。

@BootstrapWith(SpringBootTestContextBootstrapper.class)
@ExtendWith({SpringExtension.class})

⑨.@RepeatedTest :表示方法可重复执行，里面参数为重复多少次、

@RepeatedTest(5)
    @Test
    void test3(){
        System.out.println("测试重复测试");
    }

二、断言机制

断言（assertions）是测试方法中的核心部分，用来对测试需要满足的条件进行验证。**这些断言方法都是 org.junit.jupiter.api.Assertions 的静态方法。**JUnit 5 内置的断言可以分成如下几个类别：
检查业务逻辑返回的数据是否合理。
所有的测试运行结束以后，会有一个详细的测试报告；

①.简单断言测试

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

断言如果前面方法失败了，后面就不会运行

@DisplayName("简单断言测试")
    @Test
    void testSimpleAssertions(){
        int cal = cal(5, 6);
//        org.opentest4j.AssertionFailedError:
//        Expected :111
//        Actual   :11
        assertEquals(11,cal,"业务逻辑计算失败");
        Object o1 = new Object();
        Object o2 = new Object();
        assertNotSame(o1,o2);

②.数组断言

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

@Test
    @DisplayName("数组断言")
    public void array() {
        assertArrayEquals(new int[]{1, 2}, new int[] {1, 2});
    }

③.组合断言

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

@Test
    @DisplayName("组合断言")
    void all() {
        /**
         * 断言需要全部成功才能够继续
         */
        assertAll("Math",
                () -> assertEquals(2, 1 + 1,"结果不相等"),
                () -> assertTrue(1 > 0,"结果为假")
        );
    }

④.异常断言

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

@Test
    @DisplayName("异常测试")
    public void exceptionTest() {
        assertThrows(
                //扔出断言异常
                ArithmeticException.class, () -> System.out.println(1 % 0),
                "业务逻辑竟然正常运行");
    }

⑤.超时断言

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

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

⑥.快速失败

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

@Test
    @DisplayName("快速失败")
    public void shouldFail() {
        fail("这应该失败");
    }

三、前置条件

JUnit 5 中的前置条件（assumptions【假设】）类似于断言，不同之处在于不满足的断言会使得测试方法失败，而不满足的前置条件只会使得测试方法的执行终止。前置条件可以看成是测试方法执行的前提，当该前提不满足时，就没有继续执行的必要。

/**
     * 测试前置条件
     */
    @DisplayName("测试前置条件")
    @Test
    void testAssumptions(){
        Assumptions.assumeTrue(true,"结果不是True");
        System.out.println("数字");
    }

assumeTrue 和 assumFalse 确保给定的条件为 true 或 false，不满足条件会使得测试执行终止。assumingThat 的参数是表示条件的布尔值和对应的 Executable 接口的实现对象。只有条件满足时，Executable 对象才会被执行；当条件不满足时，测试执行并不会终止。

四、嵌套测试

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

/**
 * @Author Kevin
 * @Date 2021-03-23 20:38:20
 */
@DisplayName("嵌套测试")
class TestingAStackDemo {

    Stack<Object> stack;

    @Test
    @DisplayName("is instantiated with new Stack()")
    void isInstantiatedWithNew() {
        new Stack<>();
        //嵌套测试情况下，外层的Test不能驱动内层的@Before(After)Each/All之类方法提前/之类运行
    }

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

        @BeforeEach
        void createNewStack() {
            System.out.println("新生成了一个Stack栈");
            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() {
                System.out.println(stack.toString()+"栈中防止一个元素："+anElement.toString());
                stack.push(anElement);
                System.out.println(stack);
            }

            /**
             * 内层的Test可以驱动外层的Before(After)Each/All的方法提前/之后运行
             */
            @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());
            }
        }
    }
}

五、参数化测试

参数化测试是JUnit5很重要的一个新特性，它使得用不同的参数多次运行测试成为了可能，也为我们的单元测试带来许多便利。
利用@ValueSource等注解，指定入参，我们将可以使用不同的参数进行多次单元测试，而不需要每新增一个参数就新增一个单元测试，省去了很多冗余代码。
@ValueSource: 为参数化测试指定入参来源，支持八大基础类以及String类型,Class类型
@NullSource: 表示为参数化测试提供一个null的入参
@EnumSource: 表示为参数化测试提供一个枚举入参
@CsvFileSource：表示读取指定CSV文件内容作为参数化测试入参
@MethodSource：表示读取指定方法的返回值作为参数化测试入参(注意方法返回需要是一个流)
当然如果参数化测试仅仅只能做到指定普通的入参还达不到让我觉得惊艳的地步。让我真正感到他的强大之处的地方在于他可以支持外部的各类入参。如:CSV,YML,JSON 文件甚至方法的返回值也可以作为入参。只需要去实现ArgumentsProvider接口，任何外部文件都可以作为它的入参。

@ParameterizedTest
    @ValueSource(strings = {"one", "two", "three"})
    @DisplayName("参数化测试1")
    public void parameterizedTest1(String string) {
        System.out.println(string);
        Assertions.assertTrue(StringUtils.isNotBlank(string));
    }


    @ParameterizedTest
    @MethodSource("method")    //指定方法名（方法必须是静态的而且需要返回一个Stream类型）
    @DisplayName("方法来源参数")
    public void testWithExplicitLocalMethodSource(String name) {
        System.out.println(name);
        Assertions.assertNotNull(name);
    }

    static Stream<String> method() {
        return Stream.of("apple", "banana");
    }

来源（尚硅谷SpringBoot教程）：https://www.yuque.com/atguigu/springboot