コントラクトテスト

どのようなものか

コントラクトテストは、二つのコンポーネントが、やり取りする要求、応
答、メッセージについて同じ前提を持つかを確かめるテストです。荷物追跡
画面と追跡サービスは、個別のテストではどちらも動く場合があります。そ
れでも画面が
`status` という項目を読む一方、サービスが `state`
という名前で送ると、組み合わせたときに壊れます。画面が実際に使う情報
を示し、サービスがその情報を供給できることを検証します。

Pact
が説明する方法では、利用側を、制御できる提供側の代替に接続します。テ
ストがやり取りをコントラクトとして記録します。提供側は、指定された条
件の下で自分の実装を動かし、同じやり取りを検証します。メッセージの場
合、対応する証拠は、実際に作るメッセージと受け取って扱うメッセージで
す。用意した証拠が組み合わせる予定の版に対応していれば、二つの側は
別々に開発や公開を進められます。

コントラクトテストは、提供側を公開仕様と照合する検証を指すこともあり
ます。OpenAPI
文書が共通の取り決めなら、それを利用できます。仕様には項目の形、ス
テータスコード、許可される値を記述できます。利用側の事例は、特定のク
ライアントがどんな組み合わせを使い、何を前提としているかも示します。
二つの方法は併用できます。実際に連携する経路を通すテストには、経路設
定、認証情報、実行環境などの別の検証対象があります。

なぜ重要なのか

インターフェースは、最初の実装より長く残ることがよくあります。サービ
スの担当者が自分たちのテストと共に項目名を更新しても、別の場所で保守
するクライアントまで更新されるとは限りません。モバイルアプリでは、古
い版が何か月も使われることがあります。表示する案内をその項目から選ぶ
なら、データ型の小さな変更も重要です。検証できる取り決めがあれば、リ
リース前に依存関係を調べられます。

別々の時期にリリースする場合、どの版が互換かという情報には価値があり
ます。古いクライアントが理解する状態が少ない一方、新しいサービスでは
中間状態が必要になるとします。先にクライアントを更新し、移行中は両方
の形式に対応し、依存している版が使わなくなったことを確認してから古い
形式を外すという方法があります。安全な順番は、記録した約束、実際の利
用、システムの公開方針で決まります。最近の二つの版だけを検証しても、
使われ続ける古い版の互換性までは分かりません。

テストでは取り決めにとって大切な点を示します。形式の正しい参照番号な
らどれでもよい場合は、例の文字列を固定せず、形式を確かめます。利用者
に見える挙動をその項目が決めるなら、型とクライアントが理解できる値を
確かめます。未知の値をどう扱うかも、必要に応じて定めます。合意できる
なら、「状態を取得できません」と示して、その他の内容は利用できること
をテストで確かめられます。

実際の活用例

架空の荷物追跡アプリでは、参照番号を使って荷物を問い合わせます。荷物
が存在して輸送中の場合、画面は成功を示す応答、参照番号、輸送中の表示
に結び付けられる文字列を期待します。番号に対応する荷物がなければ別の
応答を受け、入力を確認できるように案内します。それぞれに「対象の荷物
は輸送中」「この番号の荷物は存在しない」といった前提があります。

まず利用側の実際の要求コードを、制御した代替と組み合わせて実行しま
す。各例でアプリが何を表示するかを確認します。次に、提供側が実際に応
答を作る経路で同じやり取りを検証します。前提となる状態を再現できる試
験データを使い、試行の間に状態を元に戻します。データベースや配送会社
のサービスを差し替える場合でも、利用側が前提にする要求の解析、サービ
スの判断、応答の組み立ては実行します。

利用側はそのままにし、提供側の `status` を試しに `state`
に替えます。検証は項目の不足を示し、影響するやり取りを特定できるはず
です。逆に、利用側が無視する任意項目の追加が約束上許されるなら、検査
も通るべきです。検証した版を記録します。出所の分からない古い事例と新
しい提供側の結果を混ぜると、どの組み合わせを試したか分からなくなりま
す。

当サイトのSolana
のモバイルウォレットでアプリを開く方法のノートは、連携先によってリン
クの経路とパラメーターの符号化が異なることを紹介しています。生成され
たリンクのテストは、各ウォレットが期待する形を守るために使えます。実
機での確認は、ブラウザーがリンクをインストール済みのアプリに渡すか、
その後の操作が完了するかを観察できます。ノートは実際の違いを記録し、
実機で試す確認項目を挙げています。

問題が起きるところ

応答が保存した例と一文字ずつ一致しなければならないと、約束が窮屈にな
ります。提供側は、未使用の項目を加えたり、独立した補足メッセージの書
式を変えたりできる場合があります。必須にするのは利用側が使う項目や公
開仕様で求める項目です。順序や単位、正確な文言は、合意に必要なところ
で求めます。

実際の境界を通らないテストは、別の失敗を見落とします。手書きの JSON
オブジェクトを検査しても、提供側が応答を作るコードを実行しない場合が
あります。代替が期待した例を返しても、利用側がそれを正しく読んだかは
分かりません。確認する側の要求、解析、応答の実コードを通し、代替した
依存先を記録します。

成功する一件だけでは、値の欠落、未知の参照番号、現場で使い続ける旧版
を十分に確認できません。利用側が扱う失敗経路と、提供側が約束している
互換性を調べます。経路設定や環境を試す統合テストも保ちます。コントラ
クトが明確であれば、二つのチームは関連する変更のたびに、範囲を絞った
検証をすばやく行えます。

参考資料

  * Pact のコントラクトテストの定義

  * Pact での利用側と提供側の検証方法

  * Pact のプロバイダー状態に関する文書

  * HTTP インターフェースを記述する OpenAPI 仕様

hこのページのウェブ版	URL:https://engineer.company/ja/glossary/contract-testing/	engineer.company	70
