[Spring, React] 테스트 코드를 작성하고 실패가 뜨는 원인을 찾아 수정해보자.

 

 

컨트롤러가 에러를 제대로 처리하는지
알아보기 위해 테스트 코드를 작성했다.
그런데 자꾸만 테스트를 실패한다.
왜그런지 분석하고 고쳐보자!

 

 

 

 

 

https://lotto-magic-frontend.vercel.app/

로또 번호 생성 마법진

 

 

 

 

 

 

 

1. 오류 분석

• LottoControllerErrorTest.java
  에러를 제대로 처리하는지 보는 테스트 클래스

@WebMvcTest(LottoController.class)
@Import(GlobalExceptionHandler.class)
class LottoControllerErrorTest {

    @Autowired
    private MockMvc mockMvc;

    @Autowired
    private ObjectMapper objectMapper;

    @MockitoBean
    private LottoService lottoService;

    @Test
    @DisplayName("선택 요소가 3개가 아니면 400 에러 응답을 반환한다")
    void drawReturnsBadRequestWhenSelectedOptionsAreNotThree() throws Exception {
        // given
        LottoRequest request = new LottoRequest(
                List.of("행운", "조상님의도움")
        );

        when(lottoService.draw(any(LottoRequest.class)))
                .thenThrow(new IllegalArgumentException("3개의 요소를 선택해주세요."));

        // when & then
        mockMvc.perform(
                        post("/api/lotto/draw")
                                .contentType(MediaType.APPLICATION_JSON)
                                .content(objectMapper.writeValueAsString(request))
                )
                .andExpect(status().isBadRequest())
                .andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
                .andExpect(jsonPath("$.status").value(400))
                .andExpect(jsonPath("$.error").value("Bad Request"))
                .andExpect(jsonPath("$.message").value("3개의 요소를 선택해주세요."))
                .andExpect(jsonPath("$.path").value("/api/lotto/draw"));

        verifyNoInteractions(lottoService);
    }

 }

사용자가 선택 요소를 3개 선택하지 않고 2개 선택한 경우 어떻게 에러를 처리할지 가정한 테스트 코드이다. thenThrow(new IllegalArgumentException("요소는 정확히 3개 선택해야 합니다.")); 코드를 보면, 정상적으로 Mocking이 작동되었을 경우 400 에러가 나야한다.

 

 

• GlobalExceptionHandler.java
  전반적인 에러를 처리하는 핸들러 클래스 코드 중 일부분

@RestControllerAdvice
public class GlobalExceptionHandler {


    @ExceptionHandler(IllegalArgumentException.class)
    public ResponseEntity<ErrorResponse> handleIllegalArgumentException(
            IllegalArgumentException exception,
            HttpServletRequest request
    ) {
        ErrorResponse response = new ErrorResponse(
                400,
                "Bad Request",
                exception.getMessage(),
                request.getRequestURI()
        );

        return ResponseEntity
                .status(HttpStatus.BAD_REQUEST)
                .body(response);
    }


    @ExceptionHandler(HttpMessageNotReadableException.class)
    public ResponseEntity<ErrorResponse> handleHttpMessageNotReadableException(
            HttpMessageNotReadableException exception,
            HttpServletRequest request
    ) {
        ErrorResponse response = new ErrorResponse(
                400,
                "Bad Request",
                "요청 JSON 형식이 올바르지 않습니다.",
                request.getRequestURI()
        );

        return ResponseEntity
                .status(HttpStatus.BAD_REQUEST)
                .body(response);
    }



    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleException(
            Exception exception,
            HttpServletRequest request
    ) {
        ErrorResponse response = new ErrorResponse(
                500,
                "Internal Server Error",
                "서버 내부 오류가 발생했습니다.",
                request.getRequestURI()
        );

        return ResponseEntity
                .status(HttpStatus.INTERNAL_SERVER_ERROR)
                .body(response);
    }


    public record ErrorResponse(
            int status,
            String error,
            String message,
            String path
    ) {

    }

}

@RestControllerAdvice는 컨트롤러 계층에서 발생하는 예외를 한 곳에서 캐치하여 처리하는 역할을 한다. 예외 처리 로직으로 IllegalArgumentException, HttpMessageNotReadableException, Exception 3가지 유형으로 코드를 작성했다.

IllegalArgumentException은 메서드에 부적절한 파라미터가 전달되었을 때 발생한다. HttpMessageNotReadableException는 클라이언트가 보낸 HTTP 요청 본문(JSON)의 형식이 잘못되었거나 파싱할 수 없을 때 발생한다. Exception은 위에서 잡히지 않은 모든 런타임/체크 예외를 처리하는 Catch-all이다. 주로 NullPointerException이나 DB 접속 불량 등 서버 측 오류이다.

아까 테스트 코드에서 thenThrow에 new IllegalArgumentException을 설정했다. 그래서 400 에러를 반환하고 테스트는 성공되었어야 한다.

 

 

• 테스트 실패

Handler:
Type = com.lottomagic.lotto.controller.LottoController
Method = com.lottomagic.lotto.controller.LottoController#draw(LottoRequest)


Resolved Exception:
Type = org.springframework.web.bind.MethodArgumentNotValidException


MockHttpServletResponse:
Status = 500
Error message = null
Headers = [Content-Type:"application/json"]
Content type = application/json
Body = {"status":500,"error":"Internal Server Error","message":"서버 내부 오류가 발생했습니다.","path":"/api/lotto/draw"}
Forwarded URL = null
Redirected URL = null
Cookies = []


Status
Expected :400
Actual :500

하지만 오류가 발생했다. 400 에러를 발생할거란 예상과 달리, 500 에러를 반환한 것이다. 왜 테스트는 500 에러를 반환할걸까?

Resolved Exception:
             Type = org.springframework.web.bind.MethodArgumentNotValidException

테스트 코드에서는 lottoService.draw( )가 호출될 때 IllegalArgumentException이 발생하도록 Mock을 설정했었다. 하지만 실제로는 서비스 계층에 도달하기도 전에 컨트롤러의 @Vaild(유효성 검사)에서 실패하여 MethodArgumentNotValidException이 터져버린 것이다. 

그러면 LottoRequest와 LottoController를 살펴보자.

// LottoRequest.java 
    @Size(min = 3, max = 3, message = "3개의 요소를 선택해주세요.")
    List<@NotBlank(message = "요소를 선택해주세요.") String> selectedOptions

// GlobalExceptionHandler.java
@PostMapping("/draw")
public ResponseEntity<LottoResponse> draw(@Valid @RequestBody LottoRequest request) {
    LottoResponse response = lottoService.draw(request);
    return ResponseEntity.ok(response);
}

LottoRequest 코드에 리스트 요소 개수를 3개로 제한하는 어노테이션(@Size(min=3, max=3)이 있고 LottoController 코드를 보니 @Valid가 붙어 있다. @Valid는 요청값이 서비스까지 가기 전에 컨트롤러 입구에서 먼저 검사하게 된다. 그래서 LottoService의 validateSelectedOptions( )까지 가지 못하고 Spring이 먼저 MethodArgumentNotValidException을 터뜨린 것이다.

그런데 GlobalExceptionHandler 클래스에는 MethodArgumentNotValidException이 없어서 이 예외를 400 에러로 처리할 수가 없었다. 그래서 @ExceptionHandler(Excetion.class)가 예외를 잡으면서 500 응답이 나타난 것이다.

수정 방법은 간단하다. MethodArgumentNotValidException에 처리 코드를 추가하는 것이다.

 

 

 

---

 

 

 

 

2. 해결

    // @Valid 검증 실패 처리
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<ErrorResponse> handleMethodArgumentNotValidException(
            MethodArgumentNotValidException exception,
            HttpServletRequest request
    ) {
        String message = exception.getBindingResult()
                .getFieldErrors()
                .stream()
                .findFirst()
                .map(fieldError -> fieldError.getDefaultMessage())
                .orElse("요청 값이 올바르지 않습니다.");

        log.warn("MethodArgumentNotValidException occurred at {}: {}",
                request.getRequestURI(),
                message
        );

        ErrorResponse response = new ErrorResponse(
                HttpStatus.BAD_REQUEST.value(),
                HttpStatus.BAD_REQUEST.getReasonPhrase(),
                message,
                request.getRequestURI(),
                LocalDateTime.now()
        );

        return ResponseEntity
                .status(HttpStatus.BAD_REQUEST)
                .body(response);
    }

예외를 처리할 메서드가 없어서 발생한 것이니 만들어주면 간단하게 해결된다. 그리고 DTO 메시지를 테스트 기대값에 맞추는 것도 중요하다. 테스트 코드를 프로젝트에서 작성해본 것이 처음이라, 이런것도 몰랐다. "3개의 요소를 선택해주세요."라는 문구를 맞춰야하는 것도 기억하자.