この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

テストクラス

Visualforce テストに関連するメソッドが含まれます。

名前空間

System

Test メソッド

Test のメソッドは次のとおりです。すべてのメソッドが静的です。

getStandardPricebookId()

組織内の標準価格表の ID を返します。

署名

public static Id getStandardPricebookId()

戻り値

型: Id

標準価格表の ID。

使用方法

このメソッドでは、テストで組織データをクエリできるかどうかに関係なく、組織内の標準価格表の ID を返します。デフォルトでは、@isTest(SeeAllData=true) アノテーションが付加されていない限り、テストで組織データをクエリすることはできません。

標準価格で価格表エントリを作成するには、標準価格表の ID が必要です。このメソッドを使用して標準価格表 ID を取得すれば、テストで価格表エントリを作成できます。

次の例では、価格表エントリのテストデータをいくつか作成します。この例のテストメソッドは、標準価格表 ID を取得し、その ID を使用して標準価格で商品の価格表エントリを作成します。次に、テストはカスタム価格表を作成し、このカスタム価格表の ID を使用して、カスタム価格の価格表エントリを追加します。

invokeContinuationMethod(Object, Continuation)

テストメソッド内で指定されたコントローラと継続のコールバックメソッドを呼び出します。

署名

public static Object invokeContinuationMethod(Object controller, Continuation request)

パラメータ

controller
型: Object
継続要求を呼び出すコントローラクラスのインスタンス。
request
型: Continuation
コントローラクラスのアクションメソッドから返される継続。

戻り値

型: Object

継続コールバックメソッドの応答。

使用方法

継続をテストするには、Test.setContinuationResponse メソッドと Test.invokeContinuationMethod メソッドを使用します。テストコンテキストでは、継続のコールアウトは外部サービスに送信されません。これらのメソッドを使用することで、擬似応答を設定でき、ランタイムから継続コールバックメソッドがコールされ擬似応答が処理されます。

Test.invokeContinuationMethod をコールする前に、Test.setContinuationResponse をコールします。Test.invokeContinuationMethod をコールすると、継続に関連付けられたコールバックメソッドがランタイムで実行されます。コールバックメソッドでは、Test.setContinuationResponse で設定された擬似応答が処理されます。

isRunningTest()

現在実行中のコードが、テストメソッドに含まれているコードによってコールされた場合、true を返します。その他の場合は、false を返します。テストからコールされたかどうかに応じて異なるコードを実行する必要がある場合に、このメソッドを使用します。

署名

public static Boolean isRunningTest()

戻り値

型: Boolean

loadData(Schema.SObjectType, String)

指定した静的リソース .csv ファイルから、指定した sObject 型のテストレコードを挿入し、挿入された sObject のリストを返します。

署名

public static List<sObject> loadData(Schema.SObjectType sObjectToken, String resourceName)

パラメータ

sObjectToken
型: Schema.SObjectType
テストレコードを挿入する sObject 型。
resourceName
型: String
読み込むテストレコードを含む .csv ファイルに対応する静的リソース。この名前は大文字と小文字を区別しません。

戻り値

型: List<sObject>

使用方法

このメソッドをコールする前に静的リソースを作成する必要があります。静的リソースは、拡張子が .csv のカンマ区切りファイルです。このファイルにはテストレコードの項目名と値が含まれます。ファイルの最初の行に項目名を含め、2 行目以降に値を含める必要があります。静的リソースについての詳細は、Salesforce オンラインヘルプの「静的リソースの定義」を参照してください。

.csv ファイルの静的リソースを作成したら、その静的リソースに MIME タイプが割り当てられます。次の MIME タイプがサポートされています。
  • text/csv
  • application/vnd.ms-excel
  • application/octet-stream
  • text/plain

setContinuationResponse(String, System.HttpResponse)

テストメソッド内の継続 HTTP 要求に対する疑似応答を設定します。

署名

public static void setContinuationResponse(String requestLabel, System.HttpResponse mockResponse)

パラメータ

requestLabel
型: String
継続 HTTP 要求に対応する一意の表示ラベル。この表示ラベルは Continuation.addHttpRequest によって返されます。
mockResponse
型: HttpResponse
Test.invokeContinuationMethod によって返される擬似応答。

戻り値

型: void

使用方法

継続をテストするには、Test.setContinuationResponse メソッドと Test.invokeContinuationMethod メソッドを使用します。テストコンテキストでは、継続のコールアウトは外部サービスに送信されません。これらのメソッドを使用することで、擬似応答を設定でき、ランタイムから継続コールバックメソッドがコールされ擬似応答が処理されます。

Test.invokeContinuationMethod をコールする前に、Test.setContinuationResponse をコールします。Test.invokeContinuationMethod をコールすると、継続に関連付けられたコールバックメソッドがランタイムで実行されます。コールバックメソッドでは、Test.setContinuationResponse で設定された擬似応答が処理されます。

setCurrentPage(PageReference)

コントローラの現在の PageReference を設定する Visualforce のテストメソッド。

署名

public static Void setCurrentPage(PageReference page)

パラメータ

page
型: System.PageReference

戻り値

型: Void

setCurrentPageReference(PageReference)

コントローラの現在の PageReference を設定する Visualforce のテストメソッド。

署名

public static Void setCurrentPageReference(PageReference page)

パラメータ

page
型: System.PageReference

戻り値

型: Void

setFixedSearchResults(ID[])

固定された検索結果のリストを、テストメソッドで後続のすべての SOSL ステートメントに返されるよう定義します。

署名

public static Void setFixedSearchResults(ID[] opt_set_search_results)

パラメータ

opt_set_search_results
型: ID[]
opt_set_search_results で指定されたレコード ID のリストは、WHERE 句または LIMIT 句に指定されていない場合、通常は SOSL クエリで返される結果を置き換えます。これらの句が SOSL クエリにある場合、固定された検索結果のリストに適用されます。

戻り値

型: Void

使用方法

opt_set_search_results が指定されていない場合、後続のすべての SOSL クエリは結果を返しません。

詳細は、SOSL クエリの単体テストへの追加を参照してください。

setMock(Type, Object)

擬似応答モードを設定し、HTTP クラスまたは WSDL から自動生成されたコードを使用してコールアウトが実行されるたびに擬似応答を送信するように、Apex ランタイムに指示します。

署名

public static Void setMock(Type interfaceType, Object instance)

パラメータ

interfaceType
型: System.Type
instance
型: Object

戻り値

型: Void

使用方法

コールアウトを実行するコードが管理パッケージに含まれる場合、同じパッケージ内のテストメソッドから同じ名前空間を使用して Test.setMock をコールし、擬似コールアウトを行う必要があります。

メモ

setReadOnlyApplicationMode(Boolean)

Salesforce のアップグレードおよびダウンタイム中に参照のみモードをシミュレートするには、Apex テストにおける組織のアプリケーションモードを参照のみに設定します。アプリケーションモードは、Apex テストの各実行が終了するとデフォルトのモードにリセットされます。

署名

public static Void setReadOnlyApplicationMode(Boolean application_mode)

パラメータ

application_mode
型: Boolean

戻り値

型: Void

使用方法

getApplicationReadWriteMode() システムメソッドも参照してください。

DML 例外のシミュレーションなど、参照のみモードのテストに無関係の目的で setReadOnlyApplicationMode を使用しないでください。

次の例では、アプリケーションモードを参照のみに設定し、新しい取引先レコードを挿入しようとしています。結果は例外となります。その後、アプリケーションモードはリセットされ、正しく挿入されます。

startTest()

テストが実際に開始されるときに、テストコードのポイントをマークします。ガバナ制限をテストする場合にこのメソッドを使用します。

署名

public static Void startTest()

戻り値

型: Void

使用方法

stopTest と共にこのメソッドを使用して、startTest メソッドの後のすべての非同期コールが、アサーションまたはテストを実行する前に実行されるようにすることができます。各テストメソッドは、このメソッドを 1 回のみコールできます。このメソッドの前のすべてのコードを、変数の初期化、データ構造の入力などのために使用する必要があります。これにより、テストを実行するために必要なすべてを設定できます。startTest へのコールの後および stopTest の前に実行するコードはすべて、新しいガバナ制限セットが割り当てられます。

stopTest()

テストが終了するときに、テストコードのポイントをマークします。このメソッドは startTest メソッドと組み合わせて使用します。

署名

public static Void stopTest()

戻り値

型: Void

使用方法

各テストメソッドは、このメソッドを 1 回のみコールできます。stopTest メソッドの後に実行するコードはすべて、startTest がコールされる前に有効だった元の制限が割り当てられます。startTest メソッドの後に作成されたすべての非同期コールはシステムによって収集されます。stopTest を実行する場合、すべての非同期プロセスが同期して実行されます。

startTest ブロックおよび stopTest ブロックでコールされた @future または executeBatch などの非同期コールは、キュー内ジョブ数の制限に対してカウントされません。

メモ

testInstall(InstallHandler, Version, Boolean)

パッケージでのインストール後スクリプトの指定に使用される、InstallHandler インターフェースの実装をテストします。テストは、開発環境のテストイニシエータとして実行されます。

署名

public static Void testInstall(InstallHandler installImp, Version ver, Boolean isPush)

パラメータ

installImp
型: System.InstallHandler
InstallHandler インターフェースを実装するクラス
ver
型: System.Version
登録者組織にインストールされた既存パッケージのバージョン番号を指定します。
isPush
型: Boolean
(省略可能) アップグレードがプッシュかどうかを指定します。デフォルト値は、false です。

戻り値

型: Void

使用方法

このメソッドでは、テストのインストールが失敗すると実行時例外が発生します。

testUninstall(UninstallHandler)

パッケージでのアンインストールスクリプトの指定に使用される、UninstallHandler インターフェースの実装をテストします。テストは、開発環境のテストイニシエータとして実行されます。

署名

public static Void testUninstall(UninstallHandler uninstImp)

パラメータ

uninstImp
型: System.UninstallHandler
UninstallHandler インターフェースを実装するクラス

戻り値

型: Void

使用方法

このメソッドでは、テストのアンインストールが失敗すると実行時例外が発生します。