JUnit5断言测试
1、断言(assertions)
JUnit5关于断言的官方参考文档
断言(assertions)是测试方法中的核心部分,用来对测试需要满足的条件进行验证。这些断言方法都是 org.junit.jupiter.api.Assertions 的静态方法。JUnit 5 内置的断言可以分成如下几个类别:
检查业务逻辑返回的数据是否合理。
所有的测试运行结束以后,会有一个详细的测试报告;
1.1、简单断言
用来对单个值进行简单的验证。如:
1、测试assertEquals
@DisplayName("测试断言")
public class TestAssertions {
int cal(Integer a,Integer b){
return a+b;
}
@DisplayName("测试断言")
@Test
void testSimpleAssertions(){
int cal = cal(1, 2);
Assertions.assertEquals(5,cal,"测试结果不正确");
}
}
2、测试assertSame
@DisplayName("测试断言")
public class TestAssertions {
@DisplayName("测试断言")
@Test
void testSimpleAssertions(){
Object obj1 = new Object();
Object obj2 = new Object();
Assertions.assertSame(obj1,obj2,"两个对象不一样");
}
}
3、注意。如果一个测试方法中有两个断言,第一个断言失败,第二个断言不会执行
1.2、数组断言
通过 assertArrayEquals 方法来判断两个对象或原始类型的数组是否相等
@DisplayName("测试数组断言")
@Test
void testArrayAssertions(){
Assertions.assertArrayEquals(new int[]{1,2},new int[]{2,2},"数组内容不相等");
}
1.3、组合断言
assertAll 方法接受多个 org.junit.jupiter.api.Executable 函数式接口的实例作为要验证的断言,可以通过 lambda 表达式很容易的提供这些断言
@DisplayName("测试组合断言")
@Test
void testall(){
/**
* 所有断言全部需要成功
*/
Assertions.assertAll("test",
()->assertTrue(1 > 0,"结果不是true"),
()->assertEquals(1,2,"结果不是1"));
}
1.4、异常断言
在JUnit4时期,想要测试方法的异常情况时,需要用@Rule注解的ExpectedException变量还是比较麻烦的。而JUnit5提供了一种新的断言方式Assertions.assertThrows() ,配合函数式编程就可以进行使用。
异常断言就是该业务逻辑应该是要抛出异常的,但是结果却没有抛出异常。说明业务逻辑有错误。
@DisplayName("异常断言")
@Test
void testException(){
/**
* 该业务逻辑一定要抛出异常,如果没有抛出异常,说明业务逻辑错误
* 断定义务逻辑一定会抛出异常
*/
Assertions.assertThrows(ArithmeticException.class, ()->{
int i = 10 / 2;
}, "业务逻辑竟然正常运行?");
}
1.5、超时断言
该业务逻辑一定在我设置的执行时间范围之内执行完成,超时就要报错。
@Test
@DisplayName("超时断言测试")
public void timeoutTest() {
//如果测试方法时间超过1s将会异常
Assertions.assertTimeout(Duration.ofMillis(1000), () -> Thread.sleep(1500),"业务逻辑执行时间过长");
}
1.6、快速失败
通过 fail 方法直接使得测试失败
@Test
@DisplayName("测试快速失败断言")
public void shouldFail() {
if(2 == 2){
Assertions.fail("快速失败");
}
}
2、前置条件
JUnit 5 中的前置条件(assumptions【假设】)类似于断言,不同之处在于不满足的断言会使得测试方法失败,而不满足的前置条件只会使得测试方法的执行终止。前置条件可以看成是测试方法执行的前提,当该前提不满足时,就没有继续执行的必要。
当满足了前置条件才执行断言测试
- 在测试代码中加入以下前置测试条件的代码。
如下所示:Assumptions.assumeTrue(true,“结果不是true”) - 这句话意思是在执行该测试类中的每一个断言测试时,只有当断言测试为true时,才会执行该断言测试。
@DisplayName("测试前置条件")
@Test
void testassumptions(){
Assumptions.assumeTrue(true,"结果不是true");
System.out.println("111111");
}
- assumeTrue 和 assumFalse 确保给定的条件为 true 或 false,不满足条件会使得测试执行终止。assumingThat 的参数是表示条件的布尔值和对应的 Executable 接口的实现对象。只有条件满足时,Executable 对象才会被执行;当条件不满足时,测试执行并不会终止。
package com.study.admin;
import org.junit.jupiter.api.*;
import java.time.Duration;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
/**
* @Description :
* @Author :lenovo
* @Date :2021/5/13 16:18
*/
@DisplayName("测试断言")
public class TestAssertions {
/**
* 如下所示: Assumptions.assumeTrue(true)假设前置条件为true,而值为true,所以控制台会打印输出111111
* 对于其他断言,由于在假设前置条件中设置了值为true。所以对于其它断言测试,只有满足值为true时才会执行
*/
@DisplayName("测试前置条件")
@Test
void testassumptions(){
Assumptions.assumeTrue(true,"结果不是true");
System.out.println("111111");
}
int cal(Integer a,Integer b){
return a+b;
}
@DisplayName("测试简单断言")
@Test
void testSimpleAssertions(){
int cal = cal(1, 2);
assertEquals(5,cal,"测试结果不正确");
Object obj1 = new Object();
Object obj2 = new Object();
Assertions.assertSame(obj1,obj2,"两个对象不一样");
}
@Disabled
@DisplayName("测试数组断言")
@Test
void testArrayAssertions(){
Assertions.assertArrayEquals(new int[]{2,2},new int[]{2,2},"数组内容不相等");
}
@DisplayName("测试组合断言")
@Test
void testall(){
/**
* 所有断言全部需要成功
*/
Assertions.assertAll("test",
()->assertTrue(1 > 0,"结果不是true"),
()->assertEquals(1,1,"结果不是1"));
}
@DisplayName("异常断言")
@Test
void testException(){
/**
* 该业务逻辑一定要抛出异常,如果没有抛出异常,说明业务逻辑错误
* 断定义务逻辑一定会抛出异常
*/
Assertions.assertThrows(ArithmeticException.class, ()->{
int i = 10 / 0;
}, "业务逻辑竟然正常运行?");
}
@Test
@DisplayName("超时断言测试")
public void timeoutTest() {
//如果测试方法时间超过1s将会异常
Assertions.assertTimeout(Duration.ofMillis(1000), () -> Thread.sleep(1500),"业务逻辑执行时间过长");
}
@Test
@DisplayName("测试快速失败断言")
public void shouldFail() {
if(2 == 2){
Assertions.fail("快速失败");
}
}
}
3、嵌套测试
Junit嵌套测试官方文档
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.*;
@DisplayName("嵌套测试")
public class TestingAStackDemo {
Stack<Object> stack;
@Test
@DisplayName("new Stack()")
void isInstantiatedWithNew() {
new Stack<>();
//嵌套情况下,外层的Test不能驱动内层的Before(After)Each/All之类的方法提前/之后运行
assertNull(stack);
}
@Nested
@DisplayName("when new")
class WhenNew {
@BeforeEach
void createNewStack() {
stack = new Stack<>();
}
//内层的test可以驱动外层的test
@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() {
//stack.pop()将栈中的元素弹出
assertEquals(anElement, stack.pop());
assertTrue(stack.isEmpty());
}
@Test
@DisplayName("returns the element when peeked but remains not empty")
void returnElementWhenPeeked() {
//stack.peek()查看栈中的元素
assertEquals(anElement, stack.peek());
assertFalse(stack.isEmpty());
}
}
}
}
4、参数化测试
参数化测试是JUnit5很重要的一个新特性,它使得用不同的参数多次运行测试成为了可能,也为我们的单元测试带来许多便利。
- 利用@ValueSource等注解,指定入参,我们将可以使用不同的参数进行多次单元测试,而不需要每新增一个参数就新增一个单元测试,省去了很多冗余代码。
- @ValueSource: 为参数化测试指定入参来源,支持八大基础类以及String类型,Class类型
public class ParamterizedTest {
@ParameterizedTest
@DisplayName("参数化测试")
@ValueSource(ints = {1,2,3,4,5})
void testParamterized(int i){
System.out.println(i);
}
}
- @NullSource: 表示为参数化测试提供一个null的入参
- @EnumSource: 表示为参数化测试提供一个枚举入参
- @CsvFileSource:表示读取指定CSV文件内容作为参数化测试入参
- @MethodSource:表示读取指定方法的返回值作为参数化测试入参(注意方法返回需要是一个流)
public class ParamterizedTest {
@ParameterizedTest
@DisplayName("参数化测试,读取指定方法的返回值")
@MethodSource("stringStream")
void testParamterized2(String grand){
System.out.println(grand);
}
static Stream<String> stringStream(){
return Stream.of("apple","xiaomi");
}
}
- 当然如果参数化测试仅仅只能做到指定普通的入参还达不到让我觉得惊艳的地步。让我真正感到他的强大之处的地方在于他可以支持外部的各类入参。如:CSV,YML,JSON 文件甚至方法的返回值也可以作为入参。只需要去实现ArgumentsProvider接口,任何外部文件都可以作为它的入参。
5、迁移指南-从Junit4到Junit5
在进行迁移的时候需要注意如下的变化:
- 注解在 org.junit.jupiter.api 包中,断言在 org.junit.jupiter.api.Assertions 类中,前置条件在 org.junit.jupiter.api.Assumptions 类中。
- 把@Before 和@After 替换成@BeforeEach 和@AfterEach。
- 把@BeforeClass 和@AfterClass 替换成@BeforeAll 和@AfterAll。
- 把@Ignore 替换成@Disabled。
- 把@Category 替换成@Tag。
- 把@RunWith、@Rule 和@ClassRule 替换成@ExtendWith。