[Java] JUnit5 사용법 알아보기

 

 

 

JUnit이란?

 

🔲 Java 개발자의 93%가 사용하는 단위 테스트 프레임워크

 

🔲 스프링 부트 2.2버전 이상부터 기본 제공한다.

 

 

 

 

 

 

JUnit5는?

 

 

🔲 Platform : 테스트를 실행하게 해주는 런처를 제공한다. TestEngine API를 제공.

 

🔲 Jupiter : JUnit5를 지원하는 TestEngine API 구현체

 

🔲 Vintage : JUnit4와 3를 지원하는 TestEngine 구현체

 

 

 

 

 

 

 

JUnit5를 시작하는 방법

 

🔲 스프링부트 2.2버전 이상부터는 기본 탑재된다.

 

🔲 그 외에는 maven, 혹은 gradle 방식으로 추가할 수 있다.

 

 

gradle

test {
    useJUnitPlatform()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
}

 

 

 

maven

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
</dependency>

 

 

 

 

 

 

 

 

 

Annotations

 

 

🔶 @Test

 

테스트 메서드임을 나타내는 어노테이션이다. JUnit4와는 다르게 어떠한 속성도 기재하지 않는다.

 

@Test
void create() {
...
}

 

 

 

 

🔶 생명주기(LifeCycle) 어노테이션

 

 

 

 

🔲 @BeforeAll : 해당 클래스에 위치한 모든 테스트 메서드 실행 전, 한 번만 실행되는 메서드

 

🔲 @AfterAll : 해당 클래스에 위치한 모든 테스트 메서드 실행 후, 한 번만 실행된다.

 

🔲 @BeforeEach : 해당 클래스에 위치한 모든 테스트 메서드 실행 전에 실행되는 메서드, BeforeAll과 달리 모든 메서드 마다 실행된다.

 

🔲 @AfterEach : 해당 클래스에 위치한 모든 테스트 메서드 실행 후에 실행되는 메서드, AfterAll과 달리 모든 메서드마다 실행된다.

 

 

 

 

 

 

 

🔶 @DisplayName

 

어떤 테스트인지 쉽게 표현할 수 있도록 해주는 어노테이션이다. 공백이나, Emoji, 특수문장 등 모두 지원한다.

 

 

 

@DisplayName("테스트입니다")
void test() {
...
}

 

 

 

 

 

 

🔶 RepeatedTest

 

 

특정 테스트를 반복시키고자 할 때 사용한다. 반복 횟수는 _value_ 속성을 통해 설정하고, _name_속성을 통해 그 이름도 지어줄 수 있다.

 

@RepeatedTest(value = 10, name = "")
@DisplayName("반복")
void repeatedTest() {
...
}

 

 

 

 

🔶 @ParameterizedTest

 

테스트에 여러 다른 매개변수를 대입해가며 반복 실행할 때 사용한다. 자주 사용되는 어노테이션이라 기억해둘 만하다.

 

 

🔲 CsvSource

@ParameterizedTest
@CsvSource(value = {"ACE,ACE:12", "ACE,ACE,ACE:13"}, delimiter = ":")
@DisplayName("")
void useParameterizedTest(final String input, final int expected) {
}

 

 

key: value느낌으로 input과 expect에 :를 기준으로 split된 값들이 들어온다.

 

 

 

🔲 ValueSource

 

@ParameterizedTest
@ValueSource(strings = {"", "  "})
void isBlankTest(String input) {
    assertTrue(Strings.isBlank(input));
}

 

test 메서드 실행 시에 input 값으로 하나의 인수가 전달된다. 이때, 리터럴 값의 배열을 테스트 메서드로 전달한다.

 

 

 

 

🔲 Null and Empty Values

 

_@NullSource_를 사용하면 인수로 null값을 전달하고, _@EmptySource_를 사용하면 인수로 빈 값을 전달한다. 만약 _@NullAndEmptySource_를 사용하면 null값과 빈 값 모두를 전달할 수 있다.

 

 

 

특이한 것은 _@EmptySource_와 _@NullAndEmptySource_는 문자열, 컬렉션, 배열에서도 동작한다.

 

 

@ParameterizedTest
@NullAndEmptySource
void isBlankTest(String input) {
    asertTrue(Strings.isBlank(input));
}

 

 

 

🔲 Enum

 

 

_@EnumSource_를 통해 열거형 값의 배열을 테스트 메서드로 전달할 수 있다. 이때, 하나의 인수만을 전달한다.

 

 

 

속성으로는 _name_이 있는데, 정규 표현식을 전달할 수 있으며, _mode_라는 속성으로 제외할 enum을 지정할 수도 있다.(EXCLUDE)

 

 

 

@ParameterizedTest
@EnumSource(
  value = Month.class,
  names = {"APRIL", "JUNE", "SEPTEMBER", "NOVEMBER", "FEBRUARY"},
  mode = EnumSource.Mode.EXCLUDE)
void exceptFourMonthsTest(Month month) {
  final boolean isALeapYear = false;
  assertEquals(31, month.length(isALeapYear));
}

 

 

 

 

 

🔶 @Nested

 

테스트 클래스 안에서 내부 클래스를 정의하여 테스트를 계층화할 때 사용한다.

 

 

 

 

 

 

Assertions

 

테스트 케이스의 수행 결과를 판별하는 메서드이다. 또한 모든 JUnit Jupiter Assertions는 static 메서드이다.

 

 

 

import static org.assertj.core.api.Assertions.*;

 

 

Object Assertion

 

public class Dog { 
    private String name; 
    private Float weight;
    
}

Dog fido = new Dog("Fido", 5.25);

Dog fidosClone = new Dog("Fido", 5.25);

 

주어진 코드에 대해서 아래와 같이 테스트할 수 있다.

 

 

assertThat(fido).isEqualTo(fidosClone);

// 내용 자체를 비교하기 위해서는 아래 사용
assertThat(fido).isEqualToComparingFieldByFieldRecursively(fidosClone);

 

 

 

 

 

Boolean Assertion

 

assertThat("".isEmpty()).isTrue();

 

 

 

 

 

 

Iterable/Array Assertion

 

 

🔶 Iterable/Array가 특정 원소를 지니는 지 테스트

List<String> list = Arrays.asList("1", "2", "3");

assertThat(list).contains("1");

 

 

🔶빈 값인 지 확인

assertThat(list).isNotEmpty();

 

 

 

🔶 첫 번째 원소값 확인

assertThat(list).startsWith("1");

 

 

 

🔶 체이닝을 통한 쉬운 테스트

assertThat(list)
  .isNotEmpty()
  .contains("1")
  .doesNotContainNull()
  .containsSequence("2", "3");

 

 

 

 

 

 

Character Assertion

 

 

assertThat(someCharacter)
  .isNotEqualTo('a')
  .inUnicode()
  .isGreaterThanOrEqualTo('b')
  .isLowerCase();

 

 

 

 

 

 

Map Assertion

 

key/value나 entry를 지닌 Map 자료구조에 대해서도 테스트가 가능하다.

 

assertThat(map)
  .isNotEmpty()
  .containsKey(2)
  .doesNotContainKeys(10)
  .contains(entry(2, "a"));

 

 

🔶 assertAll(executables...)

 

매개 변수로 받는 모든 테스트코드를 한 번에 실행한다. 그래서 오류가 나도 끝까지 실행한 후에 한 번에 모아서 출력한다.

 

 

assertAll(
    () -> assertNotNull(study),
    () -> assertEquals(Status.STARTED, study.getStatus(), "처음 상태값 DRAFT"),
    () -> assertTrue(study.getLimit() > 0, "최대 인원은 0보다 커야한다.")
);

 

 

 

 

 

 

 

 

이외의 Assertion

 

 

🔶 assertThrows(extectedType, excutable)

 

예외 발생을 확인하는 테스트이다. 로직이 실행되는 도중 예외를 반환받아서, 예외의 상태까지 알 수 있다.

 

@Test
void exceptionThrow() {
    Exception e = assertThrows(Exception.class, () -> new Test(-10));
    assertDoesNotThrow(() -> System.out.println("Do Something"));
}

 

 

 

체이닝을 통해서 아래와 같이 클래스의 종류나 메세지도 알아낼 수 있다.

// when, then
assertThatThrownBy(() -> TryCountValidator.validate(input))
        .isInstanceOf(NullPointerException.class)
        .hasMessage("입력값이 공백이면 안됩니다.");

 

 

🔶 assertTimeout(duration, excutable)

 

특정 시간 안에 실행이 완료되는지 확인한다. _Duration_은 원하는 시간이며, _Executable_은 테스트할 로직이다.

 

@Test
@DisplayName("타임아웃 준수")
void timeoutNotExceeded() {
    assertTimeout(ofMinutes(2), () -> Thread.sleep(10));
}

 

 

 

 

 

🔶 Assumption

 

전제문이 true라면 실행하고, false라면 종료한다. CI와 같이 특정 환경에서만 테스트를 수행하여야 할 때 사용할 수 있다.

 

🔲 assumeTrue : false일 때, 테스트 전체가 실행되지 않는다.

 

🔲 assumingThat : 파라미터로 전달된 코드블럭만 실행되지 않는다.

void some_test() {
    assumeTrue("DEV".equals(System.getenv("ENV")), () -> "개발 환경이 아닙니다.");
    assertEquals("A", "A")' // 출력 x
}

 

 

 

 

 

 

 

 

References

https://gmlwjd9405.github.io/2019/11/27/junit5-guide-parameterized-test.html

https://www.baeldung.com/introduction-to-assertj

https://www.youtube.com/watch?v=EwI3E9Natcw