JUnit5學習之七：引數化測驗(Parameterized Tests)進階

歡迎訪問我的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學習》系列的第七篇，前文咱們對JUnit5的引數化測驗(Parameterized Tests)有了基本了解，可以使用各種資料源控制測驗方法多次執行，今天要在此基礎上更加深入，掌握引數化測驗的一些高級功能，解決實際問題；
• 本文由以下章節組成：

1. 自定義資料源
2. 引數轉換
3. 多欄位聚合
4. 多欄位轉物件
5. 測驗執行名稱自定義

原始碼下載

1. 如果您不想編碼，可以在GitHub下載所有原始碼，地址和鏈接資訊如下表所示：

2. 這個git專案中有多個檔案夾，本章的應用在junitpractice檔案夾下，如下圖紅框所示：

3. junitpractice是父子結構的工程，本篇的代碼在parameterized子工程中，如下圖：

自定義資料源

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);
    }
}

3. 再給測驗方法添加@ArgumentsSource，并指定MyArgumentsProvider：

    @Order(15)
    @DisplayName("ArgumentsProvider介面的實作類提供的資料作為入參")
    @ParameterizedTest
    @ArgumentsSource(MyArgumentsProvider.class)
    void argumentsSourceTest(String candidate) {
        log.info("argumentsSourceTest [{}]", candidate);
    }

4. 執行結果如下：

引數轉換

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);
    }

3. 執行結果如下，可見int型被轉為double型傳給測驗方法（Widening Conversion）：

4. 還可以指定轉換器，以轉換器的邏輯進行轉換，下面這個例子就是將字串轉為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);
    }

5. 執行結果如下：

欄位聚合(Argument Aggregation)

1. 來思考一個問題：如果資料源的每條記錄有多個欄位，測驗方法如何才能使用這些欄位呢？
2. 回顧剛才的@CsvSource示例，如下圖，可見測驗方法用兩個入參對應CSV每條記錄的兩個欄位，如下所示：

3. 上述方式應對少量欄位還可以，但如果CSV每條記錄有很多欄位，那測驗方法豈不是要定義大量入參？這顯然不合適，此時可以考慮JUnit5提供的欄位聚合功能(Argument Aggregation)，也就是將CSV每條記錄的所有欄位都放入一個ArgumentsAccessor型別的物件中，測驗方法只要宣告ArgumentsAccessor型別作為入參，就能在方法內部取得CSV記錄的所有欄位，效果如下圖，可見CSV欄位實際上是保存在ArgumentsAccessor實體內部的一個Object陣列中：

4. 如下圖，為了方便從ArgumentsAccessor實體獲取資料，ArgumentsAccessor提供了獲取各種型別的方法，您可以按實際情況選用：

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);
    }

6. 上述代碼執行結果如下圖，可見通過ArgumentsAccessor能夠取得CSV資料的所有欄位：

更優雅的聚合

1. 前面的聚合解決了獲取CSV資料多個欄位的問題，但依然有瑕疵：從ArgumentsAccessor獲取資料生成Person實體的代碼寫在了測驗方法中，如下圖紅框所示，測驗方法中應該只有單元測驗的邏輯，而創建Person實體的代碼放在這里顯然并不合適：

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);
    }

3. 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;
    }
}

4. 上述測驗方法的執行結果如下：

進一步簡化

1. 回顧一下剛才用注解指定轉換器的代碼，如下圖紅框所示，您是否回憶起JUnit5支持自定義注解這一茬，咱們來把紅框部分的代碼再簡化一下：

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 {
}

3. 再來看看上圖紅框中的代碼可以簡化成什么樣子，直接用@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);
    }

4. 執行結果如下，可見和@AggregateWith(PersonAggregator.class)效果一致：

測驗執行名稱自定義

1. 文章最后，咱們來看個輕松的知識點吧，如下圖紅框所示，每次執行測驗方法，IDEA都會展示這次執行的序號和引數值：

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);
    }

3. 執行結果如下：

• 至此，JUnit5的引數化測驗(Parameterized)相關的知識點已經學習和實戰完成了，掌握了這么強大的引數輸入技術，咱們的單元測驗的代碼覆寫率和場景范圍又可以進一步提升了；

你不孤單，欣宸原創一路相伴

1. Java系列
2. Spring系列
3. Docker系列
4. kubernetes系列
5. 資料庫+中間件系列
6. DevOps系列

歡迎關注公眾號：程式員欣宸

微信搜索「程式員欣宸」，我是欣宸，期待與您一同暢游Java世界...
https://github.com/zq2599/blog_demos

標籤：其他

上一篇：基于keras實作的中文物體識別

下一篇：非常干貨：Python 探針實作原理