欢迎访问我的GitHub

https://github.com/zq2599/blog_demos

内容:所有原创文章分类汇总及配套源码,涉及Java、Docker、Kubernetes、DevOPS等;

关于《JUnit5学习》系列

《JUnit5学习》系列旨在通过实战提升SpringBoot环境下的单元测试技能,一共八篇文章,链接如下:

  1. 基本操作
  2. Assumptions类
  3. Assertions类
  4. 按条件执行
  5. 标签(Tag)和自定义注解
  6. 参数化测试(Parameterized Tests)基础
  7. 参数化测试(Parameterized Tests)进阶
  8. 综合进阶(终篇)

本篇概览

本文是《JUnit5学习》系列的第三篇,主要是学习Assertions类(org.junit.jupiter.api.Assertions),Assertions类的一系列静态方法给我们提供了单元测试时常用的断言功能,本篇主要内容如下:

  1. Assertions源码分析
  2. 写一段代码,使用Assertions的常用静态方法
  3. 使用异常断言
  4. 使用超时断言
  5. 了解第三方断言库

源码下载

  1. 如果您不想编码,可以在GitHub下载所有源码,地址和链接信息如下表所示:
名称 链接 备注
项目主页 https://github.com/zq2599/blog_demos 该项目在GitHub上的主页
git仓库地址(https) https://github.com/zq2599/blog_demos.git 该项目源码的仓库地址,https协议
git仓库地址(ssh) git@github.com:zq2599/blog_demos.git 该项目源码的仓库地址,ssh协议
  1. 这个git项目中有多个文件夹,本章的应用在junitpractice文件夹下,如下图红框所示:

  1. junitpractice是父子结构的工程,本篇的代码在assertassume子工程中,如下图:

Assertions源码分析

  1. 下图是一段最简单最常见的单元测试代码,也就是Assertions.assertEquals方法,及其执行效果:

  1. 将Assertions.assertEquals方法逐层展开,如下图所示,可见入参expected和actual的值如果不相等,就会在AssertionUtils.fail方法中抛出AssertionFailedError异常:

  1. 用类图工具查看Assertions类的方法,如下图,大部分是与assertEquals方法类似的判断,例如对象是否为空,数组是否相等,判断失败都会抛出AssertionFailedError异常:



4. 判断两个数组是否相等的逻辑与判断两个对象略有不同,可以重点看看,方法源码如下:

	public static void assertArrayEquals(Object[] expected, Object[] actual) {
AssertArrayEquals.assertArrayEquals(expected, actual);
}
  1. 将上述代码逐层展开,在AssertArrayEquals.java中见到了完整的数组比较逻辑,如下图:

  • 接下来,咱们编写一些单元测试代码,把Assertions类常用的方法都熟悉一遍;

编码实战

  1. 打开junitpractice工程的子工程assertassume,新建测试类AssertionsTest.java:



2. 最简单的判断,两个入参相等就不抛异常(AssertionFailedError):

    @Test
@DisplayName("最普通的判断")
void standardTest() {
assertEquals(2, Math.addExact(1, 1));
}
  1. 还有另一个assertEquals方法,能接受Supplier类型的入参,当判断不通过时才会调用Supplier.get方法获取字符串作为失败提示消息(如果测试通过则Supplier.get方法不会被执行):
    @Test
@DisplayName("带失败提示的判断(拼接消息字符串的代码只有判断失败时才执行)")
void assertWithLazilyRetrievedMessage() {
int expected = 2;
int actual = 1; assertEquals(expected,
actual,
// 这个lambda表达式,只有在expected和actual不相等时才执行
()->String.format("期望值[%d],实际值[%d]", expected, actual));
}
  1. assertAll方法可以将多个判断逻辑放在一起处理,只要有一个报错就会导致整体测试不通过,并且执行结果中会给出具体的失败详情:
    @Test
@DisplayName("批量判断(必须全部通过,否则就算失败)")
void groupedAssertions() {
// 将多个判断放在一起执行,只有全部通过才算通过,如果有未通过的,会有对应的提示
assertAll("单个测试方法中多个判断",
() -> assertEquals(1, 1),
() -> assertEquals(2, 1),
() -> assertEquals(3, 1)
);
}

上述代码执行结果如下:

异常断言

  1. Assertions.assertThrows方法,用来测试Executable实例执行execute方法时是否抛出指定类型的异常;
  2. 如果execute方法执行时不抛出异常,或者抛出的异常与期望类型不一致,都会导致测试失败;
  3. 写段代码验证一下,如下,1除以0会抛出ArithmeticException异常,符合assertThrows指定的异常类型,因此测试可以通过:
    @Test
@DisplayName("判断抛出的异常是否是指定类型")
void exceptionTesting() { // assertThrows的第二个参数是Executable,
// 其execute方法执行时,如果抛出了异常,并且异常的类型是assertThrows的第一个参数(这里是ArithmeticException.class),
// 那么测试就通过了,返回值是异常的实例
Exception exception = assertThrows(ArithmeticException.class, () -> Math.floorDiv(1,0)); log.info("assertThrows通过后,返回的异常实例:{}", exception.getMessage());
}
  • 以上是Assertions的常规用法,接下来要重点关注的就是和超时相关的测试方法;

超时相关的测试

  1. 超时测试的主要目标是验证指定代码能否在规定时间内执行完,最常用的assertTimeout方法内部实现如下图,可见被测试的代码通过ThrowingSupplier实例传入,被执行后再检查耗时是否超过规定时间,超过就调用fail方法抛AssertionFailedError异常:

  1. assertTimeout的用法如下,期望时间是1秒,实际上Executable实例的execute用了两秒才完成,因此测试失败:
    @Test
@DisplayName("在指定时间内完成测试")
void timeoutExceeded() {
// 指定时间是1秒,实际执行用了2秒
assertTimeout(ofSeconds(1), () -> {
try{
Thread.sleep(2000);
} catch (InterruptedException e) {
e.printStackTrace();
}
});
}

执行结果如下图:



3. 上面的演示中,assertTimeout的第二个入参类型是Executable,此外还有另一个assertTimeout方法,其第二个入参是ThrowingSupplier类型,该类型入参的get方法必须要有返回值,假设是XXX,而assertTimeout就拿这个XXX作为它自己的返回值,使用方法如下:

    @Test
@DisplayName("在指定时间内完成测试")
void timeoutNotExceededWithResult() { // 准备ThrowingSupplier类型的实例,
// 里面的get方法sleep了1秒钟,然后返回一个字符串
ThrowingSupplier<String> supplier = () -> { try{
Thread.sleep(1000);
} catch (InterruptedException e) {
e.printStackTrace();
} return "我是ThrowingSupplier的get方法的返回值";
}; // 指定时间是2秒,实际上ThrowingSupplier的get方法只用了1秒
String actualResult = assertTimeout(ofSeconds(2), supplier); log.info("assertTimeout的返回值:{}", actualResult);
}

上述代码执行结果如下,测试通过并且ThrowingSupplier实例的get方法的返回值也被打印出来:



4. 刚才咱们看过了assertTimeout的内部实现代码,是将入参Executable的execute方法执行完成后,再检查execute方法的耗时是否超过预期,这种方法的弊端是必须等待execute方法执行完成才知道是否超时,assertTimeoutPreemptively方法也是用来检测代码执行是否超时的,但是避免了assertTimeout的必须等待execute执行完成的弊端,避免的方法是用一个新的线程来执行execute方法,下面是assertTimeoutPreemptively的源码:

public static void assertTimeoutPreemptively(Duration timeout, Executable executable) {
AssertTimeout.assertTimeoutPreemptively(timeout, executable);
}
  1. assertTimeoutPreemptively方法的Executable入参,其execute方法会在一个新的线程执行,假设是XXX线程,当等待时间超过入参timeout的值时,XXX线程就会被中断,并且测试结果是失败,下面是assertTimeoutPreemptively的用法演示,设置的超时时间是2秒,而Executable实例的execute却sleep了10秒:
    @Test
void timeoutExceededWithPreemptiveTermination() {
log.info("开始timeoutExceededWithPreemptiveTermination");
assertTimeoutPreemptively(ofSeconds(2), () -> {
log.info("开始sleep");
try{
Thread.sleep(10000);
log.info("sleep了10秒");
} catch (InterruptedException e) {
log.error("线程sleep被中断了", e);
}
});
}
  1. 来看看执行结果,如下图,通过日志可见,Executable的execute方法是在新的线程执行的,并且被中断了,提前完成单元测试,测试结果是不通过:

第三方断言库

  1. 除了junit的Assertions类,还可以选择第三方库提供的断言能力,比较典型的有AssertJ, Hamcrest, Truth这三种,它们都有各自的特色和适用场景,例如Hamcrest的特点是匹配器(matchers ),而Truth来自谷歌的Guava团队,编写的代码是链式调用风格,简单易读,断言类型相对更少却不失功能;
  2. springboot默认依赖了hamcrest库,依赖关系如下图:

  1. 一个简单的基于hamcrest的匹配器的单元测试代码如下,由于预期和实际的值不相等,因此会匹配失败:
package com.bolingcavalry.assertassume.service.impl;

import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.MatcherAssert.assertThat; @SpringBootTest
@Slf4j
public class HamcrestTest { @Test
@DisplayName("体验hamcrest")
void assertWithHamcrestMatcher() {
assertThat(Math.addExact(1, 2), is(equalTo(5)));
}
}
  1. 执行结果如下:

  • 以上就是JUnit5常用的断言功能,希望本篇能助您夯实基础,为后续写出更合适的用例做好准备;

你不孤单,欣宸原创一路相伴

  1. Java系列
  2. Spring系列
  3. Docker系列
  4. kubernetes系列
  5. 数据库+中间件系列
  6. DevOps系列

欢迎关注公众号:程序员欣宸

微信搜索「程序员欣宸」,我是欣宸,期待与您一同畅游Java世界...

https://github.com/zq2599/blog_demos

JUnit5学习之三:Assertions类的更多相关文章

  1. AspectJ基础学习之三HelloWorld(转载)

    AspectJ基础学习之三HelloWorld(转载) 一.创建项目 我们将project命名为:aspectjDemo.然后我们新建2个package:com.aspectj.demo.aspect ...

  2. C++11并发学习之三:线程同步(转载)

    C++11并发学习之三:线程同步 1.<mutex> 头文件介绍 Mutex又称互斥量,C++ 11中与 Mutex 相关的类(包括锁类型)和函数都声明在 <mutex> 头文 ...

  3. Yaf零基础学习总结5-Yaf类的自动加载

    Yaf零基础学习总结5-Yaf类的自动加载 框架的一个重要功能就是类的自动加载了,在第一个demo的时候我们就约定自己的项目的目录结构,框架就基于这个目录结构来自动加载需要的类文件. Yaf在自启动的 ...

  4. JAVAAPI学习之Calendar类;Calendar类set()、add()、roll()方法区别

    JAVAAPI学习之Calendar类 http://blog.csdn.net/myjlvzlp/article/details/8065775(写的很好,清晰易懂) Calendar类set(). ...

  5. java学习一目了然&mdash;&mdash;File类文件处理

    java学习一目了然--File类文件处理 File类(java.io.File) 构造函数: File(String path) File(String parent,String child) F ...

  6. C++学习之嵌套类和局部类

    C++学习之嵌套类和局部类 局部类 在一个函数体内定义的类称为局部类. 局部类中只能使用它的外围作用域中的对象和函数进行联系,因为外围作用域中的变量与该局部类的对象无关.在定义局部类时需要注意:局部类 ...

  7. C++学习之友元类和友元函数

    C++学习之友元类和友元函数       模板类声明也可以有友元,模板的友元可以分为以下几类:        1.非模板友元:        2.约束模板友元,即就是友元的类型取决于类被实例化的时候的 ...

  8. Java学习笔记——File类之文件管理和读写操作、下载图片

    Java学习笔记——File类之文件管理和读写操作.下载图片 File类的总结: 1.文件和文件夹的创建 2.文件的读取 3.文件的写入 4.文件的复制(字符流.字节流.处理流) 5.以图片地址下载图 ...

  9. Python学习 Part7:类

    Python学习 Part7:类 1. 作用域和命名空间 命名空间(namespace)就是一个从名称到对象的映射. 命名空间的一些实例:内置名称集(函数,像abs(),和内置异常名称),一个模块中的 ...

  10. python学习笔记4_类和更抽象

    python学习笔记4_类和更抽象 一.对象 class 对象主要有三个特性,继承.封装.多态.python的核心. 1.多态.封装.继承 多态,就算不知道变量所引用的类型,还是可以操作对象,根据类型 ...

随机推荐

  1. HDU 5002 Tree(动态树LCT)(2014 ACM/ICPC Asia Regional Anshan Online)

    Problem Description You are given a tree with N nodes which are numbered by integers 1..N. Each node ...

  2. js 函数function的几种形式

    //有的时候我们一直都在使用函数,但是却不知道函数使用的正真含义 //其中一个重要的目的是为了提高代码的复用率 //其二函数可以传递参数并有返回值 //函数声明 //不带参数,不带返回值 functi ...

  3. Windows下使用Visual Studio Code搭建Go语言环境

    1.安装GO语言   下载地址:    https://golang.org/dl/   Windows下直接运行安装GO语言即可.     安装成功.   安装完毕GO语言后,需要添加GOPATH环 ...

  4. MCU晶体旁边电容的作用及振荡电路的分析

    绝大多数的MCU爱好者对MCU晶体两边要接一个22pF附近的电容不理解,因为这个电容有些时候是可以不要的.参考很多书籍,讲解的很少,往往提到最多的是起稳定作用,负载电容之类的话,都不是很深入理论的分析 ...

  5. Java并发框架——什么是AQS框架

    什么是AQS框架 1995年sun公司发布了第一个java语言版本,可以说从jdk1.1到jdk1.4期间java的使用主要是在移动应用和中小型企业应用中,在此类领域中基本不用设计大型并发场景,当然也 ...

  6. saltstack学习之一:服务架构以及相关配置安装运行

    概要 saltstack是基于Python开发的C/S架构的一款批量管理工具,底层采用动态的连接总线(ZeroMQ消息队列pub/sub方式通信),使用ssl证书签发的方式进行认证管理,使其可以用于编 ...

  7. asp.net下配置使用Memcached 如何使用Memcached .ne使用BeITMemcached.dllt配置Memcached的方法

    首先在项目中引用 BeITMemcached.dll 在Web.config中配置节点 <configSections> <section name="beitmemcac ...

  8. ecshop安装

    ECSHOP开发中心(www.68ecshop.com) 1.下载ecshop程序包,下载地址: http://download.ecshop.com/2.7.3/ECShop_V2.7.3_UTF8 ...

  9. Hibernate详讲

    一 概述 1.JPA Java Persistence API,是Java EE为ORM框架定义的规范,任何使用java语言的ORM框架都必须实现该规范.Hibernate/Mybatis都是是JPA ...

  10. lintcode-18-带重复元素的子集

    带重复元素的子集 给定一个可能具有重复数字的列表,返回其所有可能的子集 注意事项 子集中的每个元素都是非降序的 两个子集间的顺序是无关紧要的 解集中不能包含重复子集 样例 如果 S = [1,2,2] ...