[Spring] 🌱 Junit5의 여러가지 기능

개인 프로젝트를 진행하면서 JUnit5를 활용한 단위테스트를 공부해보고 있는데 여러가지 기능들을 정리해 놓으려고 합니다.

🌱 Junit5

자바 개발자가 사용하는 테스팅 기반 프레임 워크를 의미합니다. JUnit 5는 자바 8 이상부터 사용 가능합니다. JUnit5의 어노테이션들중 일부를 하나씩 살펴보려 합니다.

@Test

@Test 어노테이션을 추가함으로써 테스트 메소드임을 선언할 수 있습니다.

@BeforeAll, @AfterAll

@BeforeAll을 통해 모든 테스트 코드가 실행되기 전 최초로 수행할 코드를 정의할 수 있고, @AfterAll을 통해 모든 테스트 코드가 종료된 이후 실행할 코드를 정의할 수 있습니다.

@BeforeAll
static void beforeAll() {
	System.out.println("모든 테스트 코드가 실행되기 전에 최초로 수행");
}
    
@AfterAll
static void afterAll() {
	
System.out.println("모든 테스트 코드가 실행된 후 마지막으로 수행");
}

@BeforeEach, @AfterEach

@BeforeEach를 통해 각각의 테스트 코드가 실행되기 이전에 수행시킬 코드를 정의할 수 있고, @AfterEach를 통해 각각의 테스트 코드가 실행된 이후 수행시킬 코드를 정의할 수 있습니다.

@BeforeEach
void setUp() {
	System.out.println("각각의 테스트 코드가 실행되기 전에 수행");
}

@AfterEach
void tearDown() {
	System.out.println("각각의 테스트 코드가 실행된 후에 수행");
}

@DisplayName

@DisplayName 어노테이션을 통해 테스트 실행시 테스트 메소드의 이름이 아닌 지정한 값을 결과로 보여줄 수 있습니다.

이렇게 자유롭게 테스트의 이름을 지정해 줌으로써 테스트 메소드의 이름을 크게고민하지 않고 지을 수 있습니다.

@Test
@DisplayName("이 테스트에 대한 설명입니다.")
void test1() {
	System.out.println("테스트 1");
}

@Disabled

@Disabled 어노테이션을 통해 실행하고 싶지 않은 테스트를 막아놓을 수 있습니다.

@Test
@Disabled
void 테스트_1() {
}

@Test
void 테스트_2() {
}

@Nested

@Nested 어노테이션을 통해서는 원하는 주제별로 테스트를 묶어서 출력이 가능합니다.

@Nested
@DisplayName("Test 1 첫번째 주제")
class Test1 {
	@Test
    @DisplayName("Test1 - test1()")
	void test1() {
    	System.out.println("Test1.test1");
    }

	@Test
    @DisplayName("Test1 - test2()")
    void test2() {
    	System.out.println("Test1.test2");
    }
}

@Nested
@DisplayName("Test2 다른 주제")
class Test2 {

	@Test
    @DisplayName("Test2 - test1()")
    void test1() {
    	System.out.println("Test2.test1");
    }

	@Test
    @DisplayName("Test2 - test2()")
    void test2() {
    	System.out.println("Test2.test2");
    }
}

@TestMethodOrder, @Order

@TestMethodOrder 어노테이션을 통해 메소드의 실행 순서 설정이 가능합니다. 이후 @Order 어노테이션에 번호를 부여하여 실행 순서를 결정할 수 있습니다.

@Nested
@DisplayName("테스트 순서 정해서 실행하기")
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
class Test0 {

	@Order(1)
    @Test
    @DisplayName("Test 1 - 첫번째")
    void test1() {
    	System.out.println("1");
    }

	@Order(3)
    @Test
    @DisplayName("Test2 - 세번째")
    void test2() {
    	System.out.println("3");
    }

	@Order(2)
    @Test
    @DisplayName("Test3 - 두번째")
    void test3() {
    	System.out.println("2");
    }
}

@RepeatedTest

@RepeatedTest를 사용하면 테스트를 반복문처럼 여러번 실행 가능합니다.

value 값으로 몇번 반복할 것인지 정할 수 있고, name 부분에 {currentRepetition} 를 통해 몇번째 반복중인지, {totalRepetitions} 를 통해 총 몇번 반복을 수행할 것인지 테스트 마다 이름을 정의해 줄 수 있습니다. 또한 RepetitionInfo 를 주입받아 현재 몇번째 테스트 수행중인지, 총 몇번 테스트를 수행할 것인지에 대한 정보도 받아올 수 있습니다.

@RepeatedTest(value = 5, name = "반복 테스트 {currentRepetition} / {totalRepetitions}")
void repeatTest(RepetitionInfo info) {
	System.out.println("테스트 반복 : " + info.getCurrentRepetition() + " / " + info.getTotalRepetitions());
}

@ParameterizedTest

@ParameterizedTest를 통해 매개변수를 받는 테스트를 작성 할 수 있습니다. @ValueSource로 파라미터를 전달 가능하고, 전달되는 파라미터의 개수만큼 테스트가 반복되어 실행됩니다.
(아래의 경우 파라미터 별로 한번씩 총 9 번 테스트 반복 실행)

@DisplayName("파라미터 값 활용하여 테스트 하기")
@ParameterizedTest
@ValueSource(ints = {1, 2, 3, 4, 5, 6, 7, 8, 9}) // 파라미터 수만큼 반복
void parameterTest(int num) {
	System.out.println("5 * num = " + 5 * num);
}

🌱 Assertions

이전에는 주로 assertj 의 Assertions 에서 assertThat() 메소드를 주로 사용했었지만, 오늘은 jupiter의 Assertions 메소드를 정리 해 보려 합니다.

assert(Not)Equals(expected, actual)

메소드의 첫번째 매개변수로 예상하는 값, 그리고 두번째 매개변수로 실제로 나온 값을 넣어 예상과 실제가 맞는지 판단해주는 메소드 입니다. 예측과 실제 값이 다를경우 실제와 어떻게 다른지 값을 비교하여 출력해 줍니다.

@Test
@DisplayName("assertEquals")
void test1() {
	Double result = 4.0/2;
	assertEquals(2.5, result);
}

이렇게 테스트 실패 시 원하는 문구를 지정하여 출력해 줄 수도 있습니다.

@Test
@DisplayName("assertEquals - Supplier")
void test1_1() {
	Double result = calculator.operate(5, "/", 0);
	// 테스트 실패 시 메시지 출력 (new Supplier<String>())
	assertEquals(2.5, result, () -> "연산자 혹은 분모가 0이 아닌지 확인해보세요!");
}

assertTrue(true), assertFalse(false)

assertTrue, assertFalse를 통해 참 거짓여부를 판단할 수도 있습니다.

@Test
@DisplayName("assertTrue 와 assertFalse")
void test2() {
	assertTrue(true);   // 매개변수 전달 값이 true일 경우 테스트 통과
	assertFalse(false); //  매개변수 전달 값이 false일 경우 테스트 통과
}

assert(Not)Null(Object)

assertNull을 통해 전달받은 매개변수가 Null인지 아닌지에 대한 여부도 판단 가능합니다.

@Test
@DisplayName("assertNotNull 과 assertNull")
void test3() {
	Double result1 = calculator.operate(5, "/", 2);
	assertNotNull(result1);
	Double result2 = calculator.operate(5, "/", 0);
	assertNull(result2);
}

assertThrows

assertThrows를 통해 예외가 발생하는지 여부를 테스트 할 수 있습니다. 첫번째 매개변수로는 발생할것으로 예상되는 Exception의 타입을 넣어주고, 두번째 매개변수로는 예외가 발생할 상황을 넣어서 테스트 합니다.

@Test
@DisplayName("assertThrows")
void test4() {
	IllegalArgumentException exception = assertThrows(IllegalArgumentException.class, () -> {
		throw new IllegalArgumentException("IllegalArgumentException 발생");
	});
	assertEquals("IllegalArgumentException 발생", exception.getMessage());
}

이 외에도 더 다양한 어노테이션과 기능들이 있는데요, 추가적으로 알아보고 싶으시다면 아래 참고 링크를 통해 더 다양한 JUnit5 기능들을 살펴볼 수 있습니다.

---

참고

• https://junit.org/junit5/docs/current/user-guide/#writing-tests-annotations