[Kotlin] JUnit5

💡 테스트 프레임 워크인 JUnit5를 활용해서 단위 테스트와 통합 테스트를 작성하고 실행하는 방법을 활용하였습니다.

Junit5

• 자바 애플리케이션을 위한 최신 테스트 프레임워크로, 단위 테스트 및 통합 테스트를 작성하고 실행하는 데 사용됩니다.
• Java 8에서 도입된 기능을 특별히 타겟으로 하는 여러 기능이 포함되어 있으며, 주로 람다 표현실을 사용하여 구축되었습니다.

구성 요소

• Junit Platform
  • 테스트를 실행하기 위한 기반을 제공합니다.
  • IDE나 빌드 도구(Maven, Gradle 등)와의 통합을 지원하며, 다양한 테스트 엔진을 실행할 수 있는 공통 실행 환경을 제공합니다.
• Junit Jupiter
  • JUnit 5에서 새롭게 도입된 프로그래밍 및 확장 모델을 제공합니다.
  • @Tset, @BeforEath, @AfterEach 등 새로운 어노테이션이 포함되어 있으며, JUnit5에서 주로 사용되는 API 입니다.
• JUnit Vintage
  • JUnit 4와 이전 버전의 테스트 코드를 JUnit5 환경에서 실행할 수 있도록 지원하는 모듈입니다.
  • 기존의 JUnit4 테스트를 마이그레이션 할 필요 없이 실행할 수 있습니다.

주요 어노테이션

• Junit5에서는 테스트 메서드를 정의하고, 테스트 수명주기를 관리하기 위해 다양한 어노테이션을 제공합니다.
  • @Test : 테스트 메서드를 정의하며, 해당 메서드는 테스트 엔진에 의해 실행됩니다.
  • @BeforeEach : 각 테스트 메서드가 실행되기 전에 실행되는 메서드를 정의합니다.
  • @AfterEach : 각 테스트 메서드가 실행된 후에 실행되는 메서드를 정의합니다.
  • @BeforAll : 모든 테스트가 실행되기 전에 한 번만 실행되는 메서드를 정의합니다.
  • @AfterAll : 모든 테스트가 실행 된 후에 한 번만 실행되는 메서드를 정의합니다.
  • @DisplyName : 테스트 메서드에 대한 사용자 정의 이름을 지정합니다.
  • @Disabled : 특정 테스트 메서드를 비활성화하거나 무시할 때 사용합니다.

구현해보기

• Junit5를 활용한 간단한 테스트를 구현하였습니다.

import org.junit.jupiter.api.*

// @BeforeAll, @AfterAll 메서드를 인스턴스 메서드로 사용 가능하게 설정
@TestInstance(TestInstance.Lifecycle.PER_CLASS) 
class CalculatorTest {

    private lateinit var calculator: Calculator

    @BeforeAll
    fun initAll() {
        println("Before all tests")
    }

    @BeforeEach
    fun setUp() {
        println("Before each test")
        calculator = Calculator()
    }

    @Test
    @DisplayName("Test for addition")
    fun testAddition() {
        println("Testing addition")
        Assertions.assertEquals(4, calculator.add(2, 2))
    }

    @Test
    @DisplayName("Test for subtraction")
    fun testSubtraction() {
        println("Testing subtraction")
        Assertions.assertEquals(0, calculator.subtract(2, 2))
    }

    @Test
    @DisplayName("Test for multiplication")
    // Disable를 통해서 테스트를 실행하지 않습니다.
    @Disabled("Disabled until bug #1234 has been fixed") 
    fun testMultiplication() {
        println("Testing multiplication")
        Assertions.assertEquals(4, calculator.multiply(2, 2))
    }

    @AfterEach
    fun tearDown() {
        println("After each test")
    }

    @AfterAll
    fun tearDownAll() {
        println("After all tests")
    }
}

class Calculator {
    fun add(a: Int, b: Int): Int = a + b
    fun subtract(a: Int, b: Int): Int = a - b
    fun multiply(a: Int, b: Int): Int = a * b
}

Advanced Assertions

• JUnit5는 람다를 사용하기 위해 여러 상위 어설션을 사용할 수 있습니다.

Exception Asserting

• 호출이 예외를 throw할 것으로 예상되는 경우에 어설션을 추가할 수 있습니다.
• 특정 호출이 예상된 예외를 throw하는지 테스트할 수 있습니다.

@Test
fun `Dividing by zero should throw the DivideByZeroException`() {
    val exception = Assertions.assertThrows(DivideByZeroException::class.java) {
        calculator.divide(5, 0)
    }

    Assertions.assertEquals(5, exception.numerator)
}

Multiple Assertions

• 여러 개의 어설션을 동시에 수행할 수 있는 기능을 제공합니다.
• 모든 기능을 평가하며, 모든 실패에 대해 보고합니다.

fun `The square of a number should be equal to that number multiplied in itself`() {
    Assertions.assertAll(
        Executable { Assertions.assertEquals(1, calculator.square(1)) },
        Executable { Assertions.assertEquals(4, calculator.square(2)) },
        Executable { Assertions.assertEquals(9, calculator.square(3)) }
    )
}

Boolean Assertions

• 호출이 참 or 거짓을 정상적으로 반환하는지 테스트할 수 있습니다.

@Test
fun `isEmpty should return true for empty lists`() {
    val list = listOf<String>()
    Assertions.assertTrue(list::isEmpty)
}

JUnit5의 장점

• 유연한 테스트 모델
  • 테스트 실행의 유연성을 높이기 위해 다양한 확장 포인트를 제공합니다.
  • 테스트 라이프 사이클, 조건부 실행, 반복 테스트 등..
• 확장 가능성
  • 사용자 정의 확장을 통해 프레임워크를 확장할 수 있는 기능을 제공합니다.
• 포현력이 높은 테스트
  • @DisplyName을 사용해테스트 케이스에 명확하고 직관적인 이름을 부여할 수 있습니다.
• 더 나은 구조화
  • JUnit Jupiter, JUnit Playform, JUnit Vintage와 같은 모듈화된 구조를 통해 확장 가능하고 더 나은 구조화를 제공합니다.

결론

• JUnit 5는 자바 애플리케이션 테스트를 위한 최신 표준 프레임워크입니다.
• 유연하고 확장 가능한 테스트 환경을 제공하며, 다양한 테스트 전략을 지원합니다.
• JUnit 5를 사용하여 테스트 코드의 품질을 높이고, 코드의 안정성과 유지보수성을 개선할 수 있습니다.

참고

JUnit 5 for Kotlin Developers | Baeldung on Kotlin