[Test] MockTest 중 발생한 401 (Unauthorized) 에러

🛠 개발환경

Editor : Intellij Ultimate

Deb Tool : SpringBoot 2.7.5

JDK : JAVA 11

Build : Gradle 6.8

Server : AWS EC2

DB : MySql 8.0

Library : SpringBoot Web, MySQL, Spring Data JPA, Lombok, Spring Security

 

 

❓ 기능 Test 진행 중 발생한 401 Error ❓

최근 Mock을 이용한 BDD 기반 테스트 코드를 작성하는 연습을 하고 있다. 테스트 코드를 이용한 기능 테스트 진행 중 401Error를 마주쳤다.

import com.fasterxml.jackson.databind.ObjectMapper;
import com.likelion.healing.domain.dto.CommentReq;
import com.likelion.healing.domain.entity.CommentEntity;
import com.likelion.healing.domain.entity.PostEntity;
import com.likelion.healing.domain.entity.UserEntity;
import com.likelion.healing.service.CommentService;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.http.MediaType;
import org.springframework.security.test.context.support.WithMockUser;
import org.springframework.test.web.servlet.MockMvc;

import java.time.LocalDateTime;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.BDDMockito.given;
import static org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.csrf;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(CommentController.class)
class CommentControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @MockBean
    CommentService commentService;

    @Autowired
    ObjectMapper objectMapper;

    @Nested
    @DisplayName("댓글 등록 테스트")
    class AddCommentTest{

        @Test
        @DisplayName("댓글 등록 성공")
        void successfulAddComment() throws Exception {
            CommentReq req = CommentReq.builder()
                    .comment("comment")
                    .build();

            CommentEntity comment = CommentEntity.builder()
                                            .id(1)
                                            .comment("comment")
                                            .post(PostEntity.builder().id(3).build())
                                            .user(UserEntity.builder().userName("user").build())
                                            .build();
            LocalDateTime nowTime = LocalDateTime.now();
            comment.setCreatedAt(nowTime);
            comment.setUpdatedAt(nowTime);

            given(commentService.addCommentByPostId(any(Integer.class), any(CommentReq.class), any(String.class)))
                    .willReturn(comment);

            mockMvc.perform(post(String.format("/api/v1/posts/%d/comments", 3))
                            .with(csrf())
                            .contentType(MediaType.APPLICATION_JSON)
                            .content(objectMapper.writeValueAsBytes(req)))
                    .andDo(print())
                    .andExpect(status().isOk())
                    .andExpect(jsonPath("$.resultCode").value("SUCCESS"))
                    .andExpect(jsonPath("$.result.id").value(1))
                    .andExpect(jsonPath("$.result.comment").value("comment"))
                    .andExpect(jsonPath("$.result.postId").value(3))
                    .andExpect(jsonPath("$.result.userName").value("user"))
                    .andExpect(jsonPath("$.result.createdAt").exists())
                    .andExpect(jsonPath("$.result.lastModifiedAt").exists());
        }
    }

}

 

 

👀 401(Unauthorized) 가 무슨 에러일까

401에러는 Unauthorized를 의미하며, 해당 기능을 요청한 클라이언트가 증명되지 않은 상태이기 때문에 요청이 거부되었다는 의미이다. 즉, 클라이언트가 인증되지 않아 요청을 정상적으로 처리할 수 없음을 의미하는 상태코드이다.

 

해당 에러는 403에러인 Forbidden과 유사해보이지만 전혀 다르다. 403 에러는 증명된 클라이언트가 요청을 하였지만 해당 리소스를 이용할 권한이 없어 발생하는 것이다.

 

쉽게 예시를 들자면, 다음과 같다.

401 - 로그인이 안된 사용자가 게시글에 글쓰기를 요청

403 - 회원으로 로그인한 사용자가 관리자 페이지로 이동하기를 요청

 

 

💡 해결 방법

Test Class 상단에 @WithMockUser를 선언함으로써 인증된 상태의 User를 가정한 상태에서 Test를 진행함으로써 해결할 수 있었다.

package com.likelion.healing.controller;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.likelion.healing.domain.dto.CommentReq;
import com.likelion.healing.domain.entity.CommentEntity;
import com.likelion.healing.domain.entity.PostEntity;
import com.likelion.healing.domain.entity.UserEntity;
import com.likelion.healing.service.CommentService;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.http.MediaType;
import org.springframework.security.test.context.support.WithMockUser;
import org.springframework.test.web.servlet.MockMvc;

import java.time.LocalDateTime;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.BDDMockito.given;
import static org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.csrf;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(CommentController.class)
@WithMockUser(username = "user")  // ✨
class CommentControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @MockBean
    CommentService commentService;

    @Autowired
    ObjectMapper objectMapper;

    @Nested
    @DisplayName("댓글 등록 테스트")
    class AddCommentTest{

        @Test
        @DisplayName("댓글 등록 성공")
        void successfulAddComment() throws Exception {
            CommentReq req = CommentReq.builder()
                    .comment("comment")
                    .build();

            CommentEntity comment = CommentEntity.builder()
                                            .id(1)
                                            .comment("comment")
                                            .post(PostEntity.builder().id(3).build())
                                            .user(UserEntity.builder().userName("user").build())
                                            .build();
            LocalDateTime nowTime = LocalDateTime.now();
            comment.setCreatedAt(nowTime);
            comment.setUpdatedAt(nowTime);

            given(commentService.addCommentByPostId(any(Integer.class), any(CommentReq.class), any(String.class)))
                    .willReturn(comment);

            mockMvc.perform(post(String.format("/api/v1/posts/%d/comments", 3))
                            .with(csrf())
                            .contentType(MediaType.APPLICATION_JSON)
                            .content(objectMapper.writeValueAsBytes(req)))
                    .andDo(print())
                    .andExpect(status().isOk())
                    .andExpect(jsonPath("$.resultCode").value("SUCCESS"))
                    .andExpect(jsonPath("$.result.id").value(1))
                    .andExpect(jsonPath("$.result.comment").value("comment"))
                    .andExpect(jsonPath("$.result.postId").value(3))
                    .andExpect(jsonPath("$.result.userName").value("user"))
                    .andExpect(jsonPath("$.result.createdAt").exists())
                    .andExpect(jsonPath("$.result.lastModifiedAt").exists());
        }
    }
}

정의된 MockUser는 "user"라는 userName과 "password"라는 password 그리고 "ROLE_USER"라는 권한을 갖고 있음을 가정해주어 더이상 401(Unathorized)가 발생하지 않은 것을 확인할 수 있었다.

 

 

참고 문서

https://developer.mozilla.org/ko/docs/Web/HTTP/Status/401

401 Unauthorized - HTTP | MDN

https://docs.spring.io/spring-security/site/docs/5.2.x/reference/html/test.html#test-method-withmockuser

18. Testing

https://catsbi.oopy.io/f9b0d83c-4775-47da-9c81-2261851fe0d0

스프링 시큐리티 주요 아키텍처 이해