Spring Boot + MockMvc 테스트(feat. Kotlin)

📎  Spring Boot + MockMvc 테스트

안녕하세요, 이번 시간에 정리할 내용은 스프링 부트와 MockMvc를 통한 GET, POST 등의 API를 테스트하는 법에 대해 정리해보도록 하겠습니다. 전체 코드는 깃허브에서 확인하실 수 있습니다 :)

※ 포스팅에 틀린 내용이 존재하면 지적 부탁드리겠습니다!

 

 

 

★ MockMvc란?

---

MockMvc는 Spring MVC의 테스트 프레임워크로, 가짜 객체를 만들어 어플리케이션을 서버에 배포하지 않고도 Spring MVC의 동작을 재현할 수 있는 클래스입니다.

이를 통해 가짜의 HTTP 요청을 컨트롤러에 보내고 서버 내에서 컨트롤러를 실행하지 않고 컨트롤러의 동작을 테스트할 수 있습니다.

MockMvc를 사용함으로서 실제 서버 환경과 동일한 @SpringBootTest 어노테이션이 아닌 @WebMvcTest 어노테이션을 통해 순수 Controller 레이어의 로직을 테스트 할 수 있습니다.

 

 

 

★ MockMvc 사용 예시 - 의존성 추가 & 객체 코드 작성

---

예제 코드는 Kotlin 기반으로 작성을 하였습니다.

1) 먼저 의존성을 추가합니다.

// gradle
testImplementation("org.springframework.boot:spring-boot-starter-test")

// maven
<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-test -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <version>2.5.4</version>
    <scope>test</scope>
</dependency>

 

 

 

2) 테스트에 사용될 ErrorResponse, UserRequest 클래스의 코드는 다음과 같습니다.

package org.juhyun.kotlinspringboot.model.exception

import com.fasterxml.jackson.annotation.JsonProperty
import java.time.LocalDateTime


/* ErrorResponse API
{
    "result_code": "FAIL",
    "http_status": "400",
    "http_method": "GET",
    "message": "요청에 에러가 발생하였습니다.",
    "path": "/api/exception",
    "timestamp": "2021-09-06T16:03:43.556134",
    "errors":[
        {
        "field": "name",
        "message": "크기가 2에서 6 사이여야 합니다",
        "value": "LeeJuHyun"
        }
    ]
}
*/
data class ErrorResponse(

        @field: JsonProperty("result_code")
        var resultCode: String? = null,

        @field: JsonProperty("http_status")
        var httpStatus: String? = null,

        @field: JsonProperty("http_method")
        var httpMethod: String? = null,
        var message: String? = null,
        var path: String? = null,
        var timestamp: LocalDateTime? = null,
        var errors: MutableList<Error>? = mutableListOf()
)

data class Error(
        var field: String? = null,
        var message: String? = null,
        var value: Any? = null
)


package org.juhyun.kotlinspringboot.model

import org.juhyun.kotlinspringboot.annotation.StringFormatDateTime
import java.lang.Exception
import java.time.LocalDateTime
import java.time.format.DateTimeFormatter
import javax.validation.constraints.*
import kotlin.math.min

data class UserRequest(

        @field: NotEmpty
        @field: Size(min = 2, max = 10)
        var name: String? = null,

        @field: PositiveOrZero // 0보다 큰 양수
        var age: Int? = null,

        @field: Email
        var email: String? = null,

        @field: NotBlank
        var address: String? = null,

        @field: Pattern(regexp = "\\d{3}-\\d{3,4}-\\d{4}\$")
        var phoneNumber: String? = null,

        @field:StringFormatDateTime(pattern = "yyyy-MM-dd HH:mm:ss", message = "패턴이 올바르지 않습니다.")
        var createdAt: String? = null // yyyy-MM-dd HH:mm:ss
)

ErrorResponse 클래스에는 스네이크 케이스로 응답하기 위해 @JsonProperty 어노테이션을 적용해 주었습니다.

UserRequest 클래스에는 각 필드에대한 유효성 검증 코드를 추가해 주었습니다.

 

 

 

★ MockMvc 사용 예시 - HTTP GET 테스트

---

3) HTTP GET 테스트

HTTP GET API 테스트를 위해 Controller 및 Test를 작성하겠습니다.

@RestController
@RequestMapping("/api/exception")
@Validated
class ExceptionApiController {

    @GetMapping("/hello")
    fun hello(): String {
        val list = mutableListOf<String?>()
        return "Hello"
    }

    @GetMapping
    fun get(
            @NotBlank @Size(min = 2, max = 6) @RequestParam name: String,
            @Min(10) @RequestParam age: Int): String {
        println(name)
        println(age)
        return "$name $age"
    }
    
    ...
    
}

 

• hello() 메소드: 단순 문자열("Hello") 리턴
• get() 메소드: name, age 파라미터를 받으며 유효성 검증 

 

 

@WebMvcTest
@AutoConfigureMockMvc
class ExceptionApiControllerTest {

    @Autowired
    private lateinit var mockMvc: MockMvc

    @Test
    fun helloTest() {
        val uri: String = "/api/exception/hello"
        mockMvc.perform(MockMvcRequestBuilders.get(uri))
                .andExpect(MockMvcResultMatchers.status().isOk)
                .andExpect(MockMvcResultMatchers.content().string("Hello"))
                .andDo(MockMvcResultHandlers.print())
    }

    @Test
    fun getTest() {
        val uri = "/api/exception"
        val queryParams = LinkedMultiValueMap<String, String>()
        queryParams.add("name", "JuHyun")
        queryParams.add("age", "20")

        mockMvc.perform(MockMvcRequestBuilders.get(uri).queryParams(queryParams))
                .andExpect(MockMvcResultMatchers.status().isOk)
                .andExpect(MockMvcResultMatchers.content().string("JuHyun 20"))
                .andDo(MockMvcResultHandlers.print())
    }

    @Test
    fun 이름은_2글자에서_6글자_사이여야한다() {
        val uri = "/api/exception"
        val queryParams = LinkedMultiValueMap<String, String>()
        queryParams.add("name", "JuHyunJuHyun")
        queryParams.add("age", "11")

        mockMvc.perform(MockMvcRequestBuilders.get(uri).queryParams(queryParams))
                .andExpect(MockMvcResultMatchers.status().isBadRequest)
                .andExpect(MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON))
                .andDo(MockMvcResultHandlers.print())
    }

    @Test
    fun 나이는_10보다_커야한다() {
        var uri = "/api/exception"
        val queryParams = LinkedMultiValueMap<String, String>()
        queryParams.add("name", "JuHyun")
        queryParams.add("age", "9")

        mockMvc.perform(MockMvcRequestBuilders.get(uri).queryParams(queryParams))
                .andExpect(MockMvcResultMatchers.status().isBadRequest)
                .andExpect(MockMvcResultMatchers.jsonPath("\$.result_code").value("FAIL"))
                .andExpect(MockMvcResultMatchers.jsonPath("\$.errors[0].field").value("age"))
                .andExpect(MockMvcResultMatchers.jsonPath("\$.errors[0].value").value("9"))
                .andDo(MockMvcResultHandlers.print())
    }

 

perform()

• mock 객체의 요청을 전송하는 역할을 하며 결과로 ResultActions 인터페이스를 받습니다.
• ResultActions 인터페이스는 리턴 값을 검증하고 확인할 수 있는 andExpect(), 수행하는 andDo(), 결과를 리턴하는 andReturn() 메소드를 제공합니다.
• 파라미터는 RequestBuilder 인터페이스를 받으며 이를 위해 정적 팩토리 메소드인 MockMvcRequestBuilders 추상 클래스가 존재합니다.

RequestBuilders를 상속 & 구현하고 있는 인터페이스, 클래스는 다음과 같습니다.

• SmartRequestBuilder
• ConfigurableSmartRequestBuilder
• MockHttpServletRequestBuilder
• ...

정적 팩토리 메소드를 가지고 있는 MockMvcRequestBuilders 클래스의 메소드는 MockHttpServletRequestBuilder 클래스를 

리턴하고 있기 때문에 다음과 같이 perform() 메소드의 파라미터로 MockMvcRequestBuilders 클래스를 사용할 수 있습니다.

 

andExpect()

• perform() 요청에 대한 결과를 검증합니다.
• 파라미터는 ResultMatcher 인터페이스를 받으며 이를 위해 정적 팩토리 메소드인 MockMvcResultMatchers 추상 클래스가 존재합니다.

andDo()

• 결과에 대해 특정 작업을 수행합니다.
• 파라미터는 ResultHandler 인터페이스를 받으며 이를 위해 정적 팩토리 메소드인 MockMvcResultHandlers 추상 클래스가 존재합니다.

get()

• 경로에 해당하는 String 혹은 URI를 파라미터로 받습니다.

queryParams()

• 쿼리 파라미터가 필요한 요청의 경우 해당 메소드를 사용하며 MultiValueMap<>을 파라미터로 받습니다.
• 비슷한 메소드로 param(), params(), queryParam() 등의 메소드가 있습니다.

jsonPath()

• Response Body의 데이터를 검증할 수 있는 메소드 입니다.

위 사진은 이름은_2글자에서_6글자_사이여야한다() 메소드의 테스트 결과 입니다.

 

 

 

★ MockMvc 사용 예시 - HTTP POST 테스트

---

4) HTTP-POST 테스트

HTTP POST API를 테스트해보겠습니다.

@RestController
@RequestMapping("/api/exception")
@Validated
class ExceptionApiController {

    ...

    @PostMapping
    fun post(@Valid @RequestBody userRequest: UserRequest): UserRequest {
        println(userRequest)
        return userRequest
    }

    @ExceptionHandler(ConstraintViolationException::class)
    fun constraintViolationException(e: ConstraintViolationException, request: HttpServletRequest): ResponseEntity<ErrorResponse>? {
        // 1. 에러 분석
        val errors = mutableListOf<Error>()
        e.constraintViolations.forEach {
            val error = Error().apply {
                this.field = it.propertyPath.last().name
                this.message = it.message
                this.value = it.invalidValue
            }
            errors.add(error)
        }

        // 2. ErrorResponse
        val errorResponse = getErrorResponse(request, errors)

        // ResponseEntity
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errorResponse)
    }

    private fun getErrorResponse(request: HttpServletRequest, errors: MutableList<Error>): ErrorResponse {
        return ErrorResponse().apply {
            this.resultCode = "FAIL"
            this.httpStatus = HttpStatus.BAD_REQUEST.value().toString()
            this.httpMethod = request.method
            this.message = "요청에 에러가 발생하였습니다."
            this.path = request.requestURI.toString()
            this.timestamp = LocalDateTime.now()
            this.errors = errors
        }
    }

Controller에서 post 메소드는 UserRequest 객체만 파라미터로 받아 출력한 후 리턴하는 메소드입니다.

 

 

@WebMvcTest // 글로벌 예외 처리는 포함 X
@AutoConfigureMockMvc
class ExceptionApiControllerTest {

    @Test
    fun postTest() {
        val userRequest = UserRequest().apply{
            this.name = "JuHyun"
            this.age = 20
            this.phoneNumber = "010-1111-2222"
            this.address = "서울"
            this.email = "a@a.com"
            this.createdAt = "2021-09-06 21:11:12"
        }

        // JSON 형식의 문자열로 변환
        val json = jacksonObjectMapper().writeValueAsString(userRequest)
        println(json)

        val uri = "/api/exception"

        mockMvc.perform(
                MockMvcRequestBuilders.post(uri)
                        .content(json)
                        .contentType(MediaType.APPLICATION_JSON)
                        .accept(MediaType.APPLICATION_JSON))
                .andExpect(MockMvcResultMatchers.status().isOk)
                .andExpect(MockMvcResultMatchers.jsonPath("\$.name").value("JuHyun"))
                .andExpect(MockMvcResultMatchers.jsonPath("\$.age").value("20"))
                .andExpect(MockMvcResultMatchers.jsonPath("\$.address").value("서울"))
                .andDo(MockMvcResultHandlers.print())
    }

val json = jacksonObjectMapper().writeValueAsString(userRequest)

• 위 메소드는 문자열을 JSON 형식으로 변환해주는 메소드입니다.
• println(json) 의 결과는 다음과 같습니다.

 

content()

• Request Body에 문자열을 설정합니다.

 

postTest() 메소드에 대한 결과입니다.

 

위 예제에서는 작성하지 않았지만 MockMvcRequestBuilders, MockMVcResultMatchers 클래스의 모든 메소드들은 전부 정적 메소드이기 때문에 다음과 같이 클래스를 생략할 수 있습니다.

@WebMvcTest // 글로벌 예외 처리는 포함 X
@AutoConfigureMockMvc
class ExceptionApiControllerTest {

    @Test
    fun postTest() {
        val userRequest = UserRequest().apply{
            this.name = "JuHyun"
            this.age = 20
            this.phoneNumber = "010-1111-2222"
            this.address = "서울"
            this.email = "a@a.com"
            this.createdAt = "2021-09-06 21:11:12"
        }

        // JSON 형식의 문자열로 변환
        val json = jacksonObjectMapper().writeValueAsString(userRequest)
        println(json)

        val uri = "/api/exception"

        mockMvc.perform(
                post(uri)
                        .content(json)
                        .contentType(MediaType.APPLICATION_JSON)
                        .accept(MediaType.APPLICATION_JSON))
                .andExpect(status().isOk)
                .andExpect(jsonPath("\$.name").value("JuHyun"))
                .andExpect(jsonPath("\$.age").value("20"))
                .andExpect(jsonPath("\$.address").value("서울"))
                .andDo(print())
    }

 

 

 

 

★ 정리

이상으로 Spring Boot에서 MockMvc를 사용하는 방법에 대해 간략히 정리를 해보았습니다.

예제에서는 작성하지 않은 PUT, DELETE 메소드도 위와 비슷한 방식으로 테스트를 할 수 있습니다.

또한 포스팅에서는 사용하지 않은 메소드도 많이 존재하기 때문에 추가적인 내용은 아래 공식문서 링크를 참고해주세요

• MockMvcRequestBuilders
• MockMvcResultMatchers

 

 

★ References

• https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/test/web/servlet/MockMvc.html
• https://shinsunyoung.tistory.com/52
• https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81%EB%B6%80%ED%8A%B8-%EC%BD%94%ED%8B%80%EB%A6%B0/dashboard
• https://ktko.tistory.com/entry/%EC%8A%A4%ED%94%84%EB%A7%81Spring-MockMvc-%ED%85%8C%EC%8A%A4%ED%8A%B8