Wiremock 정리

회사에서 인앱 결제를 구현하면서 애플과 구글에서 인앱 결제 영수증을 검증하는 코드를 서버쪽에서 구현하여야 했다.
하지만 아직 클라이언트쪽이 준비가 되지 않아서 심도 깊은 테스트는 불가능하고 필요한 부분을 Mockito로 모킹하여 테스트를 진행했지만, 모킹만으로 유닛테스트를 진행하는데는 한계가 있다고 판단해서, 보다 좋은 방법이 없을지 고민하다가 서버 응답을 WireMock을 사용해 모킹해 테스트코드의 품질을 높이려 하였다.
Wiremock을 공부하고 사용하면서 정리된 사항을 작성해 보려고 한다.

WireMock이란?

WireMock은 HTTP 기반의 API를 모킹(mocking)하기 위한 도구입니다. 실제 외부 API 서버와의 통신을 모방하여, 요청에 대한 응답을 정의하고 테스트할 수 있게 해줍니다. WireMock을 사용하면 API 서버가 아직 준비되지 않았거나, 외부 API에 대한 테스트가 어려운 경우에도 해당 API와 상호 작용하는 코드를 테스트할 수 있습니다. 이를 통해 개발자는 통합 테스트에서 외부 의존성을 격리하고, 보다 일관된 테스트 환경을 구성할 수 있습니다.

WireMock을 build.gradle에 추가하기

WireMock을 사용하려면 먼저 build.gradle 파일에 WireMock 라이브러리를 추가해야 합니다. 다음은 WireMock을 추가하는 방법입니다:

dependencies {
    testImplementation 'com.github.tomakehurst:wiremock-standalone:3.0.1'
}

• 여기서 스프링 3.XX를 이용할때 standalone이 아닌 것을 가져올때 오류가 발생하니 스프링 3 이상의 버전을 사용하면 standalone 버전을 사용해야 합니다.

WireMock 설정을 위한 설정 디렉토리 구성

WireMock 설정은 Java 코드로 작성할 수도 있고, 설정 파일(JSON 형식)을 사용할 수도 있습니다. 이 예제에서는 Java 코드로 설정하는 방법을 설명합니다.

1. test/resources 디렉토리에 wiremock 폴더 생성

src/test/resources/wiremock 디렉토리를 생성하여 WireMock 설정 파일을 저장할 수 있습니다. 예를 들어, mappings 폴더를 만들어 JSON 형식의 응답을 정의할 수 있습니다. 그러나, 이 예제에서는 Java 코드로 설정을 직접합니다.

2. WireMock 설정을 위한 Java 파일 작성

SpringBoot 환경에서 WireMock을 사용하려면 테스트 클래스에서 WireMockServer를 설정할 수 있습니다. 다음은 WireMock 서버를 설정하고, Apple 서버의 응답을 모킹하는 예제입니다.

WireMock을 이용한 테스트 코드 예제

다음은 AppleSubscriptionService의 verifyTransaction 메소드를 WireMock으로 모킹하여 테스트하는 코드입니다:

package tbl.knock.payment.service;

import com.github.tomakehurst.wiremock.WireMockServer;
import com.github.tomakehurst.wiremock.client.WireMock;
import com.genesisnest.exception.CodeException;
import com.genesisnest.module.database.domain.payment.SubscriptionTransactionHistory;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.springframework.boot.test.context.SpringBootTest;
import tbl.knock.payment.common.crypt.AppleSigningKeyResolver;
import tbl.knock.payment.repository.payment.SubscriptionTransactionHistoryRepository;

import java.util.Optional;

import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.Mockito.when;

@SpringBootTest
public class AppleSubscriptionServiceWireMockTest {

    @Mock
    private SubscriptionTransactionHistoryRepository subscriptionTransactionHistoryRepository;

    @Mock
    private AppleSigningKeyResolver appleSigningKeyResolver;

    @InjectMocks
    private AppleSubscriptionService appleSubscriptionService;

    private static WireMockServer wireMockServer;

    @BeforeAll
    static void setup() {
        wireMockServer = new WireMockServer(8080); // 8080 포트에서 WireMock 서버 시작
        wireMockServer.start();

        // Mocking Apple's sandbox server response for a valid transaction
        wireMockServer.stubFor(WireMock.get(WireMock.urlMatching("/sandbox.*"))
            .willReturn(WireMock.aResponse()
                .withStatus(200)
                .withHeader("Content-Type", "application/json")
                .withBody("{ \"status\": 0, \"receipt\": { \"original_transaction_id\": \"test-transaction-id\" } }")));

        // Mocking Apple's server response for an invalid transaction
        wireMockServer.stubFor(WireMock.get(WireMock.urlMatching("/sandbox.*"))
            .withQueryParam("originalTransactionId", WireMock.equalTo("invalid-transaction-id"))
            .willReturn(WireMock.aResponse()
                .withStatus(400)
                .withHeader("Content-Type", "application/json")
                .withBody("{ \"status\": 21000, \"message\": \"Invalid transaction id\" }")));
    }

    @AfterAll
    static void teardown() {
        wireMockServer.stop(); // 테스트가 끝난 후 WireMock 서버 종료
    }

    @BeforeEach
    void setUp() {
        MockitoAnnotations.openMocks(this);
    }

    @Test
    void verifyTransaction_success() {
        // Arrange
        String originalTransactionId = "test-transaction-id";
        SubscriptionTransactionHistory mockHistory = new SubscriptionTransactionHistory();
        mockHistory.setAppIdentifier("test.bundle.id");

        when(subscriptionTransactionHistoryRepository.findMostRecentByOriginalTransactionId(originalTransactionId))
                .thenReturn(Optional.of(mockHistory));
        when(appleSigningKeyResolver.generateTokenForApple("test.bundle.id")).thenReturn("mockJwtToken");

        // Act
        boolean result = appleSubscriptionService.verifyTransaction(originalTransactionId);

        // Assert
        assertTrue(result);
    }

    @Test
    void verifyTransaction_invalidTransaction() {
        // Arrange
        String originalTransactionId = "invalid-transaction-id";
        SubscriptionTransactionHistory mockHistory = new SubscriptionTransactionHistory();
        mockHistory.setAppIdentifier("test.bundle.id");

        when(subscriptionTransactionHistoryRepository.findMostRecentByOriginalTransactionId(originalTransactionId))
                .thenReturn(Optional.of(mockHistory));
        when(appleSigningKeyResolver.generateTokenForApple("test.bundle.id")).thenReturn("mockJwtToken");

        // Act & Assert
        assertThrows(CodeException.class, () -> {
            appleSubscriptionService.verifyTransaction(originalTransactionId);
        });
    }
}