Parameterized Tests

@Parameterizeds는 여러 값들을 이용하여, 한번에 단일 테스트를 여러 번 실행할 수 있습니다.

종속성 추가

<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-params</artifactId>
    <version>5.8.1</version>
    <scope>test</scope>
</dependency>

Int 와 String 테스트: @ValueSource

public class Numbers {
    public static boolean isOdd(int number) {
        return number % 2 != 0;
    }
}

number 파라미터에 ValueSource 안에 값들을 할당하면서 여러번 테스트한다.

// 설명: 6개 int 홀수 인지 테스트
@ParameterizedTest
@ValueSource(ints = {1, 3, 5, -3, 15, Integer.MAX_VALUE}) 
void isOdd_ShouldReturnTrueForOddNumbers(int number) { 
    assertTrue(Numbers.isOdd(number));
}

숫자 말고도 String도 테스트가 가능하다.

public class Strings {
    public static boolean isBlank(String input) {
        return input == null || input.trim().isEmpty();
    }
}

// 설명: 스트링에 값이 없는지 테스트
@ParameterizedTest
@ValueSource(strings = {"", "  "})
void isBlank_ShouldReturnTrueForNullOrBlankStrings(String input) {
    assertTrue(Strings.isBlank(input));
}

주의

• 위의 @ValueSource 로 null 은 넘겨줄 수 없다.

• @NullSource를 대신 이용하면 된다 (다만, int 같은 primitive 타입에는 적용 불가).

• 비슷하게 @EmptySource 도 사용 가능하다. 이 어노테이션은 추가적으로, Collection 타입들이나 Array 들을 위한 빈 값들도 제공해준다.

• 위 두가지를 모두 합친, @NullAndEmptySource 도 있다.

@ParameterizedTest
@EmptySource
void isBlank_ShouldReturnTrueForEmptyStrings(String input) {
    assertTrue(Strings.isBlank(input));
}

@ParameterizedTest
@NullSource
void isBlank_ShouldReturnTrueForNullInputs(String input) {
    assertTrue(Strings.isBlank(input));
}

@NullAndEmptySource + @ValueSource 같이 쓰기

@ParameterizedTest
@NullAndEmptySource 
@ValueSource(strings = {"  ", "\t", "\n"})
void isBlank_ShouldReturnTrueForAllTypesOfBlankStrings(String input) {
    assertTrue(Strings.isBlank(input));
}

Enum 테스트: @EnumSource

@ParameterizedTest
@EnumSource(Month.class) // Month 클래스에서 모든 달 가져와 테스트
void getValueForAMonth_IsAlwaysBetweenOneAndTwelve(Month month) { // JANUARY, FEBURAY... 들어간다.
    int monthNumber = month.getValue();
    assertTrue(monthNumber >= 1 && monthNumber <= 12);
}

@EnumSource 속성 이용하기

@ParameterizedTest
@EnumSource(value = Month.class, names = {"APRIL", "JUNE", "SEPTEMBER", "NOVEMBER"}) // name 속성 이용 필터링 가능
void someMonths_Are30DaysLong(Month month) {
    final boolean isALeapYear = false;
    assertEquals(30, month.length(isALeapYear));
}

@ParameterizedTest
@EnumSource(
  value = Month.class,
  names = {"APRIL", "JUNE", "SEPTEMBER", "NOVEMBER", "FEBRUARY"}, 
  mode = EnumSource.Mode.EXCLUDE) // 제외하고 실행하고 싶을때
void exceptFourMonths_OthersAre31DaysLong(Month month) {
    final boolean isALeapYear = false;
    assertEquals(31, month.length(isALeapYear));
}

@ParameterizedTest
@EnumSource(value = Month.class, names = ".+BER", mode = EnumSource.Mode.MATCH_ANY) // 정규표현식 이용 필터링
void fourMonths_AreEndingWithBer(Month month) {
    EnumSet<Month> months =
      EnumSet.of(Month.SEPTEMBER, Month.OCTOBER, Month.NOVEMBER, Month.DECEMBER);
    assertTrue(months.contains(month));
}

@ValueSource, @EnumSource 둘 다 오직 한개의 매개변수를 넘길 때만 사용 가능하다.

다수 값을 넘길때를 살펴보자.

여러 args 테스트: @CsvSource

@ParameterizedTest
@CsvSource({"test,TEST", "tEst,TEST", "Java,JAVA"}) // 실행 전,후 값들
void toUpperCase_ShouldGenerateTheExpectedUppercaseValue(String input, String expected) {
    String actualValue = input.toUpperCase();
    assertEquals(expected, actualValue);
}

콤마 말고 다른 delimiter 사용

@ParameterizedTest
@CsvSource(value = {"test:test", "tEst:test", "Java:java"}, delimiter = ':')
void toLowerCase_ShouldGenerateTheExpectedLowercaseValue(String input, String expected) {
    String actualValue = input.toLowerCase();
    assertEquals(expected, actualValue);
}

CSV 파일에서 가져오기

input,expected
test,TEST
tEst,TEST
Java,JAVA

@ParameterizedTest
@CsvFileSource(resources = "/data.csv", numLinesToSkip = 1) // 첫번째 헤더 라인은 스킵 
void toUpperCase_ShouldGenerateTheExpectedUppercaseValueCSVFile(
  String input, String expected) {
    String actualValue = input.toUpperCase();
    assertEquals(expected, actualValue);
}

Method 테스트: @MethodSource

좀더 복잡한 args 를 다룰 때는,

@ParameterizedTest
@MethodSource("provideStringsForIsBlank") // 메소드를 찾는다
void isBlank_ShouldReturnTrueForNullOrBlankStrings(String input, boolean expected) {
    assertEquals(expected, Strings.isBlank(input));
}

private static Stream<Arguments> provideStringsForIsBlank() {
    return Stream.of(
      Arguments.of(null, true),
      Arguments.of("", true),
      Arguments.of("  ", true),
      Arguments.of("not blank", false)
    );
}

메소드 이름 지정을 안하면, 테스트명과 동일한 것을 찾는다.

@ParameterizedTest
@MethodSource // <- 메소드명 지정 안함
void isBlank_ShouldReturnTrueForNullOrBlankStringsOneArgument(String input) {
    assertTrue(Strings.isBlank(input));
}

private static Stream<String> isBlank_ShouldReturnTrueForNullOrBlankStringsOneArgument() { // 테스트명과 동일하기에 실행
    return Stream.of(null, "", "  ");
}

Full Qualified Name(FQN)을 써도 된다.

class StringsUnitTest {
    @ParameterizedTest
    @MethodSource("com.baeldung.parameterized.StringParams#blankStrings") // FQN#methodName 포맷으로 쓰기.
    void isBlank_ShouldReturnTrueForNullOrBlankStringsExternalSource(String input) {
        assertTrue(Strings.isBlank(input));
    }
}

public class StringParams {
    static Stream<String> blankStrings() {
        return Stream.of(null, "", "  ");
    }
}

커스텀 매개변수 클래스 만들기: @ArgumentsSource, ArgumentsProvider

@ParameterizedTest
@ArgumentsSource(BlankStringsArgumentsProvider.class)
void isBlank_ShouldReturnTrueForNullOrBlankStringsArgProvider(String input) {
    assertTrue(Strings.isBlank(input));
}

class BlankStringsArgumentsProvider implements ArgumentsProvider { 
    @Override
    public Stream<? extends Arguments> provideArguments(ExtensionContext context) {
        return Stream.of(
          Arguments.of((String) null), 
          Arguments.of(""), 
          Arguments.of("   ") 
        );
    }
}

타입 변환

명시적 Conversion

위에서, Month 의 값들을 가져올때, 클래스를 명시해주었다. 하지만, String 으로 줘도 Junit은 자동으로 conversion 을 해준다.

• String 사용시에도 형 변환 가능한 타입들

• UUID

• Locale

• LocalDate, LocalTime, LocalDateTime, Year, Month, etc.

• File and Path

• URL and URI

• Enum subclasses

@ParameterizedTest
@CsvSource({"APRIL", "JUNE", "SEPTEMBER", "NOVEMBER"}) // 스트링들이 Month 클래스의 각 달 값들로 변환됨
void someMonths_Are30DaysLongCsv(Month month) {
    final boolean isALeapYear = false;
    assertEquals(30, month.length(isALeapYear));
}

비명시적 Conversion: @ConvertWith

// 날짜 스트링을 LocalDate로 변환하여 연도를 비교한다. 
@ParameterizedTest
@CsvSource({"2018/12/25,2018", "2019/02/11,2019"}) 
void getYear_ShouldWorkAsExpected(
  @ConvertWith(SlashyDateConverter.class) LocalDate date, int expected) { // @ConvertWith에 커스텀 컨버터를 지정한다.
    assertEquals(expected, date.getYear());
}

class SlashyDateConverter implements ArgumentConverter {
    @Override
    public Object convert(Object source, ParameterContext context)
      throws ArgumentConversionException {
        if (!(source instanceof String)) {
            throw new IllegalArgumentException(
              "The argument should be a string: " + source);
        }
        try {
            String[] parts = ((String) source).split("/");
            int year = Integer.parseInt(parts[0]);
            int month = Integer.parseInt(parts[1]);
            int day = Integer.parseInt(parts[2]);

            return LocalDate.of(year, month, day);
        } catch (Exception e) {
            throw new IllegalArgumentException("Failed to convert", e);
        }
    }
}

ArgumentAccessor

매개변수 배열에서 특정 arg 위치에 접근이 가능하다.

// 설명: 사람들의 이름 정보(성, 미들네임, 이름)들을 받아 Person 객체를 생성한다.
@ParameterizedTest
@CsvSource({"Isaac,,Newton,Isaac Newton", "Charles,Robert,Darwin,Charles Robert Darwin"})
void fullName_ShouldGenerateTheExpectedFullName(ArgumentsAccessor argumentsAccessor) { // 이 매개변수에 값들이 캡슐화된다.
    String firstName = argumentsAccessor.getString(0); // Isaac
    String middleName = (String) argumentsAccessor.get(1); // 
    String lastName = argumentsAccessor.get(2, String.class); // Newton
    String expectedFullName = argumentsAccessor.getString(3); // Isaac Newton

    Person person = new Person(firstName, middleName, lastName);
    assertEquals(expectedFullName, person.fullName());
}

class Person {
    String firstName;
    String middleName;
    String lastName;
    
    // constructor

    public String fullName() {
        if (middleName == null || middleName.trim().isEmpty()) {
            return String.format("%s %s", firstName, lastName);
        }

        return String.format("%s %s %s", firstName, middleName, lastName);
    }
}

이쁘게 출력하기

@ParameterizedTest(name = "{index} {0} is 30 days long") // 여기에 프린트할 설명 작성
@EnumSource(value = Month.class, names = {"APRIL", "JUNE", "SEPTEMBER", "NOVEMBER"})
void someMonths_Are30DaysLong(Month month) {
    final boolean isALeapYear = false;
    assertEquals(30, month.length(isALeapYear));
}

├─ someMonths_Are30DaysLong(Month)
│     │  ├─ 1 APRIL is 30 days long
│     │  ├─ 2 JUNE is 30 days long
│     │  ├─ 3 SEPTEMBER is 30 days long
│     │  └─ 4 NOVEMBER is 30 days long

참고자료

• https://www.baeldung.com/parameterized-tests-junit-5