[삽질록] Spring Security 인증 구현 이전에 테스트 코드 실행 시 401 에러 해결

🆘 문제상황

@DisplayName("컨트롤러 - Post")
@WebMvcTest(PostController.class) //MVC 관련 빈들만 로드함 - 테스트 실행이 빠르고, 메모리 사용량 적음 | 서비스, 리포지토리 등의 빈은 로드되지 않음
class PostControllerTest {

    private final MockMvc mvc; //HTTP 요청을 모의(mock)하여 컨트롤러의 동작을 테스트 | 실제 웹 서버를 띄우지 않고도 컨트롤러의 요청-응답 흐름을 테스트할 수 있음

    // 필드주입
    @MockBean // ->MockBean이 생성자 주입 지원하지 않음
    private PostService postService;

    // 생성자주입
    PostControllerTest(
            @Autowired MockMvc mvc
    ) {
        this.mvc = mvc;
    }

    @DisplayName("[view] [GET] 포스트 리스트 (피드) 페이지 - 정상 호출")
    @Test
    void givenNothing_whenRequestingPostsView_thenReturnsPostsView() throws Exception {
        // Given
        given(postService.getPosts(any(Pageable.class)))
                .willReturn(Page.empty());

        // When & Then
        mvc.perform(get("/posts"))
                .andExpect(status().isOk())
                .andExpect(content().contentTypeCompatibleWith(MediaType.TEXT_HTML))
                .andExpect(view().name("posts/index"))
                .andExpect(model().attributeExists("posts"));
        then(postService).should().getPosts(any(Pageable.class));
    }

Status expected:<200> but was:<401>
Expected :200
Actual   :401
<Click to see difference>
java.lang.AssertionError: Status expected:<200> but was:<401>
at org.springframework.test.util.AssertionErrors.fail(AssertionErrors.java:59)
at org.springframework.test.util.AssertionErrors.assertEquals(AssertionErrors.java:122)
at org.springframework.test.web.servlet.result.StatusResultMatchers.lambda$matcher$9(StatusResultMatchers.java:637)
at org.springframework.test.web.servlet.MockMvc$1.andExpect(MockMvc.java:214)
at com.project.sns.controller.PostControllerTest.givenNothing_whenRequestingPostsView_thenReturnsPostsView(PostControllerTest.java:50)
at java.base/java.lang.reflect.Method.invoke(Method.java:568)

→ 간단한 페이지 뷰 GET메서드의 실행 결과를 테스트 하는 코드인데 401 Unauthorized 에러가 발생했다.

원인

@WebMvcTest는 기본적으로 컨트롤러와 관련된 웹 계층을 테스트할 때 사용되며,
실제 인증 메커니즘 (예: Spring Security)도 함께 적용된다.

⇒ 인증이 필요한 컨트롤러 엔드포인트를 테스트할 때 인증이 이루어지지 않으면 401 Unauthorized 오류가 발생한다.

 

✅ 해결 방법

@WebMvcTest와 함께 Spring Security를 사용한다면, 인증이 필요한 테스트에서 MockMvc에 인증 정보를 제공하면 된다.

⇒ 테스트 시에 Spring Security와 관련된 사용자 인증 절차를 모킹하여 실제 인증 없이( 인증된 사용자가 있는 것처럼 ) 컨트롤러 테스트를 실행하자!

@DisplayName("컨트롤러 - Post")
**@Import(TestSecurityConfig.class) //✅이 부분을 통해 Import하자**   
@WebMvcTest(PostController.class) //MVC 관련 빈들만 로드함 - 테스트 실행이 빠르고, 메모리 사용량 적음 | 서비스, 리포지토리 등의 빈은 로드되지 않음
class PostControllerTest {

import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.BDDMockito.given;

@Import(SecurityConfig.class)
public class TestSecurityConfig {

    @MockBean private UserAccountService userAccountService;

    @BeforeTestMethod //각 테스트 메서드가 실행되기 전에 수행
    public void securitySetUp() {
        // 각 테스트 실행 직전에 인증정보 넣어주라고 작성함
        given(userAccountService.searchUser(anyString()))
                .willReturn(Optional.of(createUserAccountDto()));
        given(userAccountService.saveUser(anyString(), anyString(), anyString(), anyString(), anyString()))
                .willReturn(createUserAccountDto());
    }

    private UserAccountDto createUserAccountDto() {
       return UserAccountDto.of(
               "ellaTest",
               "pw",
               "ella-test@mail.com",
               "ella-test",
               "test memmo"
       );
    }
}

@Import (SecurityConfig.class)

Spring의 특정 설정 클래스를 현재 테스트 컨텍스트에 추가할 때 사용
SecurityConfig.class를 테스트 환경에 가져와서 Spring Security 설정이 테스트에 반영되도록 함

@MockBean

UserAccountService 빈을 목(Mock)으로 만듬

MockBean으로 생성된 객체는 해당 빈이 필요한 모든 곳에 주입됨
- 실제 서비스 레이어의 로직을 테스트 할 필요 없음
- 원하는대로 mock된 응답을 정의할 수 있음

securitySetUp 메서드

userAccountService의 특정 메서드 호출에 대해 미리 정의된 값을 반환하도록 설정
Ex)
userAccountService.searchUser(anyString()) 메서드가 호출될 때, 미리 정의한 UserAccountDto 객체를 반환하도록 설정

createUserAccountDto() 메서드

테스트 중에 사용될 모의(Mock) 사용자 데이터를 반환하여, 테스트 환경에서 사용자의 인증 정보를 미리 구성