API コントラクトテスト

目次

• 概要
• 使用する場合
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

コントラクトテストは、コンシューマーとプロバイダー間の API コントラクトが守られていることを検証します。全体の統合テストを必要とせずに、サービスの変更が依存するコンシューマーを壊さないようにします。コントラクトテストはリクエスト/レスポンス形式、データ型、API の動作を個別に検証します。

使用する場合

• マイクロサービス通信のテスト
• 破壊的な API 変更の防止
• API バージョニングの検証
• コンシューマー・プロバイダーコントラクトのテスト
• 下位互換性の確保
• OpenAPI/Swagger 仕様の検証
• サードパーティ API 統合のテスト
• CI でコントラクト違反をキャッチ

クイックスタート

最小限の実行可能な例:

// tests/pact/user-service.pact.test.ts
import { PactV3, MatchersV3 } from "@pact-foundation/pact";
import { UserService } from "../../src/services/UserService";

const { like, eachLike, iso8601DateTimeWithMillis } = MatchersV3;

const provider = new PactV3({
  consumer: "OrderService",
  provider: "UserService",
  port: 1234,
  dir: "./pacts",
});

describe("User Service Contract", () => {
  const userService = new UserService("http://localhost:1234");

  describe("GET /users/:id", () => {
    test("returns user when found", async () => {
      await provider
        .given("user with ID 123 exists")
        .uponReceiving("a request for user 123")
        .withRequest({
          method: "GET",
          path: "/users/123",
          headers: {
// ... (詳細な実装はリファレンスガイドを参照)

リファレンスガイド

references/ ディレクトリ内の詳細な実装:

ベストプラクティス

✅ DO

• コンシューマーの観点からコントラクトをテストする
• 柔軟なマッチング用にマッチャーを使用する
• 特定の値ではなくスキーマ構造を検証する
• コントラクトをバージョン管理する
• エラーレスポンスをテストする
• コントラクト共有用に Pact Broker を使用する
• CI でコントラクトテストを実行する
• 下位互換性をテストする

❌ DON'T

• コントラクトテストでビジネスロジックをテストしない
• コントラクトに特定の値をハードコードしない
• エラーシナリオをスキップしない
• コントラクトテストで UI をテストしない
• コントラクトバージョニングを無視しない
• コントラクト検証なしでデプロイしない
• 実装詳細をテストしない
• コントラクトテストをモックしない