JUnit 5简明教程

概述

写测试用例对于开发来说有2点好处，一是开发阶段写完的功能可以快速验证，第二就是在后期需求变动或修改BUG后可以快速测试当前改动是否带来其它问题。下面就了解一下Junit5写测试用例。
准备

创建一个maven项目

1. mkdir junit5-tutorial
2. cd junit5-tutorial
4. mkdir -p src/main/java
5. mkdir -p src/test/java
7. mkdir -p src/main/resources
8. mkdir -p src/test/resources
10. # 编写pom.xml
11. vi pom.xml

复制代码

添加依赖

• 引入第三方断言库assertj
  
• 支持json测试
  
• 支持xml测试
  

pom.xml

1. <?xml version="1.0" encoding="UTF-8"?>
3. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5.     <modelVersion>4.0.0</modelVersion>
7.     <groupId>com.example.xxx</groupId>
8.     <artifactId>junit5-tutorial</artifactId>
9.     <version>1.0-SNAPSHOT</version>
11.     <name>junit5-tutorial</name>
13.     <url>https://www.xxx.com</url>
15.     <properties>
16.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
17.         <maven.compiler.source>17</maven.compiler.source>
18.         <maven.compiler.target>17</maven.compiler.target>
19.     </properties>
21.     <build>
22.         <pluginManagement>
23.             <plugins>
24.                
25.                
26.                 <plugin>
27.                     <artifactId>maven-surefire-plugin</artifactId>
28.                     <version>3.0.0-M6</version>
29.                 </plugin>
30.                
31.                 <plugin>
32.                     <artifactId>maven-compiler-plugin</artifactId>
33.                     <version>3.10.1</version>
34.                 </plugin>
35.             </plugins>
36.         </pluginManagement>
38.     </build>
40.     <dependencyManagement>
41.         <dependencies>
42.             
43.             <dependency>
44.                 <groupId>net.bytebuddy</groupId>
45.                 <artifactId>byte-buddy</artifactId>
46.                 <version>1.12.10</version>
47.             </dependency>
48.             <dependency>
49.                 <groupId>net.bytebuddy</groupId>
50.                 <artifactId>byte-buddy-agent</artifactId>
51.                 <version>1.12.10</version>
52.                 <scope>test</scope>
53.             </dependency>
55.             
56.             <dependency>
57.                 <groupId>org.mockito</groupId>
58.                 <artifactId>mockito-junit-jupiter</artifactId>
59.                 <version>4.5.1</version>
60.                 <scope>test</scope>
61.             </dependency>
62.         </dependencies>
63.     </dependencyManagement>
65.     <dependencies>
67.         <dependency>
68.             <groupId>org.assertj</groupId>
69.             <artifactId>assertj-core</artifactId>
70.             <version>3.22.0</version>
71.             <scope>test</scope>
72.         </dependency>
73.         <dependency>
74.             <groupId>io.github.classgraph</groupId>
75.             <artifactId>classgraph</artifactId>
76.             <version>4.8.146</version>
77.         </dependency>
78.         <dependency>
79.             <groupId>org.junit.jupiter</groupId>
80.             <artifactId>junit-jupiter</artifactId>
81.             <version>5.8.2</version>
82.         </dependency>
84.         
85.         <dependency>
86.             <groupId>net.javacrumbs.json-unit</groupId>
87.             <artifactId>json-unit-assertj</artifactId>
88.             <version>2.33.0</version>
89.             <scope>test</scope>
90.         </dependency>
91.         <dependency>
92.             <groupId>com.fasterxml.jackson.core</groupId>
93.             <artifactId>jackson-databind</artifactId>
94.             <version>2.13.2.2</version>
95.         </dependency>
96.         <dependency>
97.             <groupId>com.fasterxml.jackson.datatype</groupId>
98.             <artifactId>jackson-datatype-jsr310</artifactId>
99.             <version>2.13.2</version>
100.         </dependency>
102.         
103.         <dependency>
104.             <groupId>org.xmlunit</groupId>
105.             <artifactId>xmlunit-assertj</artifactId>
106.             <version>2.9.0</version>
107.             <scope>test</scope>
108.         </dependency>
110.     </dependencies>
111. </project>

复制代码

创建一个User

1. public record User(String name, Integer age, Boolean blocked, LocalDate birthDate) {
2. }

复制代码

测试

测试用例命名最佳实践

首先测试类名应该以Test结尾，测试用例名称最好遵从以下规则

• 测试名称应表达特定要求
  
• 测试名称应包含预期的输入或预期的结果
  
• 测试名称应以陈述的形式
  

具体参考：https://osherove.com/blog/2005/4/3/naming-standards-for-unit-tests.html
断言

1. @Test
2. @DisplayName("User should be at least 18")
3. void user_should_be_at_least_18() {
4.     // junit5 的断言
5.     assertTrue(user.age() >= 18);
6.     // assertj 的断言
7.     assertThat(user.age()).isGreaterThanOrEqualTo(18);
8. }

复制代码

显示名称

测试类和测试方法可以声明自定义显示名称，可以使用空格、特殊字符、甚至emojis表情符号，这些名称会在runner和测试报告中显示。

参数化测试

参数化测试可以用不同的参数多次运行测试。它们和普通的@Test方法一样声明，但是使用@ParameterizedTest注解。还必须声明至少一个将为每次调用提供参数的来
使用@ValueSource来指定参数来源

它可以指定一个原生类型的数组，并且只能为每次调用提供一个参数

1. @ParameterizedTest
2. @ValueSource(ints = {20, 50, 80})
3. void test_value_source(int age) {
4.     assertThat(age).isGreaterThanOrEqualTo(18);
5. }

复制代码

读取CSV文件内容作为参数来源

它可以让你使用classpath中的csv文件。csv文件中的每一行都会导致参数测试的一次调用
src/test/resources/friends.csv

1. name,age
2. lisa,20
3. hans,30
4. hanna,40

复制代码

1. @ParameterizedTest
2. @CsvFileSource(resources = "/friends.csv", numLinesToSkip = 1)
3. void test_value_source_by_csv_file_source(String name, int age) {
4.     assertThat(age).isGreaterThanOrEqualTo(18);
5. }

复制代码

标签

我们可以给测试类或测试用例上面通过@Tag加标签，执行测试的时候可以指定标签，从而达到为测试用例分组的目的。
下面就给测试类打上一个integration的标签

1. @Tag("integration")
2. class User01Test {
3.     // ...
4. }

复制代码

可以使用如下命令来指定要执行的测试用例：

1. mvn test -Dgroups="integration"

复制代码

左侧只执行了Running com.example.xxx.User01Test一个测试类，右侧则执行了3个
总结

本文介绍了如何使用Junit5写测试用例。
参考

• Unit test naming best practices Unit test naming best practices - Stack Overflow
  
• https://osherove.com/blog/2005/4/3/naming-standards-for-unit-tests.html
  
• AssertJ Homepage https://assertj.github.io/doc/
  
• Gradle: https://stackoverflow.com/a/64986861
  
• https://junit.org/junit5/docs/current/user-guide/#running-tests-tag-expressions
  
• further reading
  
• JUnit 5 User Guide
  
• JUnit 5 中文文档 https://doczhcn.gitbook.io/junit5/
  
• AssertJ - fluent assertions java library
  
• Jupiter / JUnit 5 - Testcontainers
  
• awaitility/awaitility: Awaitility is a small Java DSL for synchronizing asynchronous operations (github.com)
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！