[Spring Security] @WebMvcTest 작성 시 Spring Security로 인해 발생하는 오류들

 

 

 

 

@WebMvcTest를 통해 Controller에 대한 테스트를 진행하는 경우 Spring Security를 적용하였다면 Security가 제공하는 기본적인 Filter들에 대하여 어떻게 대응해야 하는지 걱정이 될 수도 있으며,

테스트 진행 도중  Error creating bean~~등의 오류가 발생할 수도 있습니다.

 

이에 대한 해결 방법에 대해 알아보겠습니다.

 

 

 

 

 

 

 

 

 

어떤 오류가 발생했나요? 🧐

아래는 제가 발생시켰던 오류이며, 제가 작성한 클래스의 이름이나 Directory에 대한 경로는 ~~ 로 처리하였습니다.

Caused by: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name '~~' defined in file [~~]: Unsatisfied dependency expressed through constructor parameter 1; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type '~~' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}

 

 

 

 

 

 

 

 

 

 

 

왜 오류가 발생했나요? 🧐

제가 작성한 테스트 코드는 다음과 같았습니다.

@WebMvcTest(controllers = MainTravelController.class)
class MainTravelControllerTest {

 

 

 

WebMvcTest에 대한 설명을 살펴보면 다음과 같습니다.

WebMvcTest Anotation은 Spring MVC 컴포넌트에 초점을 맞추어 테스트를 진행할 수 있는 Anotation입니다.

이를 사용하면 스프링부트 애플리케이션을 전체 로팅하는 것이 아니라 
@Controller, @ControllerAdvice, @JsonComponent,Converter/GenericConverter, Filter, WebMvcConfigurer 및 HandlerMethodArgumentResolver 빈이 아닌
@Component, @Service 또는 @Repository 빈)와 관련된 구성만 적용됩니다.

기본적으로 @WebMvcTest 주석이 달린 테스트는 Spring Security 및 MockMvc도 자동 구성합니다

 

설명에도 나와있듯이 Spring Security 관련된 컴포넌트도 자동 구성합니다.

 

저의 Spring Security 관련 컴포넌트는 다음과 같습니다.

 

이때 Security 관련된 컴포넌트에서 의존하는 다른 빈들이 @WebMvcTest에 의해 등록되지 않는 빈들이라면 오류가 발생하게 됩니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

어떻게 해결하나요? 🧐

무작정 관련된 의존성들을 @Autowire로 주입받으면 @WebMvcTest를 사용하여 가볍게 테스트를 진행하고자 하는 목적이 애매해집니다.

 

 

그럼 관련된 의존성들을 @MockBean등을 사용하여 Mock 객체를 주입해주면 어떨까요???

 

실행은 되지만, 인증이 필요한 url로 요청을 보낸 경우 403 오류가 뜹니다.

 

이는 인증이 필요한 요청에 대해 인증을 진행할 때 필요한 빈들에 Mock 객체가 저장되어 인증이 제대로 진행되지 않기 때문입니다.

 

또 다른 해결방법은 Spring Security 관련 컴포넌드들을 @WebMvcTest의 Component Scan 대상에서 제외시키는 방법입니다.

 

 

그러면 해결될까요???

 

안타깝게도 여기서는 401 오류가 발생합니다.

이는 Security가 기본적으로 제공하는 인증 필터들에 의해 인증이 되지 않기에 발생한 문제입니다.

 

 

관련 의존성에 대한 Mock 객체 주입, 또는 필터에서 제외하는 방법들에서 401, 403 상태코드가 반환되는 오류에 대한 해결방법을 알아보도록 하겠습니다.

 

 

 

 

 

 

 

 

 

 

401, 403 오류가 발생하는데요? 🧐

@WithMockUser를 통해 해결합니다

 

 

 

 

 

 

 

 

 

 

@WithMockUser는 어떻게 쓰나요? 🧐

WithMockUser는 다음과 같이 작성되어 있습니다.

이를 통해 원하는 Role과 username, password 등을 설정할 수 있으며,

이러한 정보는 결국 SecurityContextHolder에 저장됩니다.

 

따라서 SecurityContextHolder가 필요한 요청이던, 그렇지 않던 이에 대한 정보를 개발자가 직접 지정하여 사용할 수 있습니다.

 

다음과 같이 테스트 케이스 위에 @WithMockUser를 달아주면 해결됩니다.

추가적인 속성이 필요한 경우 이에 대한 정보를 추가해주시면 됩니다.

 

 

 

 

 

 

 

 

 

 

 

 

Component Scan 대상에서 제외   VS   Mock 객체 등의 의존성 주입 🧐

Component Scan 대상에서 Security 관련 컴포넌트를 제외한다면, Role에 따라 접근 가능 여부가 달라지는 경우에 대한 테스트 등을 할 수 없어집니다.

 

그러나 이는 설정 정보에 잘 작성하였으면 Security에서 제공해 주는 기능이기에 따로 확인하지 않아도 잘 작동할 것이라 믿을 수 있습니다.

개인 나름이지만 저는 이에 대해서도 확인이 필요하다 생각하는데, Security 관련 설정이 잘못되었을 수도 있기 때문에 이에 대한 테스트도 이루어지는 것이 더 안전하다고 생각하기 때문입니다.

 

다른 의견 있다면 댓글로 알려주세요!! (아무도 안보겠지만  ㅠ)