WireMockを使用したREST APIのユニットテスト

概要

WireMockを使用した外部REST API統合テストのパターン：レスポンスのスタブ化、リクエストの検証、エラーシナリオ、ネットワーク依存なしの高速テスト。

使用時機

• 外部REST APIを呼び出すサービスのテスト
• 予測可能なテスト動作のためのHTTPレスポンスのスタブ化
• エラーシナリオのテスト（タイムアウト、5xxエラー、不正なレスポンス）
• リクエスト詳細の検証（ヘッダー、クエリパラメータ、リクエストボディ）

実装手順

1. 依存関係を追加：テストスコープのWireMock（Maven/Gradle）
2. 拡張を登録：dynamicPort()で@RegisterExtension WireMockExtensionを設定
3. クライアントを構成：wireMock.getRuntimeInfo().getHttpBaseUrl()をベースURLとして使用
4. レスポンスをスタブ化：stubFor()でリクエストマッチング（URL、ヘッダー、ボディ）を指定
5. 実行と検証：サービスメソッドを呼び出し、AssertJで結果を検証
6. リクエストを検証：verify()でAPIの正しい使用を確認

スタブが一致しない場合：URLエンコーディング、ヘッダー名を確認し、クエリパラメータにurlEqualToを使用してください。

テストがハング状態になる場合：HTTPクライアントにコネクションタイムアウトを設定し、withFixedDelay()でタイムアウトシミュレーションを行ってください。

ポート競合がある場合：常にwireMockConfig().dynamicPort()を使用してください。

例

Maven依存関係

<dependency>
  <groupId>org.wiremock</groupId>
  <artifactId>wiremock</artifactId>
  <version>3.4.1</version>
  <scope>test</scope>
</dependency>
<dependency>
  <groupId>org.assertj</groupId>
  <artifactId>assertj-core</artifactId>
  <scope>test</scope>
</dependency>

基本的なスタブ化と検証

import com.github.tomakehurst.wiremock.junit5.WireMockExtension;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import static com.github.tomakehurst.wiremock.client.WireMock.*;
import static org.assertj.core.api.Assertions.assertThat;

class ExternalWeatherServiceTest {

  @RegisterExtension
  static WireMockExtension wireMock = WireMockExtension.newInstance()
    .options(wireMockConfig().dynamicPort())
    .build();

  @Test
  void shouldFetchWeatherDataFromExternalApi() {
    wireMock.stubFor(get(urlEqualTo("/weather?city=London"))
      .withHeader("Accept", containing("application/json"))
      .willReturn(aResponse()
        .withStatus(200)
        .withHeader("Content-Type", "application/json")
        .withBody("{\"city\":\"London\",\"temperature\":15,\"condition\":\"Cloudy\"}")));

    String baseUrl = wireMock.getRuntimeInfo().getHttpBaseUrl();
    WeatherApiClient client = new WeatherApiClient(baseUrl);
    WeatherData weather = client.getWeather("London");

    assertThat(weather.getCity()).isEqualTo("London");
    assertThat(weather.getTemperature()).isEqualTo(15);

    wireMock.verify(getRequestedFor(urlEqualTo("/weather?city=London"))
      .withHeader("Accept", containing("application/json")));
  }
}

エラーシナリオ、ボディ検証、タイムアウトシミュレーション、ステートフルテストについてはreferences/advanced-examples.mdを参照してください。

ベストプラクティス

• 動的ポート：並列テスト実行での競合を防止
• リクエストの検証：クライアントによるAPIの正しい使用を保証
• エラーのテスト：タイムアウト、4xx、5xxシナリオをカバー
• 限定的なスタブ：テストごとに1つの関心事
• 自動リセット：@RegisterExtensionはテスト間でWireMockをリセット
• 実際のAPIを呼び出さない：常にサードパーティエンドポイントをスタブ化

制約と警告

• 動的ポートが必須：固定ポートは並列実行での競合を引き起こす
• HTTPSテスト：TLS接続をテストする場合、WireMock TLS設定を構成
• スタブの優先度：より具体的なスタブが一般的なものより優先される
• パフォーマンス：WireMockはオーバーヘッドを追加します。より高速なテストのためクライアントレイヤーでモック化してください
• API変更：スタブを実際のAPIコントラクトと同期に保つ

参考資料

• WireMock Documentation
• WireMock Stubbing Guide
• references/advanced-examples.md - エラーシナリオ、ボディ検証、タイムアウト