[spring-test] JUnit5 Test 정리

JUnit5의 장단점

장점

• JUnit5는 JUnit4의 문제점을 보완하고 새로운 기능을 추가했습니다.
• 테스트 인스턴스 라이프사이클을 지원하고, 동적 테스트를 지원하며, 테스트 파라미터화 기능도 추가되었습니다.
• 또한 모듈화가 가능하여 필요한 모듈만 사용할 수 있습니다.

 

- 단점

• JUnit5는 아직 많은 Java 개발자들이 익숙하지 않습니다. 또한 IDE 지원이 JUnit4에 비해 미흡한 경우도 있습니다.
• JUnit5가 JUnit4에 비해 많은 새로운 기능을 제공하므로 최근에는 더 많이 사용되고 있습니다.
• 그러나 일부 프로젝트에서는 아직 JUnit4를 계속 사용하고 있습니다.

 

주요 어노테이션 정리

@ExtendWith()

JUnit 5의 어노테이션으로, JUnit 4의 `@RunWith` 을 대체한다. `@RunWith` 에서 Runner 의 구현체를 인자로 받았던 것처럼, 여기서는 Extension 인터페이스의 구현체를 인자로 받는다. Junit 5 Test에서 사용할 기능을 확장할때 사용된다.

이때 옵션으로 `@ExtendWith (SpringExtension.class)`와 `@ExtendWith (MockitoExtension.class)`이 많이쓰인다.

 

@ExtendWith (SpringExtension.class) - Spring MVC 테스트

SpringExtension은 Spring 테스트를 쉽게할 수 있도록 도와주는 Extension입니다. 이를 이용하면 Spring 테스트에 사용할 ApplicationContext를 쉽게 생성할 수 있습니다.

(🔗 SpringExtension은 ApplicationContext를 어떻게 만들까?)

 

@SpringBootTest, @DataJpaTest, @WebMvcTest, @JdbcTest 등의 어노테이션은 `@ExtendWith (SpringExtension.class)`을 이미 포함하고 있습니다.

 

@ExtendWith (MockitoExtension.class)

Mockito와 JUnit 5를 통합하여 목 객체(Mock Objects)를 쉽게 생성하고 사용할 수 있도록 도와주는 어노테이션입니다. 이 어노테이션을 사용하면 테스트 클래스에서 Mockito와 함께 목 객체를 초기화하고 주입할 수 있습니다. (`@Mock` 어노테이션 필드의 초기화)

 

`@ExtendWith(MockitoExtension.class)`를 사용하면 `@Mock` 어노테이션을 필드에 적용하여 목 객체를 생성하고, `@InjectMocks` 어노테이션을 사용하여 목 객체를 주입할 수 있습니다. 이를 통해 의존성을 가진 컴포넌트를 쉽게 목 객체로 대체할 수 있습니다.

@ExtendWith(MockitoExtension.class)
public class MyServiceTest {

    @InjectMocks
    private MyService myService;

    @Mock
    private MyRepository myRepository;

    // 테스트 코드 작성
}

 

또한, 아래 두 가지 방법은 동일하게 동작합니다.

// 방법 1
@ExtendWith(MockitoExtension.class)
public class JUnit5TestClass {...}

// 방법 2
public class JUnit5TestClass {
	@BeforeEach
    void setUp(){
        //중요! : base class 또는 test runner가 필요합니다. 여기서는 MockTest를 넣어줍니다.
        //역할 : @Mock 어노테이션 필드의 초기화
        MockitoAnnotations.openMocks(this);
    }
}

 

@SpringBootTest() - Spring 통합 테스트

`@SpringBootTest` 어노테이션은 JUnit 4와 JUnit 5에 공통입니다. 차이점은, JUnit5의 @SpringBootTest에는 `@ExtendWith(SpringExtension.class)`가 선언되어 있습니다.

 

`@SpringBootTest` 어노테이션이 붙어있는 테스트 클래스가 실행되면, `@SpringBootApplication` 어노테이션을 찾아 모든 빈을 로드합니다. 덕분에 실제 코드처럼 의존성을 주입하여 사용 가능하나 테스트가 많이 무거워지게 된다.

 

또한 실제 빈을 주입받아 테스트하게 됨으로써 데이터를 삽입하거나 삭제하면 실제 데이터의 변화가 생길 수 있다. 의도한게 아니라면 꼭 `@Transactional`을 이용하여 rollback 처리하도록 한다.

@SpringBootTest
public class JUnit5TestClass {
	// 의존성 주입은 @AutoWired를 이용한다.
    @AutoWired
    TestService testservice;
}

 

일반적인 의존성 주입 방법은 아래 4가지를 사용한다.
1. 생성자를 통해 의존성 주입
2. 필드를 통해서 의존성 주입
3. setter를 통해서 의존성 주입
4. lombok을 이용한 final 필드에 의존성 주입

Junit에서 의존성 주입을 하기 위해 다양한 방법을 시도하겠지만 가장 간단한 방법은 `@AutoWired`를 이용하는 것이다. 생성자나 lombok 방식을 사용하게 되면 에러가 발생할 것이다.

에러가 발생하는 원인은 JUnit 5가 DI를 스스로 지원하기 때문이다. 또한 DI를 지원하는 타입이 정해져있다.
JUnit 5에서 생성자나 lombok을 이용할 수 없는 이유는, JUnit이 생성자에 의존성을 주입하려고 먼저 개입하기 때문이다.
 
🔗 [JUnit] Spring Boot 테스트하기 (Migration from JUnit4 to Junit5)

 

🤔 Spring MVC 테스트 vs Spring 통합 테스트

Spring MVC 테스트
Spring MVC 테스트는 주로 웹 계층(controller)을 테스트하는 데 사용됩니다.주로 MockMvc를 사용하여 컨트롤러의 동작 및 웹 요청-응답 주기를 테스트합니다.테스트 시에는 실제 웹 서버나 데이터베이스를 사용하지 않으며, 주로 스프링의 @WebMvcTest 어노테이션과 함께 사용됩니다.테스트 대상은 컨트롤러와 관련된 로직이며, 애플리케이션의 다른 부분(서비스, 리포지토리 등)은 목 객체(Mock)를 사용하여 가짜 객체로 대체합니다.이러한 테스트는 빠르게 실행되며, 웹 계층에 초점을 맞춥니다.

Spring 통합 테스트
Spring 통합 테스트는 스프링 애플리케이션의 여러 구성 요소(컨트롤러, 서비스, 리포지토리 등) 간의 상호 작용을 테스트하는 데 사용됩니다.실제로 애플리케이션 컨텍스트를 로드하고, 실제 데이터베이스와 통합하여 동작합니다.주로 @SpringBootTest 어노테이션과 함께 사용되며, 애플리케이션 전체를 초기화하고 실제 빈을 사용합니다.애플리케이션의 여러 계층 간 상호 작용 및 통합 동작을 검증하며, 더 많은 시간과 리소스를 필요로 합니다.

웹 계층(controller)에 초점을 둔 빠른 테스트를 원한다면 Spring MVC 테스트를 고려하고, 애플리케이션 전체의 상호 작용 및 통합 동작을 검증하려면 Spring 통합 테스트를 고려할 수 있습니다.

 

@WebMvcTest()

컨트롤러를 테스트할 때 주로 이용됩니다. 주의할 점은 @Service, @Component, @Repository 등은 사용할 수 없습니다.

그 이유는 단일 클래스의 테스트를 진행하기 때문인데, 만약 사용하고 싶다면 @MockBean을 통해 각자 객체를 만들어 주어야 합니다.

 

(예를 들어, `@WebMvcTest(DiaryController.class)`로 지정했다면, FriendshipController와 관련된 스프링 빈들만 로드하므로 다른 컨트롤러나 서비스와 관련된 빈들은 로드되지 않습니다.)

 

@DataJpaTest

 

@Test

Test 어노테이션은 JUnit 4와 JUnit 5에 공통입니다. 어노테이션에 있는 메서드는 클래스의 테스트 케이스를 나타냅니다.

 

@MockBean

@WebMvcTest를 이용한 테스트에서 사용할 수 있습니다.

Bean 컨테이너에 객체(Service)가 있어야 다른 객체(Controller)와 협력할 수 있는데, 객체를 만들 수 없는 경우 @MockBean을 사용합니다.

@WebMvcTest(RegionController.class)
public class JUnit5TestClass {
   @Autowired
   private MockMvc mvc;

   @MockBean
   private RegionService regionService;

    @Test
    void getRegions() throws Exception {
        List<Region> regions = new ArrayList<>();
        regions.add(
        	Region.builder()
                .name("Seoul")
                .build()
        );

        given(regionService.getRegions()).willReturn(regions);

        mvc.perform(get("/regions"))
        	.andExpect(status().isOk());
    }
}

 

@Mock

mock 객체를 생성합니다.

 

@InjectMocks

@Mock로 주석이 달린 mock 객체를 @InjectMocks로 주석이 달린 객체에 주입시킬 수 있습니다. 실무에서는 Service 테스트 mock 객체에 DAO mock 객체를 주입시켜 사용한다.

public class MembmerServiceTest{
    @Mock
    MemberDao memberDao;

    @InjectMocks
    MemberService memberService;

    @Test
    public void test(){
            when(memberDao.getMemberCount()).thenReturn(0);

            Member member = new Member("corn", 25);
            assertThat(memberService.createMember(member), is(member));
    }
}

 

@SpyBean

 

@BeforeEach / @AfterEach

- 테스트 클래스의 각 테스트 메서드를 실행하기 전에 실행됩니다.

- 각 테스트를 시작하기 직전/후에 리소스 또는 테스트 데이터를 설정하려는 경우 사용할 수 있습니다.

- 예를 들어, JUnit 테스트 클래스에 5개의 테스트 케이스가 있는 경우 @BeforeEach / @AfterEach로 주석이 달린 메서드는 각 테스트 케이스가 실행되기 전/후에 5번 실행됩니다.

 

@BeforeAll / @AfterAll

- 테스트 클래스의 모든 테스트 메서드가 실행되기 전/후에 실행됩니다.

- 클래스 수준에서 데이터를 테스트하려는 경우에 사용할 수 있습니다.

- 예를 들어, JUnit 테스트 클래스에 5개의 테스트 케이스가 있는 경우 @BeforeAll / @AfterAll로 주석이 달린 케서드는 테스트 케이스가 시작되기 전/후에 테스트 클래스 당 한 번 실행됩니다.

 

@Disabled

특정 테스트 메서드를 실행하지 않도록 지정합니다. 일시적으로 테스트를 비활성화하고자 할 때 사용됩니다.

 

🔗 참고

Spring JUnit5 Test정리

[Mock과 Mockito] @Mock @MockBean

[Spring Boot] Controller 단위 테스트 (@WebMvcTest, MockMvc)