[Java] JUnit5이란? JUnit 테스트 방법

• 이 글은 "온라인 자바 스터디 내용"을 정리한 글입니다.

JUnit5란?

• JUnit은 자바 프로그래밍용 단위 테스트를 할 수 있는 프레임워크입니다.
• 요즘 프로그래밍에서는 테스트 주도 개발 면에서 중요점이 부각된 만큼 학습할 필요가 있습니다.
• JUnit5은 이전 버전과는 달리, JUnit5 = JUnit Platform + JUnit Jupiter + JUnit Vintage 여러 개의 모듈로 구성되었습니다.

JUnit Platform

• JUnit Platform 은 JVM에서 테스트 프레임워크를 시작하기 위한 기반을 제공합니다.
• 또한, 플랫폼에서 실행되는 테스트 프레임 워크 개발을 위한 TestEngine API를 정의합니다.
• 모두가 잘 아는 IDEs(Intellj, Eclipse, VS Code), 빌드 도구(Gradle, Maven, Ant) 에서도 JUnit Platform을 지원합니다.

JUnit Jupiter

• JUnit Jupiter는 JUnit5에서 테스트 작성을 위한 새로운 프로그래밍 모델과 확장 모델 조합입니다.
• 즉, 테스트를 하기 위한 것들이 포함되어 있다고 생각하면 됩니다.

JUnit Vintage

• 플랫폼에서 JUnit3, JUnit4기반한 테스트 코드가 실행될 수 있는 TeseEngine을 제공합니다.

JUnit5 Dependecny

저는 Intellj를 주로 사용하기 때문에 Intellj에 JUnit5를 사용하도록 하겠습니다.

test {
    useJUnitPlatform()
}

• 먼저 build.gradle에 위의 코드를 입력하여, JUnit Platform을 사용할 수 있도록 변경합니다.
• 참고(https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/testing/Test.html#useJUnitPlatform--)

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

}

• Gradle에 JUnit Jupiter를 할수 있도록 다음과 같은 의존성을 추가해야 합니다.

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

• JUnit Platform에 JUnit 3/4를 실행하기를 원한다면 JUnit Vintage Engine 의존성을 추가해야 합니다.
• 참조(https://docs.gradle.org/current/userguide/java_testing.html#using_junit5)

Annotations

JUnit Jupiter는 테스트를 구성하기 위한 다음의 annotation을 지원합니다.

• @Test : 메서드가 테스트 메서드임을 나타냅니다.
• @ParameterizedTest : 메서드가 매개 변수가 있는 테스트임을 나타냅니다.
• @RepeatedTest : 반복 테스트를 위한 메소드임을 나타냅니다.
• @TestFactory : 동적 테스트를 위한 테스트 팩토리 메소드를 나타냅니다.
• @TestTemplate : 여러번 호출되도록 설계된 테스트 케이스의 템플릿임을 나타냅니다.
• @TestMethodOrder : 테스트 메소드 실생 순서를 구성하는데 사용됩니다.
• @TestInstance : 테스트 라이프 사이플을 구성하는데 사용됩니다.
• @DisplayName : 테스트 클래스 또는 테스트 메서드에 대한 사용자 지정 표시 이름을 설정합니다.
• @DisplayNameGeneration : 테스트 클래스에 대한 커스텀 이름 생성기를 생성합니다.
• @BeforeEach : 모든 테스트 메소드 실행 전에 실행되는 메소드입니다.
• @AfterEach : 모든 테스트 메소드 실행이 끝나면 실행되는 메소드입니다.
• @BeforeAll : 하나의 테스트 실행 전에 실행되는 메소드입니다.
• @AfterAll : 하나의 테스트 실행이 끝나면 실행되는 메소드입니다.
• @Nested : non-static 중첩 클래스임을 나타냅니다.
• @Tag : 새로운 태그를 선언할 때 사용됩니다.
• @Disable : 테스트 클래스나 테스트 메소드를 사용하지 않도록 할 때 사용됩니다.
• @Timeout : 주어진 시간안에 실행을 못할 경우 실패하도록 하는데 사용됩니다.

Meta Annotation

JUnit Jupiter annotation은 meta-annotation을 사용합니다. meta-annotation은 자신이 직접 annotation을 정의할 수 있다는 것을 의미합니다.

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Test()
@Tag("fast")
@interface Fast{
}

class CalculatorTest {

    Calculator c = new Calculator();
    int a = 20;
    int b = 10;

    @Test()
    void sum(){
        assertEquals(30,c.sum(a,b));
    }

    @Fast()
    void sum2(){
        assertEquals(30,c.sum(a,b));
    }
}

• @Tag("fast") 를 통해 Fast라는 annotation을 정의하였고 Test 클래스에서 쓰는 예시입니다.
• @Fast annotation안에는 @Test도 있기 때문에 테스트를 실행하는 것을 확인하였습니다.

테스트 클래스와 테스트 메소드

• Test Class : 최소한 하나의 테스트 메소드가 포함된 정적 메소드 클래스 또는 중첩 클래스입니다. 테스트 클래스는 추상 클래스가 되면 안되고 하나의 생성자는 꼭 가져야 합니다.

• Test Method : @Test, @RepeatedTest, @ParameterizedTest, @TestFactory, @TestTemplate가 어노테이션된 메소드입니다.

• Lifecycle Method : @BeforeAll, @AfterAll, @BeforeEach, or @AfterEach가 어노테이션된 메소드입니다.

• Test Method와 Lifecycle Method는 현재 클래스 내에서 선언되거나, 슈퍼클래스에 상속되거나, 인터페이스에서 상속 될 수 있습니다.

class CalculatorTest {

    Calculator c = new Calculator();
    int a = 20;
    int b = 10;

    @BeforeAll
    static void start(){
        System.out.println("start!");
    }

    @BeforeEach
    void methodStart(){
        System.out.println("method start");
    }

    @Test
    @DisplayName("SUM")
    void sum() {
        assertEquals(30,c.sum(a,b));
    }

    @Test
    @Disabled()
    void sub() {
        assertEquals(10,c.sub(a,b));
    }

    @Test
    void mul() {
        assertEquals(200,c.mul(a,b));
    }

    @Test
    void div() {
        assertEquals(2,c.div(a,b));
    }

    @ParameterizedTest
    @ValueSource(ints = {2,4,6,8})
    void paramTest(int num){
        assertEquals(0,num%2);
    }

    @AfterEach()
    void methodFinish(){
        System.out.println("method finish");
    }

    @AfterAll()
    static void finish(){
        System.out.println("finish");
    }
}

Assert Method

• assertEquals(x,y) : 객체 x,y가 일치함을 확인합니다.
• assertArayEquals(a,b) : 배열 A와 B가 일치함을 확인합니다.
• assertFalse(x) : x가 false인지 확인합니다.
• assertTrue(x) : x가 True인지 확인합니다.
• assertNull(x) : 객체 x가 null인지 확인합니다.
• seertNotNull(x) : 객체 x가 null이 아닌지 확인합니다.
• assertSame(x,y) : 객체 x와 y가 같은 객체의 레퍼런스임을 확인합니다. (30 != 30.0)
• asswertNotSame(x,y) : 객체 x와 y가 같은 객체의 레퍼런스가 아닌지 확인합니다.
• asserfail() : 테스트를 실패 처리합니다.