Spring Boot 외부 API 테스트 코드를 짜보자! [MockWebServer vs WireMock]

❓ Mock 서버를 사용하는 이유

Spring Boot Github 소셜 로그인 구현하기 [ RestTemplate · WebClient · FeignClient 를 비교해보자 ]

Github OAuth 인증 흐름과 사전 준비 Github 인증 흐름은 다음과 같다. 1. https://github.com/login/oauth/authorize?client_id={발급받은 client_id} 로 이동하는 링크를 사용자가 클릭한다. 2. 사용자는 아래와 같은 화

yinq.tistory.com

REST API 요청을 할 수 있도록 하는 RestTemplate · WebClient · FeignClient 클래스를 활용하여 외부 API 요청을 통해 기능을 구현했었다.

테스트 코드를 짜기 위한 방법을 찾아보니, Mock 웹 서버를 정의해서 테스트 하는 방법이 있었다.

💡장점

1. 실제 API 서버를 사용해서 테스트를 하면, 서버 상태에 따라 테스트의 결과가 달라질 수 있다.

2. Mock 서버로도, 외부 API가 정상이고 정상적인 값(예상한 값)이 반환된다면, 정상적으로 로직이 작동하는 것을 보여줄 수 있다.

3. 로컬에 서버를 띄워 사용하기 때문에 속도가 빠르다는 장점이 있다.

위와 같은 장점이 있는 Mock 웹 서버를 구현하기 위해서 사용하는 라이브러리는

대표적으로 MockWebServer 와 WireMock 이 있다.

WireMock이 안드로이드 환경에서 문제가 생겨 탄생한 것이 MockWebServer라고 한다.

안드로이드 환경이 아니라면 WireMock이 기능이 풍부해서 추천한다는 stackoverflow 글이 있다.

나는, 2가지 방법 모두 사용해서 테스트 코드를 작성해보도록 하겠다.

💡 두 방식의 공통점은 로컬에 가짜 서버를 띄운 뒤, 특정 요청을 했을 때의 응답값을 가정하고 테스트 코드를 작성하는 것이다.

Mockito 테스트 코드를 짜는 방식과 흡사하다.

테스트 코드를 작성할 로직

// github 측에 clientId, clientSecret, code를 전달해서 accessToken을 받는 로직
@FeignClient(name = "access-token-feign-client", url = "${feign.client.access-token.url}")
public interface AccessTokenFeignClient {

    @PostMapping("/login/oauth/access_token")
    String getAccessToken(
            @RequestParam("client_id") String clientId,
            @RequestParam("client_secret") String clientSecret,
            @RequestParam("code") String code
    );
}

// acessToken을 AuthorizationHeader에 담아 요청해서 github 회원 정보를 받는 로직
@FeignClient(name = "user-profile-feign-client", url = "${feign.client.user-profile.url}")
public interface UserProfileFeignClient {

    @GetMapping("/user")
    UserProfile getUserInfo(@RequestHeader("Authorization") String accessToken);
}

FeignClient 를 이용해 만든, 위 2개의 로직 테스트 코드를 작성해보겠다.

MockWebServer

Dependency 추가

testImplementation group: 'com.squareup.okhttp3', name: 'mockwebserver', version: '5.0.0-alpha.11'
implementation group: 'com.squareup.okhttp3', name: 'okhttp', version: '5.0.0-alpha.11'

build.gralde에 위 라이브러리를 추가해준다.

그리고 두 라이브러리의 버전은 일치해야 한다고 한다.

Test Code 작성

@SpringBootTest
public class FeignClientTest {


    @Autowired
    private AccessTokenFeignClient accessTokenFeignClient;

    @Autowired
    private UserProfileFeignClient userProfileFeignClient;

    public static MockWebServer mockWebServer = new MockWebServer();

    @DynamicPropertySource
    public static void addUrlProperties(DynamicPropertyRegistry registry) {
        registry.add("feign.client.access-token.url", () -> "http://localhost:" + mockWebServer.getPort());
        registry.add("feign.client.user-profile.url", () -> "http://localhost:" + mockWebServer.getPort());
    }

    @BeforeAll
    public static void setUp() throws IOException {
        mockWebServer.start();
    }

    @AfterAll
    public static void shutdown() throws IOException {
        mockWebServer.shutdown();
    }


}

우리가 생성한 MockWebServer에 요청을 보내야, 정의한 응답을 받을 수 있을 것이다.

@DynamicPropertySource 어노테이션과 getPort() 메서드를 사용하여, 외부 api 요청을 MockWebServer 로 요청할 수 있도록 환경변수를 변경한다.

그리고, 매 테스트 코드 실행 전 서버가 실행되고 메서드 실행 후 닫히도록 설정해준다.

	@Test
    @DisplayName("AccessToken 가져오기 성공 테스트")
    public void getAccessTokenSuccess() throws InterruptedException {
        //given
        String clientId = "clientId";
        String clientSecrets = "clientSecrets";
        String code = "code";
        String expectedToken = "token";
        String expectedResponse = String.format("access_token=%s&expires_in={값}&refresh_token={값}&refresh_token_expires_in={값}&scope=&token_type={값}", expectedToken);

        mockWebServer.enqueue(new MockResponse()
                .setBody(expectedResponse));

        //when
        String response = accessTokenFeignClient.getAccessToken(clientId, clientSecrets, code);


        //then
        RecordedRequest recordedRequest = mockWebServer.takeRequest();
        assertThat(recordedRequest.getMethod()).isEqualTo("POST");
        assertThat(recordedRequest.getPath())
                .isEqualTo(String.format("/login/oauth/access_token?client_id=%s&client_secret=%s&code=%s", clientId, clientSecrets, code));
        assertThat(TextParsingUtil.parsingFormData(response).get("access_token")).isEqualTo(expectedToken);
    }

enqueue() 메서드를 통해, mockWebServer로 요청이 들어왔을 때, 응답 값을 지정해준다.

그리고, FeignClient로 정의한 메서드 실행 시 정의된 HTTP Method와 URI로 요청이 잘 갔는지 확인해준다.

    static class GithubResponse {
        private String login;
        private String avatar_url;
        private String blog;
        private String html_url;

        public GithubResponse(String login, String avatar_url, String blog, String html_url) {
            this.login = login;
            this.avatar_url = avatar_url;
            this.blog = blog;
            this.html_url = html_url;
        }
    }

    @Test
    @DisplayName("회원 정보 가져오기 성공 테스트")
    public void getUserProfileSuccess() throws InterruptedException {
        //given
        Gson gson = new Gson();
        String userName = "userName";
        String imageUrl = "imageUrl";
        String blog = "blog";
        String githubUrl = "githubUrl";
        String expectedResponse = gson.toJson(new GithubResponse(userName, imageUrl, blog, githubUrl));
        String accessToken = "accesstoken";

        mockWebServer.enqueue(new MockResponse()
                .addHeader("Content-Type", MediaType.APPLICATION_JSON_VALUE)
                .setBody(expectedResponse));

        //when
        UserProfile response = userProfileFeignClient.getUserInfo(accessToken);


        //then
        RecordedRequest recordedRequest = mockWebServer.takeRequest();
        assertThat(recordedRequest.getMethod()).isEqualTo("GET");
        assertThat(recordedRequest.getPath())
                .isEqualTo("/user");

        assertThat(response.getUserName()).isEqualTo(userName);
        assertThat(response.getImageUrl()).isEqualTo(imageUrl);
        assertThat(response.getBlog()).isEqualTo(blog);
        assertThat(response.getGithubUrl()).isEqualTo(githubUrl);
    }

getUserInfo() 메서드의 경우는 약간 복잡하다.

실제로, 직렬화된 JSON 형태로 회원 정보를 보내주므로 이를 모방하기 위해서 GithubResponse 라는 임시 클래스를 정의 한 뒤, 직렬화 시킨 값을 응답값으로 정의했다.

직렬화된 응답 값을, FeignClient는 역직렬화하여 UserProfile이라는 객체를 생성할 수 있어야 한다.

따라서, 위와 같이 HTTP Method 와 요청 URI, 그리고 역직렬화된 객체의 데이터 값이 동일한지 검증함으로서 테스트 코드를 작성할 수 있었다.

WireMock

Dependency 추가

implementation group: 'org.springframework.cloud', name: 'spring-cloud-starter-contract-stub-runner', version: '4.0.1'

WireMock 을 사용하기 위해, 위 라이브러리를 추가해준다.

Test Code 작성

@SpringBootTest
@AutoConfigureWireMock
public class FeignClientTest {


    @Autowired
    private AccessTokenFeignClient accessTokenFeignClient;

    @Autowired
    private UserProfileFeignClient userProfileFeignClient;

    private static WireMockServer wireMockServer = new WireMockServer(8081);


    @DynamicPropertySource
    public static void addUrlProperties(DynamicPropertyRegistry registry) {
        registry.add("feign.client.access-token.url", () -> "http://localhost:" + wireMockServer.port());
        registry.add("feign.client.user-profile.url", () -> "http://localhost:" + wireMockServer.port());
    }

    @BeforeAll
    public static void setUp() {
        wireMockServer.start();
    }

    @AfterAll
    public static void shutdown(){
        wireMockServer.stop();
    }

}

WireMock 도 초기 설정은 MockWebServer와 유사하다.

단, @SpringBootTest 와 함께 사용하면 8080 포트를 Mock 웹 서버와 같이 사용할 수 없으므로

WireMockServer의 포트를 8081로 설정해주었다.

그리고 @AutoConfigureWireMock 어노테이션을 붙여준다.

    @Test
    @DisplayName("AccessToken 가져오기 성공 테스트")
    public void getAccessTokenSuccess() {
        //given
        String clientId = "clientId";
        String clientSecrets = "clientSecrets";
        String code = "code";
        String expectedToken = "token";
        String expectedResponse = String.format("access_token=%s&expires_in={값}&refresh_token={값}&refresh_token_expires_in={값}&scope=&token_type={값}", expectedToken);

        wireMockServer.stubFor(post(urlEqualTo(String.format("/login/oauth/access_token?client_id=%s&client_secret=%s&code=%s", clientId, clientSecrets, code)))
                .willReturn(
                        aResponse()
                                .withBody(expectedResponse)
                ));

        //when
        String response = accessTokenFeignClient.getAccessToken(clientId, clientSecrets, code);


        //then
        assertThat(TextParsingUtil.parsingFormData(response).get("access_token")).isEqualTo(expectedToken);
    }

    static class GithubResponse {
        private String login;
        private String avatar_url;
        private String blog;
        private String html_url;

        public GithubResponse(String login, String avatar_url, String blog, String html_url) {
            this.login = login;
            this.avatar_url = avatar_url;
            this.blog = blog;
            this.html_url = html_url;
        }
    }

    @Test
    @DisplayName("회원 정보 가져오기 성공 테스트")
    public void getUserProfileSuccess(){
        //given
        Gson gson = new Gson();
        String userName = "userName";
        String imageUrl = "imageUrl";
        String blog = "blog";
        String githubUrl = "githubUrl";
        String expectedResponse = gson.toJson(new GithubResponse(userName, imageUrl, blog, githubUrl));
        String accessToken = "accesstoken";

        wireMockServer.stubFor(get(urlEqualTo("/user"))
                .willReturn(
                        aResponse()
                                .withHeader("Content-Type", MediaType.APPLICATION_JSON_VALUE)
                                .withBody(expectedResponse)
                ));

        //when
        UserProfile response = userProfileFeignClient.getUserInfo(accessToken);


        //then
        assertThat(response.getUserName()).isEqualTo(userName);
        assertThat(response.getImageUrl()).isEqualTo(imageUrl);
        assertThat(response.getBlog()).isEqualTo(blog);
        assertThat(response.getGithubUrl()).isEqualTo(githubUrl);
    }

테스트 코드로 검증하는 방식은 MockWebServer와 유사한 흐름으로 작성하였다.

다른 점은

wireMockServer.stubFor(post(urlEqualTo(String.format("/login/oauth/access_token?client_id=%s&client_secret=%s&code=%s", clientId, clientSecrets, code)))
          .willReturn(
                 aResponse()
                         .withBody(expectedResponse)
           ));

위 부분 처럼, Mocking 해줄 때 Http Method도 지정할 수 있다.

실제로 위 코드에서, Http Method를 get으로 변경하는 경우, 테스트 실패를 하게 된다.

왜냐하면, getAccessToken() 메서드에서 POST 요청을 보내도록 되어있기 때문이다.

MockWebServer와 비교했을 때, 보다 구체적인 상황으로 테스트 코드를 작성할 수 있어서

코드가 어떤 역할인지 더 잘 보여줄 수 있다는 장점이 있는 것 같다.

❓ Mock 서버를 사용하는 이유

테스트 코드를 작성할 로직

MockWebServer

Dependency 추가

Test Code 작성

WireMock

Dependency 추가

Test Code 작성

티스토리툴바