[중앙정보기술인재개발원] 111일차

테스트 코드 복습

[기본] API 계층 테스트

슬라이스 테스트란?

여러분들이 학습을 위해서 만들어보고 있는 샘플 애플리케이션은 여러 개의 계층으로 나누어져 있습니다.

단위 테스트의 경우 일반적으로 특정 모듈이나 계층, 기술에 의존적이지 않도록 작성하는 것이 좋습니다.

그런데 단위 테스트 만으로는 애플리케이션의 모든 기능이 정상적으로 동작한다라고 백 퍼센트 보장되지는 않습니다.

하나의 애플리케이션은 계층별로 역할이 있고, 계층별로 서로 연동되기 때문에 각각의 계층 별로 잘 동작하는지 테스트를 진행한 후에 마지막으로 통합 테스트를 통해서 계층 간의 연동에 문제가 없는지 확인해야 비로소 개발자의 테스트 작업이 마무리되는 것이라고 할 수 있습니다.

이처럼 개발자가 각 계층에 구현해 놓은 기능들이 잘 동작하는지 특정 계층만 잘라서(Slice) 테스트하는 것을 슬라이스 테스트(Slice Test)라고 합니다.

개발자가 통합 테스트까지 작성하면 정말 바람직하겠지만 현실에서는 일정 상의 이유 등으로 인해 통합 테스트는 QA 부서에서 진행하는 기능 테스트로 대체되는 경우가 많습니다.

그리고 통합 테스트는 아니지만 QA 부서에서 본격적으로 전체적인 기능 테스트를 진행하기 전에 애플리케이션의 특정 수정 사항으로 인해 영향을 받을 수 있는 범위에 한해서 제한된 테스트를 진행하기도 합니다. 테스트 세계에서는 이를 스모크 테스트(Smoke Test)라고 부릅니다.

스모크 테스트(Smoke Test)에 대해서 더 알아보고 싶다면 아래 [심화 학습]을 참고하세요.

 

API 계층 테스트

API 계층의 테스트 대상은 대부분 클라이언트의 요청을 받아들이는 핸들러인 Controller입니다.

Spring에서는 Controller를 테스트하기 위한 편리한 방법들을 제공합니다.

지금부터 Spring에서 지원하는 기능들을 이용해 우리가 작성한 Controller들을 테스트하는 방법을 알아보도록 하겠습니다.

 

Controller 테스트를 위한 테스트 클래스 구조

Spring Boot에서는 API 계층의 Controller를 테스트하기 위한 다양한 애너테이션을 제공하는데, 하나의 Controller 클래스를 테스트하기 위한 테스트 클래스의 기본 구조는 [코드 3-191]과 같습니다.

 

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.web.servlet.MockMvc;

@SpringBootTest       // (1)
@AutoConfigureMockMvc  // (2)
public class ControllerTestDefaultStructure {
		// (3)
    @Autowired
    private MockMvc mockMvc;

		// (4)
    @Test
    public void postMemberTest() {
        // given (5) 테스트용 request body 생성

        // when (6) MockMvc 객체로 테스트 대상 Controller 호출

        // then (7) Controller 핸들러 메서드에서 응답으로 수신한 HTTP Status 및 response body 검증
    }
}

[코드 3-191] Controller 테스트용 테스트 클래스 기본 구조

 

1. (1)의 @SpringBootTest 애너테이션은 Spring Boot 기반의 애플리케이션을 테스트하기 위한 Application Context를 생성합니다.
2. 여러분들이 잘 알다시피 Application Context에는 애플리케이션에 필요한 Bean 객체들이 등록되어 있습니다.
3. (2)의 @AutoConfigureMockMvc 애너테이션은 Controller 테스트를 위한 애플리케이션의 자동 구성 작업을 해줍니다.(3)의 MockMvc 같은 기능을 사용하기 위해서는 @AutoConfigureMockMvc 애너테이션을 반드시 추가해 주어야 합니다.
4. 여러분들이 Spring Boot의 자동 구성을 통해 애플리케이션의 설정을 손쉽게 사용하듯이 @AutoConfigureMockMvc 애너테이션을 추가함으로써 테스트에 필요한 애플리케이션의 구성이 자동으로 진행됩니다.
5. (3)에서 DI로 주입받은 MockMvc는 Tomcat 같은 서버를 실행하지 않고 Spring 기반 애플리케이션의 Controller를 테스트할 수 있는 완벽한 환경을 지원해 주는 일종의 Spring MVC 테스트 프레임워크입니다.
6. MockMvc 객체를 통해 우리가 작성한 Controller를 호출해서 손쉽게 Controller에 대한 테스트를 진행할 수 있습니다.
7. (1), (2), (3)을 통해 Controller를 테스트할 준비가 되었습니다.
8. 이제 (4)와 같이 테스트하고자 하는 Controller 핸들러 메서드의 테스트 케이스를 작성하면 됩니다.
9. 여러분들이 Postman을 사용해서 Controller에 요청을 하기 위해서는 reqeust body 데이터가 필요합니다. Controller를 테스트하기 위해서는 (5)의 단계에서 테스트용 request body를 직접 만들어 주어야 합니다. Given-When-Then 패턴에서 Given에 해당됩니다.
10. (6)에서는 MockMvc 객체를 통해 요청 URI와 HTTP 메서드등을 지정하고, (5)에서 만든 테스트용 request body를 추가한 뒤에 request를 수행합니다. Given-When-Then 패턴에서 When에 해당됩니다.
11. (7)에서는 Controller에서 전달받은 HTTP Status와 response body 데이터를 통해 검증 작업을 진행합니다. Given-When-Then 패턴에서 Then에 해당됩니다.

MemberController 테스트

Controller의 테스트 진행 방법을 단계적으로 살펴보았으니 이제 실제로 우리가 작성한 MemberController에 대한 테스트 케이스를 작성해 보도록 하겠습니다.

 

HTTP Post request에 대한 테스트

package com.springboot.slice.controller.member;

import com.springboot.member.dto.MemberDto;
import com.google.gson.Gson;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.ResultActions;
import org.springframework.transaction.annotation.Transactional;

import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.startsWith;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@SpringBootTest
@AutoConfigureMockMvc
class MemberControllerTest {
    @Autowired
    private MockMvc mockMvc;

    @Autowired
    private Gson gson;

    @Test
    void postMemberTest() throws Exception {
        // given  (1)
        MemberDto.Post post = new MemberDto.Post("hgd@gmail.com",
                                                        "홍길동",
                                                    "010-1234-5678");
        String content = gson.toJson(post); // (2)

        // when
        ResultActions actions =
                mockMvc.perform(                        // (3)
	                                post("/v11/members")  // (4)
                                        .accept(MediaType.APPLICATION_JSON) // (5)
                                        .contentType(MediaType.APPLICATION_JSON) // (6)
                                        .content(content)   // (7)
                                );

        // then
        actions
                .andExpect(status().isCreated()) // (8)
                .andExpect(header().string("Location", is(startsWith("/v11/members/"))));  // (9)
    }
}

[코드 3-192] MemberController의 postMember() 테스트

 

코드 3-192는 MemberController의 postMember() 핸들러 메서드를 테스트하는 테스트 케이스입니다.

Controller를 테스트하는 기본 구조에 우리가 테스트하고자하는 로직들을 포함을 시켰습니다.

복잡해 보이지만 Given-When-Then 구조로 나누었기 때문에 단계적으로 접근하면 테스트 케이스를 조금 더 수월하게 작성할 수 있습니다. 코드 3-192의 설명은 아래와 같습니다.

1. Given
   1. (1)의 코드는 Given에 해당되며 여러분들이 Postman을 사용할 때 request body에 포함시키는 요청 데이터와 동일한 역할을 합니다.
   2. Postman에서 등록할 회원 정보를 JSON 포맷으로 request body에 포함시키는 것 기억나시나요? (2)에서 Gson이라는 JSON 변환 라이브러리를 이용해서 (1)에서 생성한 MemberDto.Post 객체를 JSON 포맷으로 변환해줍니다.
   Gson 라이브러리를 사용하기 위해서는 build.gradle의 dependencies {...}에 implementation 'com.google.code.gson:gson'를 추가해 주어야 합니다.
2. When
   1. MockMvc로 테스트 대상 Controller의 핸들러 메서드에 요청을 전송하기 위해서는 기본적으로 (3)과 같이 perform() 메서드를 호출해야 하며 perform() 메서드 내부에 Controller 호출을 위한 세부적인 정보들이 포함됩니다.
   2. (4) - (7) 까지는 HTTP request에 대한 정보이며, MockMvcRequestBuilders 클래스를 이용해서 빌더 패턴을 통해 request 정보를 채워 넣을 수 있습니다.
      1. (4)에서 post() 메서드를 통해 HTTP POST METHOD와 request URL을 설정합니다.
      2. (5)에서 accept() 메서드를 통해 클라이언트 쪽에서 리턴 받을 응답 데이터 타입으로 JSON 타입을 설정합니다.
      3. (6)에서 contentType() 메서드를 통해 서버 쪽에서 처리 가능한 Content Type으로 JSON 타입을 설정합니다.
      4. (7)에서 content() 메서드를 통해 request body 데이터를 설정합니다.
      5. request body에 전달하는 데이터는 (2)에서 Gson 라이브러리를 이용해 변환된 JSON 문자열입니다.

Spring에서는 post()와 같이 HTTP METHOD에 해당하는 request를 수행하는 다양한 메서드를 지원합니다.

request를 수행하는 메서드를 더 알아보고 싶다면 아래 \[심화 학습]을 참고하세요.

1. Then
   1. MockMvc의 perform() 메서드는 ResultActions 타입의 객체를 리턴하는데, 이 ResultActions 객체를 이용해서 우리가 전송한 request에 대한 검증을 수행할 수 있습니다.
   2. (8)에서 andExpect() 메서드를 통해 파라미터로 입력한 매처(Matcher)로 예상되는 기대 결과를 검증할 수 있습니다.
   3. (8)에서는 status().isCreated()를 통해 response status가 201(Created)인지 매치시키고 있습니다. 즉, 백엔드 측에 리소스인 회원 정보가 잘 생성(저장)되었는지를 검증합니다.
   4. (9)에서 header().string("Location", is(startsWith("/v11/members/")))을 통해 HTTP header에 추가된 Location의 문자열 값이 “/v11/members/”로 시작하는지 검증합니다.
   5. Location header가 예상하는 값과 일치한다라는 것은 백엔드 측에 리소스(회원 정보)가 잘 생성되었다는 것을 의미합니다.

이제 MemberController의 postMember()에 대한 기본적인 테스트가 이루어졌습니다.

postMember()의 경우, 클라이언트에게 되돌려주는 response body는 없기 때문에 코드 3-192와 같이 단순히 기대하는 response status와 Location header의 값만 테스트하면 됩니다.

MemberController에 대한 테스트 케이스를 하나만 더 작성해 보도록 합시다.

이번에는 getMember() 핸들러 메서드를 테스트해 보겠습니다. getMember()의 경우, 특정 회원 정보 조회를 위한 request가 MemberController 쪽에 잘 전송되는지 그리고 request를 전달받은 getMember()가 request에 해당하는 회원 정보를 response로 잘 전달하는지를 확인하면 됩니다.

getMember()가 특정 회원 정보를 response로 잘 전달하는지를 테스트하려면 어떻게 해야 할까요?

이 경우에는 회원 정보 한 건을 먼저 백엔드 서버 측에 저장한 후, 방금 백엔드 서버 측에 저장한 리소스를 서버 측에 조회해서 조회가 잘 되는지 확인해 보면 될 것입니다.

 

package com.springboot.slice.controller.member;

import com.springboot.member.dto.MemberDto;
import com.google.gson.Gson;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.ResultActions;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.web.util.UriComponentsBuilder;

import java.net.URI;

import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.startsWith;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;

@Transactional
@SpringBootTest
@AutoConfigureMockMvc
class MemberControllerTest {
    @Autowired
    private MockMvc mockMvc;

    @Autowired
    private Gson gson;

    ...
    ...

    @Test
    void getMemberTest() throws Exception {
        // =================================== (1) postMember()를 이용한 테스트 데이터 생성 시작
        // given
        MemberDto.Post post = new MemberDto.Post("hgd@gmail.com","홍길동","010-1111-1111");
        String postContent = gson.toJson(post);

        ResultActions postActions =
                mockMvc.perform(
                        post("/v11/members")
                                .accept(MediaType.APPLICATION_JSON)
                                .contentType(MediaType.APPLICATION_JSON)
                                .content(postContent)
                );
        // =================================== (1) postMember()를 이용한 테스트 데이터 생성 끝

        // (2)
        String location = postActions.andReturn().getResponse().getHeader("Location"); // "/v11/members/1"

        // when / then
        mockMvc.perform(
                        get(location)      // (3)
                                .accept(MediaType.APPLICATION_JSON)
                )
                .andExpect(status().isOk())    // (4)
                .andExpect(jsonPath("$.data.email").value(post.getEmail()))   // (5)
                .andExpect(jsonPath("$.data.name").value(post.getName()))     // (6)
                .andExpect(jsonPath("$.data.phone").value(post.getPhone()));  // (7)
    }
}

[코드 3-193] MemberController의 getMember() 테스트

 

코드 3-193은 MemberController의 getMember() 핸들러 메서드를 테스트하는 테스트 케이스입니다. 코드 3-193의 테스트케이스 역시 Given-When-Then 구조로 나누어 생각해 볼 수 있습니다.

코드 3-192의 설명은 아래와 같습니다.

1. Given
   1. (1)의 코드 영역은 우리가 코드 3-192에서 postMember()를 테스트할 때의 코드와 동일한 코드입니다. (1)을 통해서 테스트 데이터를 백엔드 서버 측의 데이터베이스에 먼저 저장합니다.
   2. (2)에서는 postMember()의 response에 전달되는 Location header 값을 가져오는 로직입니다. (2)와 같이 postActions.andReturn().getResponse().getHeader("Location")로 접근해서 Location header의 값을 얻어올 수 있습니다.
2. When
   1. (3)에서는 (2)에서 얻은 Location header의 값을 get(location)으로 전달합니다. Location header에서 얻게 되는 값이 (1)에서 등록한 resource(회원 정보)의 위치(”/v11/members/1”)를 의미하기 때문에 get(…)의 URI로 전달하면 됩니다.
3. Then
   1. (4)에서는 기대하는 HTTP status가 200 OK인지를 검증합니다.
   2. (5)에서 (7) 까지는 getMember() 핸들러 메서드에서 리턴하는 response body(JSON 형식)의 각 프로퍼티(email, name, phone)의 값을 검증하는 기능을 추가했습니다.
   3. (5)에서는 jsonPath() 메서드를 통해 response body(JSON 형식)의 각 프로퍼티 중에서 응답으로 전달받는 email 값이 request body로 전송한 email과 일치하는지 검증하고 있습니다.
   4. (6)에서는 jsonPath() 메서드를 통해 response body(JSON 형식)의 각 프로퍼티 중에서 응답으로 전달받는 name 값이 request body로 전송한 name과 일치하는지 검증하고 있습니다.
   5. (7)에서는 jsonPath() 메서드를 통해 response body(JSON 형식)의 각 프로퍼티 중에서 응답으로 전달받는 phone 값이 request body로 전송한 phone과 일치하는지 검증하고 있습니다.

MockMvcResultMatchers 클래스에서 지원하는 jsonPath()를 사용하면 JSON 형식의 개별 프로퍼티에 손쉽게 접근할 수 있다는 사실을 기억해 주세요!

MockMvcResultMatchers와 jsonPath()에 대해서 더 알아보고 싶다면 아래 [심화 학습]을 참고하세요.

지금까지 @SpringBootTest, @AutoConfigureMockMvc 애너테이션을 사용해서 Controller 테스트를 손쉽게 진행하는 방법을 살펴보았습니다.

 

✅ response body 응답 데이터에 포함된 한글이 깨질 경우

만약 코드 3-193의 getMemberTest() 메서드 맨 아래쪽에 System.out.println(actions.andReturn().getResponse().getContentAsString());와 같은 코드를 추가해서 response body를 출력할 때, JSON 데이터에서 한글이 깨져 보일 경우, application.yml 파일에 아래의 설정을 추가합니다.

...
...

server:
  servlet:
    encoding:
      force-response: true

 

✅

그런데 이번 챕터에서 학습한 Controller 테스트 방법에서 문제점을 한 가지 발견할 수 있습니다.

이번 챕터에서 학습한 방법대로 테스트할 경우, Controller만 테스트하는 것이 아니라 애플리케이션의 전체 로직을 모두 실행하게 됩니다.

즉, 우리가 테스트에 집중해야 되는 계층은 API 계층인데 서비스 계층이나 데이터 액세스 계층까지 불필요한 로직이 수행된다는 것입니다.

따라서 이번 챕터에서 학습한 방법만으로는 완전한 슬라이스 테스트라고 보기에는 힘듭니다.

이 문제는 Mock(가짜) 객체를 사용해 계층 간의 연결을 끊어줌으로써 해결이 가능합니다.

Mock 객체에 대한 내용은 Mockito 챕터에서 학습할 예정이므로 조금만 기다려주세요!

@WebMvcTest를 이용한 Controller 테스트

Spring에서는 Controller를 테스트하기 위한 전통적인 방법으로 @WebMvcTest 애너테이션을 사용할 수 있습니다.

하지만 @WebMvcTest 애너테이션을 사용할 경우, Controller에서 의존하는 컴포넌트들을 모두 일일이 설정해 주어야 하는 불편함이 있습니다.

예를 들어 MemberController에서 사용되는 MemberService Bean, MemberMapper Bean 객체 등을 테스트 클래스에서 사용할 수 있도록 설정해 주어야 합니다.

또한 때에 따라서 데이터액세스 계층에서 의존하는 설정이나 의존 객체들도 모두 설정해 주어야 할 수도 있습니다.

이런 이유로 이번 챕터에서는 @SpringBootTest, @AutoConfigureMockMvc를 이용해서 Controller 테스트를 위한 구성의 복잡함을 해결하고 있다는 사실을 기억해 주세요.

@WebMvcTest와 @SpringBootTest는 각각 장단점이 존재하며, 상황에 맞게 적절하게 사용할 수 있습니다.

@WebMvcTest는 API 문서화 유닛에서 사용해 보도록 하겠습니다