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

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：7分

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

    この API は、次のタスクに使用できます。
    • テスト生成ジョブを開始します。
    • テスト生成ジョブの進行状況を確認します。
    • テスト生成ジョブをキャンセルします。

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

    関連項目：

    TestGenerationApi – cancelJob(String snboqId)

    テスト生成ジョブとそれに関連する更新セットレコードを完了ステータスに設定します。実行中の生成されたすべてのテストのルートトラッカーをキャンセルします。キャンセル時にテストジョブが進行中の場合、このメソッドは生成された進行中のテストレコードをスキップに設定します。

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

    次の例は、インシデントテーブルのテストの生成を開始し、テストの生成をキャンセルする方法を示しています。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var insertedSnboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
  tableEncodedQuery: "nameISincident",
  catalogEncodedQuery: "sysIdISEMPTY",
  maxTestCount: 10
});

CloudRunnerAPI.TestGenerationAPI.cancelJob({snboqId: insertedSnboqId});

    TestGenerationApi – progress(文字列 snboqId)

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

    表 : 3. パラメーター
    名前 タイプ 説明
    snboqId 文字列 必須。ブラウザオーケストレーションキュー [sn_atf_tg_sn_boq] テーブルの BOQ レコードのsys_id。
    表 : 4. 返される内容
    タイプ 説明
    オブジェクト テストジョブに関する情報。高度なテストの詳細は、生成されたテスト [sn_atf_tg_generated_test] テーブルで確認できます。
    {
  "testsFailed": Number,
  "testsInProgress": Number,
  "testsPending": Number,
  "testsSkipped": Number,
  "testsSucceeded": Number
}
    テスト失敗 生成された失敗したテストの数。失敗の理由は、生成されたテスト [sn_atf_tg_generated_test] テーブルに一覧表示されます。

    データタイプ：数値
    テスト進行中 作成されるユースケースの数。

    データタイプ：数値
    テスト保留中 生成する残りのユースケースの数。

    データタイプ：数値
    テストのスキップ ジョブのキャンセルによりスキップされたテストの数。

    データタイプ：数値
    テスト成功 正常に生成されたテストの数。

    データタイプ：数値

    次の例は、インシデントテーブルのテストの生成を開始し、進捗状況を取得して、テストの生成をキャンセルする方法を示しています。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
  "tableEncodedQuery": "nameISincident",
  "catalogEncodedQuery": "sysIdISEMPTY",
  "maxTestCount": 10
});

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

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

    出力:

    {
  "testsSucceeded": 4,
  "testsFailed": 2,
  "testsPending": 2,
  "testsInProgress": 8,
  "testsSkipped": 0
}

    TestGenerationApi – startJob(String tableEncodedQuery, String userEncodedQuery, String catalogEncodedQuery, Number maxTestCount, Number maxTestCountPerTable, Number maxTestCountPerItem, String email)

    ブラウザーオーケストレーションキュー (BOQ) [sn_atf_tg_sn_boq] テーブルにレコードを挿入して、テストジョブを開始します。

    表 : 5. パラメーター
    名前 タイプ 説明
    カタログエンコードクエリ 文字列 オプション。テストを生成するカタログアイテム (CI) を指定するエンコードクエリ。

    デフォルト:すべての CI (空の文字列)
    メール 文字列 オプション。テストの生成が完了したときに通知を送信するメールアドレス。

    デフォルト:メールなし (空の文字列)
    最大テスト数 [Number (番号)] オプション。生成するテストの最大数。

    可能な値:1 〜 9999

    デフォルト:9999 (最大値)
    maxTestCountPerTable [Number (番号)] オプション。テーブルごとに生成するテストの最大数。

    可能な値:1 〜 10

    デフォルト:10 (最大値)
    アイテムごとの最大テスト数 [Number (番号)] オプション。CI ごとに生成するテストの最大数。

    可能な値:1 〜 10

    デフォルト:10 (最大値)
    separateUpdateSetPerScope ブール

    オプション。生成されたテストをそれぞれのスイート、更新セット、およびスコープに分割するか、またはテストを 1 つのスイート、更新セット、およびスコープに配置するかを示すフラグ。

    有効な値：
    • true:テストは、各テーブルまたはカタログアイテムのスコープに従って、それぞれのスイートと更新セットに配置されます。
    • false:生成されたすべてのテストは、同じスイート、更新セット、およびスコープに配置されます。false の場合、要求に scopeForGeneratingTests が必要です。

    デフォルト：true
    scopeForGeneratingTest 文字列 separateUpdateSetPerScope が false に設定されている場合は必須です。生成されたすべてのテストを配置するスコープのSys_id。

    デフォルト:sys_idなし (空の文字列)
    テーブルエンコードクエリ 文字列 オプション。テストを生成するテーブルを指定するエンコードされたクエリ。「Encoded query strings」を参照してください。

    デフォルト:すべてのテーブル (空の文字列)
    userEncodedQuery 文字列 オプション。テストを生成するユーザーを指定するエンコードされたクエリ。

    デフォルト:すべてのユーザー (空の文字列)
    表 : 6. 戻り値
    タイプ 説明
    文字列 ブラウザオーケストレーションキュー [sn_atf_tg_sn_boq] テーブルの BOQ レコードのsys_id。

    次の例は、インシデントテーブルのテストの生成を開始する方法を示しています。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var insertedSnboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
  tableEncodedQuery: "nameISincident",
  catalogEncodedQuery: "sysIdISEMPTY",
  maxTestCount: 10
});

gs.info(insertedSnboqId);

    出力:

    <sys_id of inserted BOQ record>