[더 자바, 애플리케이션을 테스트하는 다양한 방법] JUnit 5 - Assertion

JUnit 5 Assertion

• 실제 테스트에서 검증하고자 하는 내용을 확인할 수 있다.

• 실제 값이 기대한 값과 같은지 확인할 수 있다.
  • assertEqulas(expected, actual)

• 값이 null이 아닌지 확인할 수 있다.
  • assertNotNull(actual)

• 다음 조건이 참(true)인지 확인할 수 있다.
  • assertTrue(boolean)

• 모든 테스트를 한 번에 실행할 수 있다. (모든 확인 구문 확인)
  • assertAll(executables...)

• 어떠한 코드 실행 시 어떠한 타입의 예외가 발생하는지 테스트할 수 있다. (예외 발생 확인)
  • assertThrows(expectedType, executable)

• 특정 시간 안에 실행이 완료되는지 확인할 수 있다.
  • assertTimeout(duration, executable)

 

마지막 매개변수로 Supplier<String> 타입의 인스턴스를 람다 형태로 제공할 수 있다.

• 복잡한 메시지 생성해야 하는 경우 사용하면 실패한 경우에만 해당 메시지를 만들게 할 수 있다.

 

- AssertJ, Hemcrest, Truth 등의 라이브러리를 사용할 수도 있다.

 

JUnit 5 Assertion 예제

테스트 대상 enum

public enum StudyStatus {
    DRAFT, STARTED, ENDED
}

---

테스트 대상 클래스

public class Study {

    private StudyStatus status = StudyStatus.DRAFT;

    private int limit;

    public Study(int limit) {
        if (limit < 0) {
            throw new IllegalArgumentException("limit은 0보다 커야 한다.");
        }
        this.limit = limit;
    }

    public Study() {

    }

    public StudyStatus getStatus() {
        return this.status;
    }

    public int getLimit() {
        return limit;
    }
}

---

테스트 코드

class StudyTest {
    @Test
    @DisplayName("스터디 만들기")
    void create_new_study() {
        /**
         * assertThrows
         * 어떠한 코드 실행 시 어떠한 타입의 예외가 발생하는지 테스트할 수 있다.
         * 발생한 예외를 받아서 메시지가 내가 기대하는 메시지와 같은지도 테스트할 수 있다.
         */
        IllegalArgumentException exception = assertThrows(IllegalArgumentException.class, () -> new Study(-10));
        String message = exception.getMessage();
        assertEquals("limit은 0보다 커야 한다.", message);

        Study study = new Study(10);
        /**
         * assertAll
         * 모든 테스트를 한번에 실행할 수 있다.
         * - 깨진 테스트를 한번에 확인 가능
         */
        assertAll(
            /**
             * assertTimeout
             * 실행하는 코드가 특정 시간이내에 반드시 완료가 되어야하는 경우를 테스트할 수 있다.
             * 단점은 코드 블록이 실행이 끝날 때까지 기다리고 시간을 비교한다.
             * - 1초안에 실행되는것을 테스트했는데 테스트하는 시간이 3초가 넘었다.
             */
            () -> assertTimeout(Duration.ofMillis(100), () -> {
                new Study(10);
                Thread.sleep(300);
            }),

            /**
             * assertTimeoutPreemptively
             * 위와 마찬가지로 실행하는 코드가 특정 시간이내에 반드시 완료가 되어야하는 경우를 테스트할 수 있다.
             * 차이점은 1초안에 실행되는것을 테스트하는 경우, 코드 블록이 1초가 넘으면 즉각적으로 테스트 종료(실패).
             *
             * 주의점
             * - 코드 블록을 별도의 쓰레드에서 실행하기 때문에 코드 블록 내부에 ThreadLocal을 사용하는 코드가 있다면 예상치 못한 결과가 발생할 수 있다.
             * 예) 스프링 트랜잭션 처리는 ThreadLocal을 기본 전략으로 사용한다. ThreadLocal은 다른 쓰레드간에 공유가 안된다.
             *     스프링 트랜잭션 설정이 테스트에서 제대로 동작하지 않을 수도 있다.(롤백되지 않고 DB에 반영) 트랜잭션 설정을 가지고 있는 쓰레드가 아닌 별개의 쓰레드로 실행하기 때문이다.
             * - 쓰레드와 전혀 관련없는 코드를 실행한다면 사용해도 괜찮다.
             *
             * TODO ThreadLocal
             */
            () -> assertTimeoutPreemptively(Duration.ofMillis(100), () -> {
                new Study(10);
                Thread.sleep(300);
            }),

            /**
             * assertNotNull
             * 값이 null이 아닌지 확인
             */
            () -> assertNotNull(study),

            /**
             * assertEquals(기대하는값, 실제 값, 실패시 표시될 메시지)
             * 일반 String이 아닌 람다 식으로 메시지를 전달하는 이유
             * - 복잡한 메시지를 전달해야 할 때, 많은 문자열 연산이 존재할 수 있다. 예) "스터디를 처음 만들면 상태값이 "+ StudyStatus.DRAFT +" 이다."
             * - 람다식으로 만들어 주면 문자열 연산을 최대한 필요한 시점에 하게 된다. (테스트를 실패했을 경우에만 문자열 연산을 수행한다.)
             * - 일반 String으로 작성하게 된다면 테스트가 성공하든 실패하든 상관없이 문자열 연산을 수행한다. (필요하지 않은 시점에도 문자열 연산을 수행한다.)
             * - 따라서 문자열 연산의 비용이 많이 크다고 생각하면 람다 식으로 작성하는것이 좋다.
             */
            () ->  assertEquals(StudyStatus.DRAFT, study.getStatus(),
                    () -> "스터디를 처음 만들면 상태값이 "+ StudyStatus.DRAFT +" 이다."), //테스트 실패 시 메시지도 전달할 수 있다.

            /**
             * assertTrue
             * 실제 값이 기대한 값과 같은지 확인
             */
            () -> assertTrue(study.getLimit() > 0, "스터디 최대 참석 가능 인원은 0보다 커야 한다.")
        );
    }
}

---

[참고자료]

더 자바, 애플리케이션을 테스트하는 다양한 방법, 백기선

JUnit 5 User Guide