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

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：5分

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

    この API は、次のタスクに使用できます。
    • Cloud Runner ブラウザーで 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 レコードのステータス。
    可能な値：
    • 保留中 – 要求されたテストアクティビティが作成され、実行を待機しています。
    • 処理中:インスタンスはレコードをスキャンして、リクエストがクラウドインフラストラクチャに送信される前に、実行トラッカーが Cloud Runner 用にマークされていることを確認します。
    • 要求されたブラウザー – テスト生成またはテスト実行のためにブラウザーを起動する要求がクラウドインフラストラクチャに送信されました。
    • 実行中 – クラウドインフラストラクチャのブラウザは、保留中のテストを検出して実行します。
    • 完了 – テストタスクが完了しました。
    • [Failed (失敗)] ステータス – テストタスクが失敗しました。

    タイプ：文字列
    エラー 失敗した場合、考えられるエラーメッセージ:
    • 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)

    Cloud Runner ブラウザーで 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}