クラウドランナー TestRunnerApi – スコープ付き、グローバル

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：5分

    • 自動テストフレームワーク (ATF) のクラウドランナーで実行されるテストを管理します。 この API は CloudRunnerApi スクリプトインクルードの一部です。

    この API は、次のタスクに使用できます。
    • クラウドランナーブラウザーで ATF テストまたはテストスイートを開始します。
    • テストジョブの進行状況を確認します。
    • テストジョブをキャンセルします。

    グローバルスコープでは、この API は sn_atf_tg 名前空間内で実行されます。この API を使用するには、 ATF Test Generator and Cloud Runner (sn_atf_tg) プラグインをアクティブ化する必要があります。

    関連項目：

    TestRunnerApi – cancelJob(文字列 snboqId)

    テストランナージョブを完了ステータスに設定し、実行中の生成されたすべてのテストのルートトラッカーをキャンセルします。

    表 : 1. パラメーター
    名前 タイプ 説明
    snboqId 文字列 必須。ブラウザオーケストレーションキュー [sn_atf_tg_sn_boq] テーブルの BOQ レコードのsys_id。
    表 : 2. 返される内容
    タイプ 説明
    null 成功した場合は null、そうでない場合はエラーメッセージ。

    次の例は、ATF テストの実行を開始し、進行状況を表示して、テストの実行を停止する方法を示しています。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({
	"testId": "<sys_id>"
});

gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId})));

CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId});

    出力:

    {progress: 64, state: running}

    TestRunnerApi – progress(文字列 snboqId)

    指定されたブラウザオーケストレーションキュー (BOQ) レコードに対して実行された各テストのステータスを提供します。

    表 : 3. パラメーター
    名前 タイプ 説明
    snboqId 文字列 必須。ブラウザオーケストレーションキュー [sn_atf_tg_sn_boq] テーブルの BOQ レコードのsys_id。
    表 : 4. 返される内容
    タイプ 説明
    オブジェクト テストの進行状況を示す JSON オブジェクト。
    {
  "progress": Number,
  "state": "String"
}
    Object.progress テストの進行状況の完了率を示します。

    タイプ：数値
    Object.state BOQ レコードのステータス。
    可能な値：
    • 保留中 – 要求されたテストアクティビティが作成され、実行を待機しています。
    • 処理中 – インスタンスはレコードをスキャンして、要求がクラウドインフラストラクチャに送信される前に、実行トラッカーがクラウドランナー用にマークされていることを確認します。
    • 要求されたブラウザ – テストの生成またはテスト実行のためにブラウザを起動するための要求がクラウドインフラストラクチャに送信されました。
    • 実行中 – クラウドインフラストラクチャブラウザーは、保留中のテストを検索して実行します。
    • 完了:テストタスクが完了しました。
    • 失敗ステータス:テストタスクは失敗しました。

    タイプ：文字列
    エラー 失敗した場合、考えられるエラーメッセージ:
    • BOQ ID が渡されていません:指定された JSON オブジェクトに BOQ ID エントリがありません。JSON オブジェクトが {snboqId: "<sys_id>"} として構造化されていることを確認します。
    • 無効な BOQ sys_id渡されました:指定された ID は、ブラウザオーケストレーションキュー [sn_atf_tg_sn_boq] テーブルの BOQ レコード用である必要があります。

    次の例は、ATF テストの実行を開始し、進行状況を表示して、テストの実行を停止する方法を示しています。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({
	"testId": "<sys_id>"
});

gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId})));

CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId});

    出力:

    {progress: 64, state: running}

    TestRunnerApi – startJob(文字列 testId)

    クラウドランナーブラウザーで ATF テストまたはテストスイートを開始します。

    表 : 5. パラメーター
    名前 タイプ 説明
    テスト ID 文字列 必須。クラウドランナーブラウザで実行する ATF テストまたはテストスイートのsys_id。次のいずれかのテーブルにあります。
    • テスト [sys_atf_test]
    • テストスイート [sys_atf_test_suite]
    表 : 6. 戻り値
    タイプ 説明
    文字列 ブラウザオーケストレーションキュー [sn_atf_tg_sn_boq] テーブルの BOQ レコードのsys_id。

    次の例は、ATF テストの実行を開始し、進行状況を表示して、テストの実行を停止する方法を示しています。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({
	"testId": "<sys_id>"
});

gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId})));

CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId});

    出力:

    {progress: 64, state: running}