JUnit5参数化测试的几种方式！

用户321207420452
76 阅读4分钟

void testWithExplicitLocalMethodSource(String argument) { assertNotNull(argument); }

static Stream stringProvider() { return Stream.of("apple", "banana"); }


除非是`@TestInstance(Lifecycle.PER_CLASS)`生命周期，否则factory方法必须是static。factory方法的返回值是能转换为`Stream`的类型，比如`Stream`, `DoubleStream`, `LongStream`, `IntStream`, `Collection`, `Iterator`, `Iterable`, 对象数组, 或者基元类型数组，比如：

@ParameterizedTest @MethodSource("range") void testWithRangeMethodSource(int argument) { assertNotEquals(9, argument); }

static IntStream range() { return IntStream.range(0, 20).skip(10); }


`@MethodSource`的属性如果省略了，那么JUnit Jupiter会找跟测试方法同名的factory方法，比如：

@ParameterizedTest @MethodSource void testWithDefaultLocalMethodSource(String argument) { assertNotNull(argument); }

static Stream testWithDefaultLocalMethodSource() { return Stream.of("apple", "banana"); }


如果测试方法有多个参数，那么factory方法也应该返回多个：

@ParameterizedTest @MethodSource("stringIntAndListProvider") void testWithMultiArgMethodSource(String str, int num, List list) { assertEquals(5, str.length()); assertTrue(num >=1 && num <=2); assertEquals(2, list.size()); }

static Stream stringIntAndListProvider() { return Stream.of( arguments("apple", 1, Arrays.asList("a", "b")), arguments("lemon", 2, Arrays.asList("x", "y")) ); }


其中`arguments(Object…)`是Arguments接口的static factory method，也可以换成`Arguments.of(Object…)`。


factory方法也可以防止测试类外部：

package example;

import java.util.stream.Stream;

import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.MethodSource;

class ExternalMethodSourceDemo {

@ParameterizedTest
@MethodSource("example.StringsProviders#tinyStrings")
void testWithExternalMethodSource(String tinyString) {
    // test with tiny string
}

}

class StringsProviders {

static Stream<String> tinyStrings() {
    return Stream.of(".", "oo", "OOO");
}

}


### 5 `@CsvSource`


参数化的值为csv格式的数据（默认逗号分隔），比如：

@ParameterizedTest @CsvSource({ "apple, 1", "banana, 2", "'lemon, lime', 0xF1" }) void testWithCsvSource(String fruit, int rank) { assertNotNull(fruit); assertNotEquals(0, rank); }


delimiter属性可以设置分隔字符。delimiterString属性可以设置分隔字符串（String而非char）。


更多输入输出示例如下：



![image-20210714140242605](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/90c43520d3f7407384b366ab4f15609b~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzIxMjA3NDIwNDUy:q75.awebp?rk3s=f64ab15b&x-expires=1771136065&x-signature=fxE4EnMhETZcesqaRuw8C08HMRw%3D)


注意，如果null引用的目标类型是基元类型，那么会报异常`ArgumentConversionException`。


### 6 `@CsvFileSource`


顾名思义，选择本地csv文件作为数据来源。


示例：

@ParameterizedTest @CsvFileSource(resources = "/two-column.csv", numLinesToSkip = 1) void testWithCsvFileSourceFromClasspath(String country, int reference) { assertNotNull(country); assertNotEquals(0, reference); }

@ParameterizedTest @CsvFileSource(files = "src/test/resources/two-column.csv", numLinesToSkip = 1) void testWithCsvFileSourceFromFile(String country, int reference) { assertNotNull(country); assertNotEquals(0, reference); }


delimiter属性可以设置分隔字符。delimiterString属性可以设置分隔字符串（String而非char）。**需要特别注意的是，`#`开头的行会被认为是注释而略过。**


### 7 `@ArgumentsSource`


自定义ArgumentsProvider。


示例：

@ParameterizedTest @ArgumentsSource(MyArgumentsProvider.class) void testWithArgumentsSource(String argument) { assertNotNull(argument); }

public class MyArgumentsProvider implements ArgumentsProvider {

@Override
public Stream<? extends Arguments> provideArguments(ExtensionContext context) {
    return Stream.of("apple", "banana").map(Arguments::of);
}

}


MyArgumentsProvider必须是外部类或者static内部类。



## 参数类型转换



### 隐式转换


JUnit Jupiter会对String类型进行隐式转换。比如：

@ParameterizedTest @ValueSource(strings = "SECONDS") void testWithImplicitArgumentConversion(ChronoUnit argument) { assertNotNull(argument.name()); }


更多转换示例：



![image-20210714143735484](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/0ab0bbddee514770809e6d3827285031~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzIxMjA3NDIwNDUy:q75.awebp?rk3s=f64ab15b&x-expires=1771136065&x-signature=ZsPpGfS1gb%2Fox%2FNMzs0mDDrSCCY%3D)



![Dingtalk_20210714143207](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/c3e72fe6f0e749b3868a5e952da1eefe~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzIxMjA3NDIwNDUy:q75.awebp?rk3s=f64ab15b&x-expires=1771136065&x-signature=MwSbs5JB6WrYLhorUpf29GJSXG0%3D)


也可以把String转换为自定义对象：

@ParameterizedTest @ValueSource(strings = "42 Cats") void testWithImplicitFallbackArgumentConversion(Book book) { assertEquals("42 Cats", book.getTitle()); }

public class Book {

private final String title;

private Book(String title) {
    this.title = title;
}

public static Book fromTitle(String title) {
    return new Book(title);
}

public String getTitle() {
    return this.title;
}

}


JUnit Jupiter会找到`Book.fromTitle(String)`方法，然后把`@ValueSource`的值传入进去，进而把String类型转换为Book类型。转换的factory方法既可以是接受单个String参数的构造方法，也可以是接受单个String参数并返回目标类型的普通方法。详细规则如下（官方原文）：



![image-20210714145601731](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/979341ebcdf74021b89c871e53cf92a2~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzIxMjA3NDIwNDUy:q75.awebp?rk3s=f64ab15b&x-expires=1771136065&x-signature=aNp6oVKIVP88djIh8bMOZjJzv6Q%3D)


### 显式转换


显式转换需要使用`@ConvertWith`注解：

@ParameterizedTest @EnumSource(ChronoUnit.class) void testWithExplicitArgumentConversion( @ConvertWith(ToStringArgumentConverter.class) String argument) {

assertNotNull(ChronoUnit.valueOf(argument));

}


并实现ArgumentConverter：

public class ToStringArgumentConverter extends SimpleArgumentConverter {

@Override
protected Object convert(Object source, Class<?> targetType) {
    assertEquals(String.class, targetType, "Can only convert to String");
    if (source instanceof Enum<?>) {
        return ((Enum<?>) source).name();
    }
    return String.valueOf(source);
}

}


如果只是简单类型转换，实现TypedArgumentConverter即可：

public class ToLengthArgumentConverter extends TypedArgumentConverter<String, Integer> {

protected ToLengthArgumentConverter() {
    super(String.class, Integer.class);
}

@Override
protected Integer convert(String source) {
    return source.length();
}

}


JUnit Jupiter只内置了一个JavaTimeArgumentConverter，通过`@JavaTimeConversionPattern`使用：

@ParameterizedTest @ValueSource(strings = { "01.01.2017", "31.12.2017" }) void testWithExplicitJavaTimeConverter( @JavaTimeConversionPattern("dd.MM.yyyy") LocalDate argument) {

assertEquals(2017, argument.getYear());

}


## 参数聚合


测试方法的多个参数可以聚合为一个ArgumentsAccessor参数，然后通过get来取值，示例：

@ParameterizedTest @CsvSource({ "Jane, Doe, F, 1990-05-20", "John, Doe, M, 1990-10-22" }) void testWithArgumentsAccessor(ArgumentsAccessor arguments) { Person person = new Person(arguments.getString(0), arguments.getString(1), arguments.get(2, Gender.class), arguments.get(3, LocalDate.class));

if (person.getFirstName().equals("Jane")) {
    assertEquals(Gender.F, person.getGender());
}
else {
    assertEquals(Gender.M, person.getGender());
}
assertEquals("Doe", person.getLastName());
assertEquals(1990, person.getDateOfBirth().getYear());

}


也可以自定义Aggregator：

public class PersonAggregator implements ArgumentsAggregator { @Override public Person aggregateArguments(ArgumentsAccessor arguments, ParameterContext context) { return new Person(arguments.getString(0), arguments.getString(1), arguments.get(2, Gender.class), arguments.get(3, LocalDate.class)); } }


然后通过`@AggregateWith`来使用：

@ParameterizedTest @CsvSource({ "Jane, Doe, F, 1990-05-20", "John, Doe, M, 1990-10-22" }) void testWithArgumentsAggregator(@AggregateWith(PersonAggregator.class) Person person) { // perform assertions against person }


借助于组合注解，我们可以进一步简化代码：

@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.PARAMETER) @AggregateWith(PersonAggregator.class) public @interface CsvToPerson { }

@ParameterizedTest @CsvSource({ "Jane, Doe, F, 1990-05-20", "John, Doe, M, 1990-10-22" }) void testWithCustomAggregatorAnnotation(@CsvToPerson Person person) { // perform assertions against person }


## 自定义显示名字


参数化测试生成的test，JUnit Jupiter给定了默认名字，我们可以通过name属性进行自定义。


示例：

@DisplayName("Display name of container") @ParameterizedTest(name = "{index} ==> the rank of ''{0}'' is {1}") @CsvSource({ "apple, 1", "banana, 2", "'lemon, lime', 3" }) void testWithCustomDisplayNames(String fruit, int rank) { }

avatar
文章
阅读
粉丝