[spring-test] standaloneSetup() vs webAppContextSetup()

프로젝트를 진행하며 Spring Security가 적용된 곳을 테스트하기 위해 `@WithSecurityContext` 라는 메타 어노테이션을 이용해 커스텀 어노테이션을 생성했다. 하지만 SecurityContext에 테스트에서 활용할 인증 정보를 주입했는데도 계속해서 인증때문에 테스트가 fail하는 상황이 발생했다..

 

무한 삽질을 통해 MockMvc를 초기화하는 방법에 따라 테스트 환경이 달라짐을 깨달았다.

 

MockMvc

실제로 네트워크에 연결하지 않고도 API 테스트가 가능하도록 모킹된 객체이다. 주로 Controller 레이어 단위 테스트에 많이 사용된다.

MockMvcBuilder를 사용해서 파라미터를 셋팅해주어야 하는데, `standaloneSetup` 혹은 `webAppContextSetup` 중 하나를 셋해주면 된다.

 

MockMvcBuilders.standaloneSetup(Object... controllers)

- Spring 컨텍스트를 로드하지 않고 Spring MVC의 DispatcherServlet만 초기화합니다.

- 순수한 Spring MVC 환경에서 특정 컨트롤러를 테스트하기 위해 사용됩니다.

- Spring 애플리케이션 컨텍스트 설정을 고려하지 않기 때문에 테스트가 빠르게 실행됩니다.

- 주로 Spring MVC 컨트롤러를 유닛 테스트할 때 사용됩니다.

public class DiaryControllerTest {

	@InjectMocks
	FriendshipController friendshipController;
    
	private MockMvc mockMvc;
    
    @BeforeEach
    public void init() {
        mockMvc = MockMvcBuilders.standaloneSetup(friendshipController).build();
    }
    ...
}

 

MockMvcBuilders.webAppContextSetup(WebApplcationContext context)

- 스프링 웹 애플리케이션 전체 컨텍스트를 로드하여 실제 환경과 유사한 환경에서 테스트를 수행합니다.

- 스프링 애플리케이션 컨텍스트의 설정을 고려하기 때문에 스프링 웹 애플리케이션의 통합 테스트 시에 주로 사용됩니다.

- 실제 웹 애플리케이션 환경을 모방하므로 컨텍스트 설정, 필터, 인터셉터 등을 포함하여 더 많은 기능을 테스트할 수 있습니다.

@WebMvcTest(FriendshipController.class)
public class DiaryControllerTest {

	@Autowired
    protected WebApplicationContext context;
    
    private MockMvc mockMvc;
    
    @BeforeEach
    public void init() {
        mockMvc = MockMvcBuilders.webAppContextSetup(context).build();
    }
    ...
}

 

커스텀 애노테이션이 테스트에 적용되지 않았던 이유

결론부터 말하자면, standaloneSetup을 사용하면 스프링 애플리케이션 컨텍스트를 로드하지 않기 때문이다.

 

`@WithMockCustomUser`라는 애노테이션을 사용하려면 스프링 시큐리티와 관련된 컨텍스트를 설정해야 한다.

하지만 standaloneSetup은 스프링 애플리케이션 컨텍스트를 로드하지 않게 때문에 스프링 시큐리티와 관련된 설정이나 커스텀 애노테이션은 이러한 테스트에서 적용되지 않는다.

 

webAppContextSetup을 이용해 mockMvc를 주입하여 문제를 해결했다. 😃

 

🔗 참고

[Spring-test] standaloneSetup vs webAppContextSetup