コントラクトテスト
コンポーネント間で合意したインターフェースの検証
どのようなものか
コントラクトテストは、二つのコンポーネントが、やり取りする要求、応答、メッセージについて同じ前提を持つかを確かめるテストです。荷物追跡画面と追跡サービスは、個別のテストではどちらも動く場合があります。それでも画面が status という項目を読む一方、サービスが state という名前で送ると、組み合わせたときに壊れます。画面が実際に使う情報を示し、サービスがその情報を供給できることを検証します。
Pact が説明する方法では、利用側を、制御できる提供側の代替に接続します。テストがやり取りをコントラクトとして記録します。提供側は、指定された条件の下で自分の実装を動かし、同じやり取りを検証します。メッセージの場合、対応する証拠は、実際に作るメッセージと受け取って扱うメッセージです。用意した証拠が組み合わせる予定の版に対応していれば、二つの側は別々に開発や公開を進められます。
コントラクトテストは、提供側を公開仕様と照合する検証を指すこともあります。OpenAPI 文書が共通の取り決めなら、それを利用できます。仕様には項目の形、ステータスコード、許可される値を記述できます。利用側の事例は、特定のクライアントがどんな組み合わせを使い、何を前提としているかも示します。二つの方法は併用できます。実際に連携する経路を通すテストには、経路設定、認証情報、実行環境などの別の検証対象があります。
なぜ重要なのか
インターフェースは、最初の実装より長く残ることがよくあります。サービスの担当者が自分たちのテストと共に項目名を更新しても、別の場所で保守するクライアントまで更新されるとは限りません。モバイルアプリでは、古い版が何か月も使われることがあります。表示する案内をその項目から選ぶなら、データ型の小さな変更も重要です。検証できる取り決めがあれば、リリース前に依存関係を調べられます。
別々の時期にリリースする場合、どの版が互換かという情報には価値があります。古いクライアントが理解する状態が少ない一方、新しいサービスでは中間状態が必要になるとします。先にクライアントを更新し、移行中は両方の形式に対応し、依存している版が使わなくなったことを確認してから古い形式を外すという方法があります。安全な順番は、記録した約束、実際の利用、システムの公開方針で決まります。最近の二つの版だけを検証しても、使われ続ける古い版の互換性までは分かりません。
テストでは取り決めにとって大切な点を示します。形式の正しい参照番号ならどれでもよい場合は、例の文字列を固定せず、形式を確かめます。利用者に見える挙動をその項目が決めるなら、型とクライアントが理解できる値を確かめます。未知の値をどう扱うかも、必要に応じて定めます。合意できるなら、「状態を取得できません」と示して、その他の内容は利用できることをテストで確かめられます。
実際の活用例
架空の荷物追跡アプリでは、参照番号を使って荷物を問い合わせます。荷物が存在して輸送中の場合、画面は成功を示す応答、参照番号、輸送中の表示に結び付けられる文字列を期待します。番号に対応する荷物がなければ別の応答を受け、入力を確認できるように案内します。それぞれに「対象の荷物は輸送中」「この番号の荷物は存在しない」といった前提があります。
まず利用側の実際の要求コードを、制御した代替と組み合わせて実行します。各例でアプリが何を表示するかを確認します。次に、提供側が実際に応答を作る経路で同じやり取りを検証します。前提となる状態を再現できる試験データを使い、試行の間に状態を元に戻します。データベースや配送会社のサービスを差し替える場合でも、利用側が前提にする要求の解析、サービスの判断、応答の組み立ては実行します。
利用側はそのままにし、提供側の status を試しに state に替えます。検証は項目の不足を示し、影響するやり取りを特定できるはずです。逆に、利用側が無視する任意項目の追加が約束上許されるなら、検査も通るべきです。検証した版を記録します。出所の分からない古い事例と新しい提供側の結果を混ぜると、どの組み合わせを試したか分からなくなります。
当サイトのSolana のモバイルウォレットでアプリを開く方法のノートは、連携先によってリンクの経路とパラメーターの符号化が異なることを紹介しています。生成されたリンクのテストは、各ウォレットが期待する形を守るために使えます。実機での確認は、ブラウザーがリンクをインストール済みのアプリに渡すか、その後の操作が完了するかを観察できます。ノートは実際の違いを記録し、実機で試す確認項目を挙げています。
問題が起きるところ
応答が保存した例と一文字ずつ一致しなければならないと、約束が窮屈になります。提供側は、未使用の項目を加えたり、独立した補足メッセージの書式を変えたりできる場合があります。必須にするのは利用側が使う項目や公開仕様で求める項目です。順序や単位、正確な文言は、合意に必要なところで求めます。
実際の境界を通らないテストは、別の失敗を見落とします。手書きの JSON オブジェクトを検査しても、提供側が応答を作るコードを実行しない場合があります。代替が期待した例を返しても、利用側がそれを正しく読んだかは分かりません。確認する側の要求、解析、応答の実コードを通し、代替した依存先を記録します。
成功する一件だけでは、値の欠落、未知の参照番号、現場で使い続ける旧版を十分に確認できません。利用側が扱う失敗経路と、提供側が約束している互換性を調べます。経路設定や環境を試す統合テストも保ちます。コントラクトが明確であれば、二つのチームは関連する変更のたびに、範囲を絞った検証をすばやく行えます。