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

程式設計師欣宸發表於2021-02-28
Zed

歡迎訪問我的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下載所有原始碼，地址和連結資訊如下表所示：
名稱 連結 備註
專案主頁 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. 前文使用了很多種資料來源，如果您對它們的各種限制不滿意，想要做更徹底的個性化定製，可以開發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. 執行結果如下：

在這裡插入圖片描述

引數轉換

  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）：

在這裡插入圖片描述

  1. 還可以指定轉換器，以轉換器的邏輯進行轉換，下面這個例子就是將字串轉為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. 執行結果如下：

在這裡插入圖片描述

欄位聚合(Argument Aggregation)

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

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

在這裡插入圖片描述
4. 如下圖，為了方便從ArgumentsAccessor例項獲取資料，ArgumentsAccessor提供了獲取各種型別的方法，您可以按實際情況選用：

在這裡插入圖片描述

  1. 下面的示例程式碼中，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資料的所有欄位：

在這裡插入圖片描述

更優雅的聚合

  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);
    }
  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. 上述測試方法的執行結果如下：

在這裡插入圖片描述

進一步簡化

  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 {
}
  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)效果一致：

在這裡插入圖片描述

測試執行名稱自定義

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

在這裡插入圖片描述

  1. 其實上述紅框中的內容格式也可以定製，格式模板就是@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. 執行結果如下：

在這裡插入圖片描述

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

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

  1. Java系列
  2. Spring系列
  3. Docker系列
  4. kubernetes系列
  5. 資料庫+中介軟體系列
  6. DevOps系列

歡迎關注公眾號：程式設計師欣宸

微信搜尋「程式設計師欣宸」，我是欣宸，期待與您一同暢遊Java世界...
https://github.com/zq2599/blog_demos

相關文章