クラウドランナー TestRunnerApi:スコープ指定、グローバル

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：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 レコードのステータス。
    可能な値：
    • 保留中:要求されたテストアクティビティが作成され、実行を待機しています。
    • 処理中:インスタンスはレコードをスキャンして、要求がクラウドインフラストラクチャに送信される前に、実行トラッカーがクラウドランナー用にマークされていることを確認します。
    • ブラウザーが要求されました (Browsers requested):テスト生成またはテスト実行のためにブラウザーを起動するための要求がクラウドインフラストラクチャに送信されました。
    • 実行中:クラウドインフラストラクチャブラウザーは、保留中のテストを検索して実行します。
    • 完了:テストタスクが完了しました。
    • [失敗] ステータス - テストタスクが失敗しました。

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

    TestRunnerApi – startJob(文字列 testId)

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

    表 : 5. パラメーター
    名前 タイプ 説明
    testid 文字列 必須。クラウドランナーブラウザーで実行する 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}