Skip to content

Latest commit

 

History

History
200 lines (126 loc) · 8.57 KB

junit5.md

File metadata and controls

200 lines (126 loc) · 8.57 KB

JUnit 5

평소 유튜브에서 구독중인 박재성님으로부터 TDD(Test Driven Development)에 대한 중요성을 많이 들었고, 항상 관심은 있었지만 실행을 하지 못하고 있었다. 그러다가 이동욱님이 집필하신 스프링부트와 AWS로 혼자 구현하는 웹 서비스를 읽으면서 TDD를 제대로 배우고, 경험해야겠다는 생각이 들었다.

책에선 시작부터 test 코드를 작성해가며, 나처럼 테스트 코드 작성에 익숙하지 않은 사람들을 익숙하게 하기 위해 모든 코드에 대한 테스트 코드를 작성하셨다. 그러나 동욱님이 작성하신 시점과 내가 책을 읽는 시점의 차이 때문에 발생하는 것인지 몰라도 에러가 발생해서 라이브러리를 못불러오는 경우가 시작부터 발생했고, 안그래도 낯선 테스트가 더 낯설어질것 같아서 인프런에서 백기선님 강의를 구입해서 공부를 시작하게 되었다.

자바 기반의 테스트 프레임워크 JUnit을 직접 다루고 실습하면서, 향후 다른 사람들에게 설명할 수 있는 정도로 이해하는 것이 목표이다.

최근에 스프링부트가 2.2버전을 릴리즈하면서, JUnit의 버전도 JUnit 4에서 JUnit 5로 버전 업하였다.

JUnit 5 User Guid

ToC


JUnit 5의 구성

JUnit 5 = JUnit Platform + Jupiter + Vintage

  • JUnit Platform
    • JUnit으로 작성된 테스트 코드를 실행해주는 런처를 제공.
    • TestEngine API 제공.
  • Jupiter
    • TestEngine API 구현체로써 JUnit 5를 제공
  • Vintage
    • JUnit 4와 3을 지원하는 TestEngine 구현체

JUnit 4와 JUnit 5의 차이

JUnit4는 하나의 JAR 파일이었으나 JUnit 5은 그 자체로 하나의 플랫폼으로 작동한다. 그리고 그 플랫폼위에서 Jupiter, Vintage라는 모듈이 동작한다고 한다.


Spring Boot 2.2 부터 JUnit 5 기본 적용

Spring Boot 2.2 부터는 spring-boot-start-test를 통해 JUnit5가 기본제공된다. 프로젝트 생성후, Dependencies를 확인해보면, JUnit 5의 모듈이 주입된 것을 확인할 수 있다.

만약 스프링부트로 시작한게 아니거나 JUnit 5에 대한 의존성을 수동적으로 주입하고자 한다면, 아래의 의존성을 주입하면 Jupiter를 사용할 수 있다.

<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-engine</artifactId>
    <version>5.6.2</version>
    <scope>test</scope>
</dependency>

테스트 실행하기

의미없는 클래스 하나를 작성하고, 해당 클래스에 마우스 커서를 올려두고, 우클릭을 하면 아래와 같이 테스트 클래스를 생성할 수 있다.

또는 단축키를 이용하여 빠르게 테스트를 생성할 수도 있다.

Intelli J, 맥(MacOS)환경에서는 Command + Shift + T를 입력하면 된다.

그럼 이렇게 테스트 클래스 이름을 설정하는 창이 뜨는데, 일반적으로 클래스 이름 뒤에 Test를 붙여서 테스트 클래스를 만든다.


JUnit 5의 기본 어노테이션

  • @Test

    • 해당 메서드가 테스트임을 알리는 어노테이션

  • @BeforeAll

    • 테스트의 시작 코드

  • @AfterAll

    • 테스트의 마지막 코드

  • @BeforeEach

    • 각각의 테스트(method)가 실행되기 전 실행하는 코드

  • @AfterEach

    • 각각의 테스트(method)가 실행된 후 실행하는 코드

  • @Disabled

    • 테스트 코드중 테스트로 실행하고 싶지 않은 메서드에 추가하는 어노테이션.

위의 어노테이션들이 각각 어떻게 실행되는지 직접 테스트 코드를 생성하고, 실행해보자.

import org.junit.jupiter.api.*;
import static org.junit.jupiter.api.Assertions.*;

class HelloTestTest {

    @Test
    void create_test_1(){
        HelloTest helloTest = new HelloTest();
        assertNotNull(helloTest);
        System.out.println("Create1");
    }

    @Test
    void create_test_2(){
        System.out.println("Create2");
    }

    // 모든 테스트가 시작되기 전에 한 번 실행.
    // static void 로만 사용 가능
    @BeforeAll
    static void before_all(){
        System.out.println("BeforeAll");
    }

    // 모든 테스트가 실행된 이후에 한 번 실행.
    @AfterAll
    static void after_all(){
        System.out.println("AfterAll");
    }

    // 모든 테스트를 실행할 때, 각각의 테스트가 실행하기 전에 1회 실행
    @BeforeEach
    void before_each(){
        System.out.println("BeforeEach");
    }

  	// 모든 테스트를 실행할 때, 각각의 테스트가 실행하기 후에 1회 실행
    @AfterEach
    void after_each(){
        System.out.println("AfterEach");
    }

}

위의 테스트 코드를 실행하면 콘솔에 아래와 같이 출력된다.

BeforeAll

BeforeEach
Create1
AfterEach


BeforeEach
Create2
AfterEach

AfterAll

Process finished with exit code 0

@BeforeAll는 모든 테스트 코드가 실행되기 전에 실행된걸 확인할 수 있으며, 반대로 @AfterAll 은 모든 테스트 코드가 끝나고 마지막에 실행되는걸 확인할 수 있다.

@BeforeEach 는 테스트 메서드가 실행되기 전에 각각 1회씩, 그리고 @AfterEach는 테스트 메서드가 실행된 후에 1회씩 실행된걸 확인할 수 있다.


테스트 코드 이름 설정하기

테스트로 이름을 설정하는 방법은 두 가지가 있다. 클래스 위에 명시함으로써 해당 클래스내 모든 테스트 메서드의 이름을 설정하는 방법과 각 테스트 메서드마다 임의로 이름을 설정하는 방법이다.

먼저 클래스에 설정하는 방법을 알아보자.

클래스 위에 @DisplayNameGeneration() 을 입력하면, 테스트 메서드마다 이름을 설정하는데 강의에선 파라미터로 DisplayNameGenerator.ReplaceUnderscores.class를 주입하여 _로 구분한 영역을 공백으로 치환하여 테스트를 실행해준다.

아직 @DisplayNameGeneration()을 적용하기 전의 모습이다.

@DisplayNameGeneration() 을 적용하고 나서는 테스트 메서드의 이름에서 _ 가 공백으로 바뀌어 가독성이 조금 더 향상된걸 확인할 수 있다.


이번엔 각 메서드마다 테스트 이름을 설정하는 방법인데, 백기선님께서는 @DisplayNameGeneration() 보다 @DisplayName()을 사용하는걸 추천하셨다.

@DisplayName을 사용하니까 훨씬 직관적으로 표현할 수 있는것 같다.