JUnit5学习之六：参数化测试(Parameterized Tests)基础

时间  2021-02-27
标签 java git 程序员 github web spring 数据库 apache api 数组 栏目 Java 繁體版
原文   原文链接

欢迎访问个人GitHub

https://github.com/zq2599/blog_demosjava

内容：全部原创文章分类汇总及配套源码，涉及Java、Docker、Kubernetes、DevOPS等；git

关于《JUnit5学习》系列

《JUnit5学习》系列旨在经过实战提高SpringBoot环境下的单元测试技能，一共八篇文章，连接以下：程序员

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

本篇概览

  • 本文是《JUnit5学习》系列的第六篇，一块儿来实战强大参数化测试(Parameterized Tests)，即屡次执行同一个测试方法，每次使用不一样的参数；
  • 因为参数化测试功能强大，内容也比前几篇的知识点多，为了方便你们阅读和实践，这里分为《基础》和《进阶》两篇来介绍，本篇以学习参数化测试(Parameterized Tests)的基础知识为主，包含如下内容：
  1. 极速体验；
  2. 版本依赖；
  3. ValueSource数据源
  4. null、空字符串数据源
  5. 枚举数据源
  6. 方法数据源
  7. Csv格式数据源
  8. Csv文件数据源

源码下载

  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是父子结构的工程，本篇的代码在parameterized子工程中，以下图：

在这里插入图片描述

极速体验

  1. 如今，我们以最少的步骤体验最简单的参数化测试；
  2. 在父工程junitpractice里新建名为parameterized的子工程，pom.xml内容以下：
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.bolingcavalry</groupId>
        <artifactId>junitpractice</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <groupId>com.bolingcavalry</groupId>
    <artifactId>parameterized</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>parameterized</name>
    <description>Demo project for parameterized expirence in Spring Boot junit</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.junit</groupId>
                <artifactId>junit-bom</artifactId>
                <version>5.7.0</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>

    </dependencyManagement>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.jupiter</groupId>
                    <artifactId>junit-jupiter</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>
  1. 新建测试类HelloTest.java，在这个位置：junitpractice\parameterized\src\test\java\com\bolingcavalry\parameterized\service\impl，内容以下：
package com.bolingcavalry.parameterized.service.impl;

import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.MethodOrderer;
import org.junit.jupiter.api.Order;
import org.junit.jupiter.api.TestMethodOrder;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import org.springframework.boot.test.context.SpringBootTest;
import static org.junit.jupiter.api.Assertions.assertTrue;

@SpringBootTest
@Slf4j
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
public class HelloTest {

    @Order(1)
    @DisplayName("多个字符串型入参")
    @ParameterizedTest
    @ValueSource(strings = { "a", "b", "c" })
    void stringsTest(String candidate) {
        log.info("stringsTest [{}]", candidate);
        assertTrue(null!=candidate);
    }
}
  1. 执行该测试类，结果以下图：

在这里插入图片描述
5. 从上图可见执行参数化测试须要两步：首先用@ParameterizedTest取代@Test，表名此方法要执行参数化测试，而后用@ValueSource指定每次测试时的参数来自字符串类型的数组：{ "a", "b", "c" }，每一个元素执行一次；
6. 至此，我们已体验过最简单的参数化测试，可见就是想办法使一个测试方法屡次执行，每次都用不一样的参数，接下来有关参数化测试的更多配置和规则将配合实战编码逐个展开，一块儿来体验吧；github

版本要求

  • 先看看SpringBoot-2.3.4.RELEASE间接依赖的junit-jupiter-5.6.2版本中，ParameterizedTest的源码，以下图红框所示，此时的ParameterizedTest还只是体验版：

在这里插入图片描述

  • 再看看junit-jupiter-5.7.0版本的ParameterizedTest源码，此时已是稳定版了：

在这里插入图片描述

  • 综上所述，若是要使用参数化测试，最好是将junit-jupiter升级到5.7.0或更高版本，若是您的应用使用了SpringBoot框架，junit-jupiter是被spring-boot-starter-test间接依赖进来的，须要排除这个间接依赖，再手动依赖进来才能确保使用指定版本，在pom.xml中执行以下三步操做：
  1. dependencyManagement节点添加junit-bom，并指定版本号：
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.junit</groupId>
      <artifactId>junit-bom</artifactId>
      <version>5.7.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
  1. 排除spring-boot-starter-test和junit-jupiter的间接依赖关系：
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-test</artifactId>
  <scope>test</scope>
  <exclusions>
    <exclusion>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter</artifactId>
    </exclusion>
  </exclusions>
</dependency>
  1. 添加junit-jupiter依赖，此时会使用dependencyManagement中指定的版本号：
<dependency>
  <groupId>org.junit.jupiter</groupId>
  <artifactId>junit-jupiter</artifactId>
  <scope>test</scope>
</dependency>
  1. 以下图，刷新可见已经用上了5.7.0版本：

在这里插入图片描述

  • 版本问题解决了，接下来正式开始学习Parameterized Tests，先要了解的是有哪些数据源；

ValueSource数据源

  1. ValueSource是最简单经常使用的数据源，支持如下类型的数组：
short

    byte

    int

    long

    float

    double

    char

    boolean

    java.lang.String
    
    java.lang.Class
  1. 下面是整形数组的演示：
@Order(2)
    @DisplayName("多个int型入参")
    @ParameterizedTest
    @ValueSource(ints = { 1,2,3 })
    void intsTest(int candidate) {
        log.info("ints [{}]", candidate);
        assertTrue(candidate<3);
    }
  1. 从上述代码可见，入参等于3的时候assertTrue没法经过，测试方法会失败，来看看实际执行效果，以下图：

在这里插入图片描述

null、空字符串数据源

  1. 在用字符串做为入参时，一般要考虑入参为null的状况，此时ValueSource通常会这样写：
@ValueSource(strings = { null, "a", "b", "c" })
  1. 此时可使用@NullSource注解来取代上面的null元素，下面这种写法和上面的效果如出一辙：
@NullSource
    @ValueSource(strings = { "a", "b", "c" })
  1. 执行结果以下图红框，可见null做为入参被执行了一次：

在这里插入图片描述
4. 与@NullSource表明null入参相似，@EmptySource表明空字符串入参，用法和执行结果以下图所示：web

在这里插入图片描述
5. 若是想同时用null和空字符串作测试方法的入参，可使用@NullAndEmptySource，用法和执行结果以下图所示：spring

在这里插入图片描述

枚举数据源(EnumSource)

  1. EnumSource可让一个枚举类中的所有或者部分值做为测试方法的入参；
  2. 建立枚举类Types.java，用于接下来的实战，以下，很简单只有三个值：
public enum Types {
    SMALL,
    BIG,
    UNKNOWN
}
  1. 先尝试用Types的每一个值做为入参执行测试，可见只要添加@EnumSource便可，JUnit根据测试方法的入参类型知道要使用哪一个枚举：
@Order(6)
    @DisplayName("多个枚举型入参")
    @ParameterizedTest
    @EnumSource
    void enumSourceTest(Types type) {
        log.info("enumSourceTest [{}]", type);
    }
  1. 执行结果以下图所示：

在这里插入图片描述
5. 若是不想执行枚举的全部值，而只要其中一部分，能够在name属性中指定：数据库

@EnumSource(names={"SMALL", "UNKNOWN"})
  1. 执行结果以下图所示：

在这里插入图片描述
7. 也能够指定哪些值不被执行，此时要添加mode属性并设置为EXCLUDE（mode属性若是不写，默认值是INCLUDE，前面的例子中就是默认值）：apache

@EnumSource(mode= EnumSource.Mode.EXCLUDE, names={"SMALL", "UNKNOWN"})
  1. 执行结果以下，可见SMALL和UNKNOWN都没有执行：

在这里插入图片描述

方法数据源(MethodSource)

  1. @MethodSource能够指定一个方法名称，该方法返回的元素集合做为测试方法的入参；
  2. 先来定义一个方法，该方法通常是static类型(不然要用@TestInstance修饰)，而且返回值是Stream类型：
static Stream<String> stringProvider() {
        return Stream.of("apple1", "banana1");
    }
  1. 而后，测试方法用@MethodSource，并指定方法名stringProvider：
@Order(9)
    @DisplayName("静态方法返回集合，用此集合中每一个元素做为入参")
    @ParameterizedTest
    @MethodSource("stringProvider")
    void methodSourceTest(String candidate) {
        log.info("methodSourceTest [{}]", candidate);
    }
  1. 上面的stringProvider方法和测试方法methodSourceTest在同一个类中，若是它们不在同一个类中，就要指定静态方法的整个package路径、类名、方法名，以下所示，类名和方法名之间用#链接：
@Order(10)
    @DisplayName("静态方法返回集合，该静态方法在另外一个类中")
    @ParameterizedTest
    @MethodSource("com.bolingcavalry.parameterized.service.impl.Utils#getStringStream")
    void methodSourceFromOtherClassTest(String candidate) {
        log.info("methodSourceFromOtherClassTest [{}]", candidate);
    }
  1. 若是不在@MethodSource中指定方法名，JUnit会寻找和测试方法同名的静态方法，举例以下，静态方法methodSourceWithoutMethodNameTest会被做为测试方法的数据来源：
static Stream<String> methodSourceWithoutMethodNameTest() {
        return Stream.of("apple3", "banana3");
    }

    @Order(11)
    @DisplayName("静态方法返回集合，不指定静态方法名，自动匹配")
    @ParameterizedTest
    @MethodSource
    void methodSourceWithoutMethodNameTest(String candidate) {
        log.info("methodSourceWithoutMethodNameTest [{}]", candidate);
    }
  1. 执行结果以下：

在这里插入图片描述

Csv格式数据源(CsvSource)

  1. 前面的测试方法入参都只有一个，在面对多个入参的测试方法时，@CsvSource就派上用场了，演示代码以下所示，可见数据是普通的CSV格式，每条记录有两个字段，对应测试方法的两个入参：
@Order(12)
    @DisplayName("CSV格式多条记录入参")
    @ParameterizedTest
    @CsvSource({
            "apple1, 11",
            "banana1, 12",
            "'lemon1, lime1', 0x0A"
    })
    void csvSourceTest(String fruit, int rank) {
        log.info("csvSourceTest, fruit [{}], rank [{}]", fruit, rank);
    }
  1. 执行结果以下，经过日志能够肯定，每条记录的两个字段能匹配到测试方法的两个入参中：

在这里插入图片描述

  1. 另外@CsvSource还提供了一个属性nullValues，做用是将指定的字符串识别为null，下面这个设置就是把CSV数据中全部的NIL识别为null，再传给测试方法：
@Order(13)
    @DisplayName("CSV格式多条记录入参(识别null)")
    @ParameterizedTest
    @CsvSource(value = {
            "apple2, 21",
            "banana2, 22",
            "'lemon2, lime2', 0x0A",
            "NIL, 3" },
            nullValues = "NIL"
    )
    void csvSourceWillNullTokenTest(String fruit, int rank) {
        log.info("csvSourceWillNullTokenTest, fruit [{}], rank [{}]", fruit, rank);
    }
  1. 执行结果以下，可见字符串NIL到测试方法后已变成null：

在这里插入图片描述

Csv文件数据源

  1. @CsvSource解决了测试方法入参有多个字段的问题，可是把做为入参的测试数据写在源文件中彷佛不合适，尤为是数据量很大的状况下，这种场景适合用@CsvFileSource，该注解用于指定csv文件做为数据源，注意numLinesToSkip属性指定跳过的行数，能够用来跳过表头：
@Order(14)
    @DisplayName("CSV文件多条记录入参")
    @ParameterizedTest
    @CsvFileSource(files = "src/test/resources/two-column.csv", numLinesToSkip = 1)
    void csvFileTest(String country, int reference) {
        log.info("csvSourceTest, country [{}], reference [{}]", country, reference);
    }
  1. 在src/test/resources/建立文件two-column.csv，内容以下：
Country, reference
Sweden, 1
Poland, 2
"United States of America", 3
  1. 上述代码执行结果以下，代码中没有测试数据，显得更加简洁一些：

在这里插入图片描述

期待《进阶》篇

  • 至此，我们队JUnit5的参数化测试(Parameterized)有了初步的了解，能够经过各类数据源注解给测试方法制造更多的参数，但仅掌握这些仍是不够的，依然有一些问题待解决，例如更自由的数据源定制、跟完善的多字段处理方案等等，下一篇《进阶》我们一块儿来体验更多参数化测试的高级功能；

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

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

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

微信搜索「程序员欣宸」，我是欣宸，期待与您一同畅游Java世界...
https://github.com/zq2599/blog_demosapi

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程