单元测试框架怎么搭？新版的Junit5有哪些神奇之处？

2022-02-13 02:36:07

本文为霍格沃兹测试学院优秀学员学习笔记。

单元测试（unit testing），是指对软件中的最小可测试单元进行检查和验证。

总的来说，单元就是人为规定的最小的被测功能模块。单元测试是在软件开发过程中要进行的最低级别的测试活动，软件的独立单元将在与程序的其他部分相隔离的情况下进行测试。

那单元测试框架该怎么搭呢？Junit5又能给我们带来怎样的惊喜呢？首先我们来看看什么是Junit5，再看看如何使用吧~

1. What is Junit5？

Junit5简介

什么是Junit5，在Junit5的官方介绍文档中这写到：Junit5由JUnit Platform + JUnit Jupiter + JUnit Vintage3部分构成

借用IBM Developer的一张图来说明JUnit 5 的架构：

JUnit Platform :

其主要作用是在 JVM 上启动测试框架。它定义了一个抽象的 TestEngine API 来定义运行在平台上的测试框架；也就是说其他的自动化测试引擎或开发人员⾃⼰定制的引擎都可以接入 Junit 实现对接和执行。同时还支持通过命令行、Gradle 和 Maven 来运行平台（这对于我们做自动化测试至关重要）

JUnit Jupiter:

这是 Junit5 的核心，可以看作是承载 Junit4 原有功能的演进，包含了 JUnit 5 最新的编程模型和扩展机制；很多丰富的新特性使 JUnit ⾃动化测试更加方便、功能更加丰富和强大。也是测试需要重点学习的地方；Jupiter 本身也是⼀一个基于 Junit Platform 的引擎实现，对 JUnit 5 而言，JUnit Jupiter API 只是另一个 API！。

JUnit Vintage:

Junit 发展了10数年，Junit 3 和 Junit 4 都积累了大量的⽤用户，作为新一代框架，这个模块是对 JUnit3，JUnit4 版本兼容的测试引擎，使旧版本 junit 的⾃动化测试脚本也可以顺畅运行在 Junit5 下，它也可以看作是基于 Junit Platform 实现的引擎范例。

JUnit 5 对 Java 运行环境的最低要求是 Java 8。

2. Junit5的新特性

特性与JUnit4注解比较

JUnit5的新特性有：嵌套单元测试、Lambda支持、参数化测试、重复测试、动态测试

JUnit 4 与 JUnit 5 中的注解比较

Junit5	Junit4	说明
@Test	@Test	被注解的方法是一个测试方法。与 JUnit 4 相同。
@BeforeAll	@BeforeClass	被注解的（静态）方法将在当前类中的所有 @Test 方法前执行一次。
@BeforeEach	@Before	被注解的方法将在当前类中的每个 @Test 方法前执行。
@AfterEach	@After	被注解的方法将在当前类中的每个 @Test 方法后执行。
@AfterAll	@AfterClass	被注解的（静态）方法将在当前类中的所有 @Test 方法后执行一次。
@Disabled	@Ignore	被注解的方法不会执行（将被跳过），但会报告为已执行。

3. JUnit 5 常用注解

Junit5常用注解展示

注解	说明
@Test	表明一个测试方法
@DisplayName	测试类或方法的显示名称
@BeforeEach	表明在单个测试方法运行之前执行的方法
@AfterEach	表明在单个测试方法运行之后执行的方法
@BeforeAll	表明在所有测试方法运行之前执行的方法
@AfterAll	表明在所有测试方法运行之后执行的方法
@Disabled	禁用测试类或方法
@Tag	为测试类或方法添加标签
@RepeatedTest	额外重复执行
@Nested	嵌套测试

3. JUnit 5 常用注解

实操演示

创建maven工程XUnit，pom.xml中添加Junit5的依赖

 <dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-engine</artifactId>
    <version>5.5.2</version>
</dependency>
<dependency>
     <groupId>org.junit.platform</groupId>
     <artifactId>junit-platform-runner</artifactId>
     <version>1.5.1</version>
</dependency>

其余的XUnit框架通用的设计运行规则可参考博客：

如何利用xUnit框架对测试用例进行维护-xUnit简介及基本使用方法(基于Junit4)

添加用例@Test，再在用例执行前后添加@BeforeEach、@AfterEach：

运行结果：

在测试类执行前后添加@BeforeAll和@AfterAll

测试结果：

在测试用例test1上加入注解@Disabled，使test1失

测试结果：

从测试结果中我们可以看到test1用例被ignore，没有被执行

分别将test1和test2用@DisplayName加上用例展示名称

测试结果：

对测试用例2加上注解@RepeatedTest,使其额外重复执行3次

测试结果：

从测试结果中我们可以看到测试用例2被额外重复执行了3次

对于@Nested嵌套执行举例如下：

测试结果：

由测试结果可以看出，@Nested的执行顺序为先执行@Nested嵌套外层的用例，再以倒叙形式执行@Nested用例，然后再执行第二层嵌套的用例：
外层->倒叙嵌套->第二层嵌套

4. Junit5套件执行

套件介绍

注解	作用
@RunWith(JUnitPlatform.class)	执行套件
@SelectPackage({“com.packageA”,“com.packageB”})	创建测试套件
@SelectClasses( {a.class,b.class,c.class} )	创建测试套件
@IncludePackage(“包名”)	过滤需要执行的测试包
@ExcludePackages	过滤不需要执行的测试包
@IncludeClassNamePatterns	过滤需要执行的测试类
@ExcludeClassNamePatterns	过滤不需要执行的测试类
@IncludeTags(“production”)	过滤需要执行的测试方法
@ExcludeTags(“PROD”)	过滤不需要执行的测试方法

@RunWith 是从Junit4迁移过来的，@RunWith 连同它的参数 JUnitPlatform.class（一个基于 JUnit 4 且理解 JUnit Platform 的 Runner）让您可以在 Eclipse 内运行 JUnit Jupiter 单元测试。Eclipse 尚未原生支持 JUnit 5。未来，Eclipse 将提供原生的 JUnit 5 支持，那时我们不再需要此注解；Junit5官方给出了替代它的注解：