[Spring] MockWebServer

Mock이란?

• 실제 객체를 만들어 사용하기에 시간, 비용 등의 Cost가 높거나 혹은 객체 서로간의 의존성이 강해 구현하기 힘들 경우 가짜 객체를 만들어 사용하는 방법이다.
• 한번에 하나의 메서드를 실행하는 단위 테스트가 다른 네트워크, 데이터베이스 등등 제어하기 어려운 것들에 의존할때 가짜 객체를 만들어 테스트한다.

 

Mock 객체는 언제 필요한가?

• 테스트 작성을 위한 환경 구축이 어려운 경우
• 테스트가 특정 경우나 순간에 의존적인 경우
• 테스트 시간이 오래 걸리는 경우
• 개인 PC의 성능이나 서버의 성능문제로 오래 걸릴수 있는 경우 시간을 단축하기 위해 사용한다.

 

MockWebServer

• MockWebServer는 HTTTP Request를 받아서 Response를 반환하는 간단하고 작은 가짜 웹서버이다. 
• 우리가 작성하는 메서드 중에 WebClient, RestTemplete 등과 같은 Client를 사용하여, Http를 호출하는 메서드의 테스트 코드를 작성할때 이 MockWebServer를 호출하게 함으로써 쉽게 테스트 코드를 작성할 수 있다. 
• 실제로 Spring Team도 MockWebServer를 사용하여 테스트하라고 권장한다고 한다.

 

 

외부 API를 테스트 하는 이유

• 외부 api는 api 서버의 상태에 따라 성공하기도 하고 실패하기도 한다. 또한 해당 서버의 반환 값의 구조가 바뀌면 기존에 짜놓은 로직과 테스트 코드가 무용지물이다.
• 외부 API가 정상이고, 외부 API가 잘 작동한다는 가정하에 로직을 단위테스트 하기 위함이다.

 

설정

 

build.gradle 설정

// mockWebServer
testImplementation('com.squareup.okhttp3:okhttp:4.10.0')
testImplementation('com.squareup.okhttp3:mockwebserver:4.10.0')

 

 

Mock Server 인스턴스화

 

class KakaoAddressSearchServiceRetryTest extends AbstractIntegrationContainerBaseTest {

    @Autowired
    private KakaoAddressSearchService kakaoAddressSearchService

    @SpringBean 
    private KakaoUriBuilderService kakaoUriBuilderService = Mock()

    private MockWebServer mockWebServer

 

spock를 사용하여 테스트를 진행하였다.

Mock() 사용하여 실제로 카카오 api를 호출해서 응답값을 받는게 아니라 로컬호스트에 떠있는 모킹 서버를 호출하요 테스트를 실행한다.  또한 스프링 컨테이너내에 있는 해당 서비스를 모킹하기위해서 @SpringBean 을 사용한다. spock에서는 @springBean 을 사용한다.(mockbean은 스프링 컨테이너내의 bean을 모킹한다.)

 

def setup() {
    mockWebServer = new MockWebServer()
    mockWebServer.start()
}

def cleanup() {
    mockWebServer.shutdown()
}

def "requestAddressSearch retry success"() {
    given:
    def metaDto = new MetaDto(1)
    def documentDto = DocumentDto.builder()
            .addressName(inputAddress)
            .build()
    def expectedResponse = new KakaoApiResponseDto(metaDto, Arrays.asList(documentDto))
    def uri = mockWebServer.url("/").uri() //mockwebserver에서 사용하고 있는 uri를 반환

    when:
    mockWebServer.enqueue(new MockResponse().setResponseCode(504))
    mockWebServer.enqueue(new MockResponse().setResponseCode(200)
            .addHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
            .setBody(mapper.writeValueAsString(expectedResponse)))

    def kakaoApiResult = kakaoAddressSearchService.requestAddressSearch(inputAddress)
    def takeRequest = mockWebServer.takeRequest()

    then:
    2 * kakaoUriBuilderService.buildUriByAddressSearch(inputAddress) >> uri // mockwebserver uri반환
    // builduribyaddressSearch 메서드가 두번 호출된게 맞는지 2* 를 해준다
    takeRequest.getMethod() == "GET"
    kakaoApiResult.getDocumentList().size() == 1
    kakaoApiResult.getMetaDto().totalCount == 1
    kakaoApiResult.getDocumentList().get(0).getAddressName() == inputAddress

}

테스트 메서드 실행전에 setup()메서드 실행되고 mockwebserver()를 실행하면 동적으로 port가 할당이 되고 url는 localhost에서 실행이 된다. cleanup()메서드는 테스트 메서드가 끝나고 나면 실행하며 mockserver를 shutdown()한다. 

mockWebServer.enqueue()를 사용하면 MockWebServer는 엔큐된 순서대로 응답을 반환하게 된다.

 

 

 

 

 

 

 

 

출처

https://www.devkuma.com/docs/mock-web-server/