静的リソースを使用した HTTP コールアウトのテスト

受信するレスポンスボディを静的リソース内に指定し、2 つの組み込みクラス (StaticResourceCalloutMock または MultiStaticResourceCalloutMock) のいずれかを使用することで、HTTP コールアウトをテストできます。

StaticResourceCalloutMock を使用した HTTP コールアウトのテスト

Apex には、静的リソースでレスポンスボディを指定することでコールアウトのテストに使用できる、組み込み StaticResourceCalloutMock クラスが用意されています。このクラスを使用する場合、HttpCalloutMock インターフェースを独自に実装する必要ありません。代わりに、単に StaticResourceCalloutMock のインスタンスを作成し、レスポンスボディに使用する静的リソースを応答の他のプロパティ (状況コードやコンテンツタイプなど) と共に設定します。

静的リソースについての詳細は、Salesforce オンラインヘルプの「静的リソースの定義」を参照してください。

次に、StaticResourceCalloutMock のインスタンスを作成し、静的リソースとその他のプロパティを設定します。

テストメソッドで、Test.setMock をコールして擬似コールアウトモードを設定し、最初の引数として HttpCalloutMock.class、2 番目の引数として StaticResourceCalloutMock 用に作成した変数名を渡します。

これ以降テストメソッドでコールアウトを実行しようとすると、コールアウトは実行されず、Apex ランタイムが StaticResourceCalloutMock のインスタンスで指定した擬似応答を送信します。

次の詳細な例には、テストメソッド (testCalloutWithStaticResources) が含まれ、このメソッドで、コールアウトを実行する getInfoFromExternalService をテストします。この例を実行する前に、コンテンツ {"hah":"fooled you"} を含むテキストファイルに基づいた mockResponse という名前の静的リソースを作成します。各クラスを個別に保存して���CalloutStaticClassTest でテストを実行します。

MultiStaticResourceCalloutMock を使用した HTTP コールアウトのテスト

Apex には、各エンドポイントの静的リソースでレスポンスボディを指定することでコールアウトのテストに使用できる、組み込み MultiStaticResourceCalloutMock クラスが用意されています。このクラスは、複数のレスポンスボディを指定できること以外は StaticResourceCalloutMock と似ています。このクラスを使用する場合、HttpCalloutMock インターフェースを独自に実装する必要ありません。代わりに、単に MultiStaticResourceCalloutMock のインスタンスを作成し、エンドポイントごとに使用する静的リソースを設定します。状況コードやコンテンツタイプなどの応答の他のプロパティも設定できます。

最初に、レスポンスボディを含めるテキストファイルから静的リソースを作成する必要があります。「StaticResourceCalloutMock を使用した HTTP コールアウトのテスト」に示された手順を参照してください。

次に、MultiStaticResourceCalloutMock のインスタンスを作成し、静的リソースとその他のプロパティを設定します。

テストメソッドで、Test.setMock をコールして擬似コールアウトモードを設定し、最初の引数として HttpCalloutMock.class、2 番目の引数として MultiStaticResourceCalloutMock 用に作成した変数名を渡します。

これ以降テストメソッドで https://example.com/example/test または https://example.com/example/sfdc のいずれかのエンドポイントへの HTTP コールアウトを実行しようとすると、コールアウトは実行されず、Apex ランタイムが MultiStaticResourceCalloutMock のインスタンスで指定した対応する擬似応答を送信します。

次の詳細な例には、テストメソッド (testCalloutWithMultipleStaticResources) が含まれ、このメソッドで、コールアウトを実行する getInfoFromExternalService をテストします。この例を実行する前に、コンテンツ {"hah":"fooled you"} を含むテキストファイルに基づいた mockResponse という名前の静的リソースと、コンテンツ {"hah":"fooled you twice"} を含むテキストファイルに基づいた mockResponse2 という名前の静的リソースを作成します。各クラスを個別に保存して、CalloutMultiStaticClassTest でテストを実行します。