Junit5 @ParameterizedTest 如何将数组作为参数之一传递

Question

我有一个测试，我想传递三个参数：

1. 字符串
2. 枚举
3. 字符串数组

示例：

@ParameterizedTest
    @CsvSource({
            "/path/to/first/file.xlsx, FIRST, {THIRD PARAMETER SHOULD BE ARRAY OF STRINGS}",
            "/path/to/second/file.xlsx, SECOND, {THIRD PARAMETER SHOULD BE ARRAY OF STRINGS}"})
    void uploadFile(String path, FileType type, String[] errors) {
        HttpEntity httpEntity = prepareFileUploadEntity(path, type);

        ResponseEntity<ArrayList> response = getRestTemplate(AppRole.USER).exchange(UPLOAD_URL, HttpMethod.POST, httpEntity, ArrayList.class);

        assertNotNull(response);
        assertEquals(HttpStatus.BAD_REQUEST, response.getStatusCode());
        assertEquals(errors.length, response.getBody().size());
        for (String error : errors) {
            assertTrue(response.getBody().contains(error));
        }
    }

我该如何将第三个参数传递为一个字符串数组？因为现在我遇到了第三个参数无法解析的错误。

org.junit.jupiter.api.extension.ParameterResolutionException: Error resolving parameter at index 2

- Volodymyr Nazarenko

Answer 1

@CsvSource使用隐式转换将CSV值转换为基本类型、枚举或日期。对于其他类型，如数组，则需要显式转换。

假设你有一个格式为@CsvSource("abc, 123, 'foo, bar'")的CSV注释，你可以像这样实现参数转换器，以将最后一个CSV列视为数组：

import org.junit.jupiter.params.converter.ArgumentConversionException;
import org.junit.jupiter.params.converter.SimpleArgumentConverter;

public class StringArrayConverter extends SimpleArgumentConverter {

    @Override
    protected Object convert(Object source, Class<?> targetType) throws ArgumentConversionException {
        if (source instanceof String && String[].class.isAssignableFrom(targetType)) {
            return ((String) source).split("\\s*,\\s*");
        } else {
            throw new IllegalArgumentException("Conversion from " + source.getClass() + " to "
                                               + targetType + " not supported.");
        }
    }

}

然后您可以在第三个参数上使用该转换器：

@ParameterizedTest
@CsvSource("abc, 123, 'foo, bar'")
void test(String column1, int column2, @ConvertWith(StringArrayConverter.class) String[] column3) {
    assertEquals(column1, "abc");
    assertEquals(column2, 123);
    assertEquals(column3[0], "foo");
    assertEquals(column3[1], "bar");
}

- kapex

Answer 2

稍作更正，在

return ((String) source).split("\\s*,\\s*");

应该使用不同的符号（例如';'）而不是','。

然后在测试中应该是：

@ParameterizedTest
@CsvSource("abc, 123, foo; bar")

最终版本适用于我的情况：

import org.junit.jupiter.params.converter.ArgumentConversionException;
import org.junit.jupiter.params.converter.SimpleArgumentConverter;

public class StringArrayConverter extends SimpleArgumentConverter {

    @Override
    protected Object convert(Object source, Class<?> targetType) throws ArgumentConversionException {
        if (source instanceof String && String[].class.isAssignableFrom(targetType)) {
            return ((String) source).split("\\s*;\\s*");
        } else {
            throw new IllegalArgumentException("Conversion from " + source.getClass() + " to "
                                               + targetType + " not supported.");
        }
    }

}

测试：

@ParameterizedTest
@CsvSource("abc, 123, foo; bar")
void test(String column1, int column2, @ConvertWith(StringArrayConverter.class) String[] column3) {
    assertEquals(column1, "abc");
    assertEquals(column2, 123);
    assertEquals(column3[0], "foo");
    assertEquals(column3[1], "bar");
}

- Volodymyr Nazarenko

---

在我看来，最好将“数组”像Kapep的回答一样放在单引号字符串中进行指示。 - Carlo Bellettini

Answer 3

您可以轻松执行以下操作：

@DisplayName("Should rotate successfully")
@ParameterizedTest()
@CsvSource({
        "'[0, 0, 0]', 5, '[0, 0, 0]', false",
})
void givenAnArrayAndAShiftSize_ShouldSuccesfullyRotateOrReturnFalse(String arrayStr, int shiftSize,
        String expectedArrayStr, boolean expecetedRotated) {

    var window = Arrays.asList(arrayStr.replace("[", "").replace("]", "").split(","))
            .stream()
            .mapToLong(c -> Long.parseLong(c.toString().trim()))
            .toArray();

    var result = Arrays.asList(expectedArrayStr.replace("[", "").replace("]", "").split(","))
            .stream()
            .mapToLong(c -> Long.parseLong(c.toString().trim()))
            .toArray();

    var rotated = Utils.shiftIfSizeIsValid(window, shiftSize);

    assertEquals(expecetedRotated, rotated);

    for (int i = 0; i < window.length; i++) {
        assertEquals(result[i], window[i]);
    }
}

这样更简单易懂。

- Amir