JUnit5学习之七：参数化测试(Parameterized Tests)进阶

曾经终败给现在 2022-12-12 12:24 72阅读 0赞

### 欢迎访问我的GitHub ###

> 这里分类和汇总了欣宸的全部原创(含配套源码)：[https://github.com/zq2599/blog\_demos][https_github.com_zq2599_blog_demos]

### 关于《JUnit5学习》系列 ###

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

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

### 本篇概览 ###

*  本文是《JUnit5学习》系列的第七篇，前文咱们对JUnit5的参数化测试(Parameterized Tests)有了基本了解，可以使用各种数据源控制测试方法多次执行，今天要在此基础上更加深入，掌握参数化测试的一些高级功能，解决实际问题；
 *  本文由以下章节组成：

1.  自定义数据源
2.  参数转换
3.  多字段聚合
4.  多字段转对象
5.  测试执行名称自定义

### 源码下载 ###

1.  如果您不想编码，可以在GitHub下载所有源码，地址和链接信息如下表所示：

<table> 
 <thead> 
  <tr> 
   <th align="left">名称</th> 
   <th align="left">链接</th> 
   <th align="left">备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">项目主页</td> 
   <td align="left">https://github.com/zq2599/blog_demos</td> 
   <td align="left">该项目在GitHub上的主页</td> 
  </tr> 
  <tr> 
   <td align="left">git仓库地址(https)</td> 
   <td align="left">https://github.com/zq2599/blog_demos.git</td> 
   <td align="left">该项目源码的仓库地址，https协议</td> 
  </tr> 
  <tr> 
   <td align="left">git仓库地址(ssh)</td> 
   <td align="left">git@github.com:zq2599/blog_demos.git</td> 
   <td align="left">该项目源码的仓库地址，ssh协议</td> 
  </tr> 
 </tbody> 
</table>

1.  这个git项目中有多个文件夹，本章的应用在junitpractice文件夹下，如下图红框所示：  
    ![在这里插入图片描述][20200926101440540.jpg_pic_left]
2.  junitpractice是父子结构的工程，本篇的代码在parameterized子工程中，如下图：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left]

### 自定义数据源 ###

1.  前文使用了很多种数据源，如果您对它们的各种限制不满意，想要做更彻底的个性化定制，可以开发ArgumentsProvider接口的实现类，并使用@ArgumentsSource指定；
2.  举个例子，先开发ArgumentsProvider的实现类MyArgumentsProvider.java：

package com.bolingcavalry.parameterized.service.impl;
    
    import org.junit.jupiter.api.extension.ExtensionContext;
    import org.junit.jupiter.params.provider.Arguments;
    import org.junit.jupiter.params.provider.ArgumentsProvider;
    import java.util.stream.Stream;
    
    public class MyArgumentsProvider implements ArgumentsProvider { 
    
        @Override
        public Stream<? extends Arguments> provideArguments(ExtensionContext context) throws Exception { 
            return Stream.of("apple4", "banana4").map(Arguments::of);
        }
    }

1.  再给测试方法添加@ArgumentsSource，并指定MyArgumentsProvider：

@Order(15)
        @DisplayName("ArgumentsProvider接口的实现类提供的数据作为入参")
        @ParameterizedTest
        @ArgumentsSource(MyArgumentsProvider.class)
        void argumentsSourceTest(String candidate) { 
            log.info("argumentsSourceTest [{}]", candidate);
        }

1.  执行结果如下：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 1]

### 参数转换 ###

1.  参数化测试的数据源和测试方法入参的数据类型必须要保持一致吗？其实JUnit5并没有严格要求，而事实上JUnit5是可以做一些自动或手动的类型转换的；
2.  如下代码，数据源是int型数组，但测试方法的入参却是double：

@Order(16)
        @DisplayName("int型自动转为double型入参")
        @ParameterizedTest
        @ValueSource(ints = {  1,2,3 })
        void argumentConversionTest(double candidate) { 
            log.info("argumentConversionTest [{}]", candidate);
        }

1.  执行结果如下，可见int型被转为double型传给测试方法（Widening Conversion）：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 2]
2.  还可以指定转换器，以转换器的逻辑进行转换，下面这个例子就是将字符串转为LocalDate类型，关键是@JavaTimeConversionPattern：

@Order(17)
        @DisplayName("string型，指定转换器，转为LocalDate型入参")
        @ParameterizedTest
        @ValueSource(strings = {  "01.01.2017", "31.12.2017" })
        void argumentConversionWithConverterTest(
                @JavaTimeConversionPattern("dd.MM.yyyy") LocalDate candidate) { 
            log.info("argumentConversionWithConverterTest [{}]", candidate);
        }

1.  执行结果如下：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 3]

### 字段聚合(Argument Aggregation) ###

1.  来思考一个问题：如果数据源的每条记录有多个字段，测试方法如何才能使用这些字段呢？
2.  回顾刚才的@CsvSource示例，如下图，可见测试方法用两个入参对应CSV每条记录的两个字段，如下所示：  
    ![在这里插入图片描述][20201006123555541.jpg_pic_left]
3.  上述方式应对少量字段还可以，但如果CSV每条记录有很多字段，那测试方法岂不是要定义大量入参？这显然不合适，此时可以考虑JUnit5提供的字段聚合功能(Argument Aggregation)，也就是将CSV每条记录的所有字段都放入一个ArgumentsAccessor类型的对象中，测试方法只要声明ArgumentsAccessor类型作为入参，就能在方法内部取得CSV记录的所有字段，效果如下图，可见CSV字段实际上是保存在ArgumentsAccessor实例内部的一个Object数组中：  
    ![在这里插入图片描述][2020100616403441.jpg_pic_center]
4.  如下图，为了方便从ArgumentsAccessor实例获取数据，ArgumentsAccessor提供了获取各种类型的方法，您可以按实际情况选用：  
    ![在这里插入图片描述][20201006164320682.jpg_pic_left]
5.  下面的示例代码中，CSV数据源的每条记录有三个字段，而测试方法只有一个入参，类型是ArgumentsAccessor，在测试方法内部，可以用ArgumentsAccessor的getString、get等方法获取CSV记录的不同字段，例如arguments.getString(0)就是获取第一个字段，得到的结果是字符串类型，而arguments.get(2, Types.class)的意思是获取第二个字段，并且转成了Type.class类型：

@Order(18)
        @DisplayName("CsvSource的多个字段聚合到ArgumentsAccessor实例")
        @ParameterizedTest
        @CsvSource({ 
                "Jane1, Doe1, BIG",
                "John1, Doe1, SMALL"
        })
        void argumentsAccessorTest(ArgumentsAccessor arguments) { 
            Person person = new Person();
            person.setFirstName(arguments.getString(0));
            person.setLastName(arguments.getString(1));
            person.setType(arguments.get(2, Types.class));
    
            log.info("argumentsAccessorTest [{}]", person);
        }

1.  上述代码执行结果如下图，可见通过ArgumentsAccessor能够取得CSV数据的所有字段：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 4]

### 更优雅的聚合 ###

1.  前面的聚合解决了获取CSV数据多个字段的问题，但依然有瑕疵：从ArgumentsAccessor获取数据生成Person实例的代码写在了测试方法中，如下图红框所示，测试方法中应该只有单元测试的逻辑，而创建Person实例的代码放在这里显然并不合适：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 5]
2.  针对上面的问题，JUnit5也给出了方案：通过注解的方式，指定一个从ArgumentsAccessor到Person的转换器，示例如下，可见测试方法的入参有个注解@AggregateWith，其值PersonAggregator.class就是从ArgumentsAccessor到Person的转换器，而入参已经从前面的ArgumentsAccessor变成了Person：

@Order(19)
        @DisplayName("CsvSource的多个字段，通过指定聚合类转为Person实例")
        @ParameterizedTest
        @CsvSource({ 
                "Jane2, Doe2, SMALL",
                "John2, Doe2, UNKNOWN"
        })
        void customAggregatorTest(@AggregateWith(PersonAggregator.class) Person person) { 
            log.info("customAggregatorTest [{}]", person);
        }

1.  PersonAggregator是转换器类，需要实现ArgumentsAggregator接口，具体的实现代码很简单，也就是从ArgumentsAccessor示例获取字段创建Person对象的操作：

package com.bolingcavalry.parameterized.service.impl;
    
    import org.junit.jupiter.api.extension.ParameterContext;
    import org.junit.jupiter.params.aggregator.ArgumentsAccessor;
    import org.junit.jupiter.params.aggregator.ArgumentsAggregationException;
    import org.junit.jupiter.params.aggregator.ArgumentsAggregator;
    
    public class PersonAggregator implements ArgumentsAggregator { 
    
        @Override
        public Object aggregateArguments(ArgumentsAccessor arguments, ParameterContext context) throws ArgumentsAggregationException { 
    
            Person person = new Person();
            person.setFirstName(arguments.getString(0));
            person.setLastName(arguments.getString(1));
            person.setType(arguments.get(2, Types.class));
    
            return person;
        }
    }

1.  上述测试方法的执行结果如下：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 6]

### 进一步简化 ###

1.  回顾一下刚才用注解指定转换器的代码，如下图红框所示，您是否回忆起JUnit5支持自定义注解这一茬，咱们来把红框部分的代码再简化一下：  
    ![在这里插入图片描述][20201006175212615.jpg_pic_left]
2.  新建注解类CsvToPerson.java，代码如下，非常简单，就是把上图红框中的@AggregateWith(PersonAggregator.class)搬过来了：

package com.bolingcavalry.parameterized.service.impl;
    
    import org.junit.jupiter.params.aggregator.AggregateWith;
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.PARAMETER)
    @AggregateWith(PersonAggregator.class)
    public @interface CsvToPerson { 
    }

1.  再来看看上图红框中的代码可以简化成什么样子，直接用@CsvToPerson就可以将ArgumentsAccessor转为Person对象了：

@Order(20)
        @DisplayName("CsvSource的多个字段，通过指定聚合类转为Person实例(自定义注解)")
        @ParameterizedTest
        @CsvSource({ 
                "Jane3, Doe3, BIG",
                "John3, Doe3, UNKNOWN"
        })
        void customAggregatorAnnotationTest(@CsvToPerson Person person) { 
            log.info("customAggregatorAnnotationTest [{}]", person);
        }

1.  执行结果如下，可见和@AggregateWith(PersonAggregator.class)效果一致：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 7]

### 测试执行名称自定义 ###

1.  文章最后，咱们来看个轻松的知识点吧，如下图红框所示，每次执行测试方法，IDEA都会展示这次执行的序号和参数值：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 8]
2.  其实上述红框中的内容格式也可以定制，格式模板就是@ParameterizedTest的name属性，修改后的测试方法完整代码如下，可见这里改成了中文描述信息：

@Order(21)
        @DisplayName("CSV格式多条记录入参(自定义展示名称)")
        @ParameterizedTest(name = "序号 [{index}]，fruit参数 [{0}]，rank参数 [{1}]")
        @CsvSource({ 
                "apple3, 31",
                "banana3, 32",
                "'lemon3, lime3', 0x3A"
        })
        void csvSourceWithCustomDisplayNameTest(String fruit, int rank) { 
            log.info("csvSourceWithCustomDisplayNameTest, fruit [{}], rank [{}]", fruit, rank);
        }

1.  执行结果如下：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 9]

*  至此，JUnit5的参数化测试(Parameterized)相关的知识点已经学习和实战完成了，掌握了这么强大的参数输入技术，咱们的单元测试的代码覆盖率和场景范围又可以进一步提升了；

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

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

[https_github.com_zq2599_blog_demos]: https://github.com/zq2599/blog_demos
[Link 1]: https://blog.csdn.net/boling_cavalry/article/details/108810587
[Assumptions]: https://blog.csdn.net/boling_cavalry/article/details/108861185
[Assertions]: https://blog.csdn.net/boling_cavalry/article/details/108899437
[Link 2]: https://blog.csdn.net/boling_cavalry/article/details/108909107
[Tag]: https://blog.csdn.net/boling_cavalry/article/details/108914091
[Parameterized Tests]: https://blog.csdn.net/boling_cavalry/article/details/108930987
[Parameterized Tests 1]: https://blog.csdn.net/boling_cavalry/article/details/108942301
[Link 3]: https://blog.csdn.net/boling_cavalry/article/details/108952500
[20200926101440540.jpg_pic_left]: /images/20221123/b80fa38b8cee4d25b2fbc7825b2756b0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left]: /images/20221123/88b9b7049981402898e61f4b6d19e1b3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 1]: /images/20221123/ef113acdb0094c37bd49a303a4a5f487.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 2]: /images/20221123/0262208cb17346a2a540fd300b14cf47.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 3]: /images/20221123/36aa9020c5c14395b4b29957ca4fb577.png
[20201006123555541.jpg_pic_left]: /images/20221123/0cd64c2014e042c783390fb49d92ce0b.png
[2020100616403441.jpg_pic_center]: /images/20221123/f3be8e9ddb5d482ebb4252e12df5acff.png
[20201006164320682.jpg_pic_left]: /images/20221123/b8ec80876b31489e8a2f3d7017f87935.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 4]: /images/20221123/f323b53f68694ca3a54f42c51638ed7d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 5]: /images/20221123/353e40b804144938a05c7f9bc516d86e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 6]: /images/20221123/364ed52e2bf24e39b961b81a95e6983b.png
[20201006175212615.jpg_pic_left]: /images/20221123/c493578eca1846bebac3777442731e40.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 7]: /images/20221123/cf92ff974664420c8710d63676d865eb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 8]: /images/20221123/e9bf4953eaff44bba7c7cab10dacf2a2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 9]: /images/20221123/6c4f4fd31812434da6210da180e9bf12.png