@WebMvcTest 작성 시 의존성 에러

환경

• Spring boot 2.7.1
• Spring Security
• JUnit 5

Controller 테스트를 하기위해 불필요한 의존성들은 걷어내고 WebMvcTest 어노테이션을 붙여서 컨트롤러 레이어만 가볍고 빠르게 테스트를 진행할 수 있습니다.

WebMvcTest 어노테이션을 붙이게 되면, MVC 테스트를 위한 의존성들이 Spring Contetxt에 올라가게 됩니다.

 

Using this annotation will disable full auto-configuration and instead apply only configuration relevant to MVC tests (i.e. @Controller, @ControllerAdvice, @JsonComponent, Converter/GenericConverter, Filter, WebMvcConfigurer and HandlerMethodArgumentResolver beans but not @Component, @Service or @Repository beans).

@WebMvcTest는 WebSecurityConfigurerAdapter, WebMvcConfigurer를 비롯한 @ControllerAdvice, @Controller를 읽습니다. 즉 @Component, @Service, @Repository는 스캔 대상이 아닙니다.

 

현재 Spring Security 설정에는 JWT을 사용하기 위한 빈들이 등록되어 있는 상태입니다.

 

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Bean
    public JwtTokenUtil jwtTokenUtil() {
        return new JwtTokenUtil();
    }

    @Bean
    public PasswordEncoder bCryptPasswordEncoder() {
        return new BCryptPasswordEncoder();
    }

    @Bean
    public AuthenticationManager authenticationManagerBean() throws Exception {
        return super.authenticationManagerBean();
    }

    @Bean
    public JwtAuthenticationFilter jwtAuthenticationFilter() throws Exception {
        return new JwtAuthenticationFilter(jwtTokenUtil(), authenticationManagerBean(), new ObjectMapper());
    }

    ...

Spring Security 설정은 WebMvcTest의 스캔대상에 포함되므로 내부에 있는 빈들을 읽을 수가 없어서 아래와 같은 에러가 발생합니다.

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'springSecurityFilterChain' defined in class path resource [org/springframework/security/config/annotation/web/configuration/WebSecurityConfiguration.class]: Bean instantiation via factory method failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [javax.servlet.Filter]: Factory method 'springSecurityFilterChain' threw exception; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'jwtAuthenticationFilter' defined in class path resource [me/iseunghan/todolist/config/SecurityConfig.class]:.....

해결방법

Controller 레이어 테스트에 중점을 두기 위해 Security 설정을 스캔 대상에서 제외 시킵니다.

@WebMvcTest(controllers = AdminApiController.class,
        excludeFilters = {
                @ComponentScan.Filter(
                        type = FilterType.ASSIGNABLE_TYPE,
                        classes = SecurityConfig.class
                )}
)
public class AdminApiControllerTest {

}

 

REFERENCE

• joomn11님의 블로그