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

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

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

    この API は、次のタスクに使用できます。
    • ユーザーテストジョブを開始します。
    • クラウドユーザーを設定します。
    • 指定されたユーザーが有効かどうかを確認します。
    • ユーザーテストジョブの進行状況を確認します。
    • テストジョブをキャンセルします。

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

    関連項目：

    TestUserApi – cancelJob(文字列 snboqId)

    ブラウザオーケストレーションキュー [sn_atf_tg_sn_boq] テーブルのテストユーザージョブステータスを完了に設定します。

    表 : 1. パラメーター
    名前 タイプ 説明
    snboqId 文字列 必須。ブラウザオーケストレーションキュー [sn_atf_tg_sn_boq] テーブル内の BOQ レコードのsys_id。
    表 : 2. 戻り値
    タイプ 説明
    null 成功した場合は null、それ以外の場合はエラーメッセージ。
    エラー 失敗した場合、次のエラーメッセージが表示される可能性があります。
    • BOQ ID が渡されていません – 指定された JSON オブジェクトに BOQ ID エントリがありません。JSON オブジェクトが {snboqId: "<sys_id>"} として構造化されていることを確認します。
    • 無効な BOQ sys_id が渡されました:指定された ID は、ブラウザオーケストレーションキュー [sn_atf_tg_sn_boq] テーブルの BOQ レコードの ID である必要があります。

    次の例は、admin ユーザーのテストユーザーを開始し、進捗状況を取得して、テストユーザーをキャンセルする方法を示しています。ロックアウトされたユーザーが有効なクラウドユーザーであることを確認した後、コードはクラウドユーザーを ITIL アドミニストレーターとして設定します。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

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

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    出力：

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False

    TestUserApi – isValidCloudUser(文字列 username)

    指定されたユーザーが有効なクラウドユーザーであるかどうかを確認します。

    表 : 3. パラメーター
    名前 タイプ 説明
    ユーザー名 オブジェクト 必須。ユーザー [sys_user] テーブルにリストされている有効なユーザーのユーザー ID。この値は、JSON オブジェクトで文字列として提供されます。例: {username: "abel.tuter"}。
    表 : 4. 戻り値
    タイプ 説明
    ブール

    指定されたユーザーが有効なクラウドユーザーであるかどうかを示すフラグ。

    有効な値：
    • true:指定されたユーザーは有効なクラウドユーザーです。
    • false:指定されたユーザーは、次の 1 つ以上の理由で無効です。
      • ユーザーが見つかりませんでした。
      • ユーザーは非アクティブです。
      • ユーザーはロックアウトされています。
      • ユーザーはパスワードリセットが必要です。
      • ユーザーに admin ロールがありません。
      • ユーザーには読み取り専用アクセス権があります。
      • ユーザーは Web サービスのみにアクセスできます。

    次の例は、admin ユーザーのテストユーザーを開始し、進捗状況を取得して、テストユーザーをキャンセルする方法を示しています。ロックアウトされたユーザーが有効なクラウドユーザーであることを確認した後、コードはクラウドユーザーを ITIL アドミニストレーターとして設定します。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

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

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    出力：

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False

    TestUserApi – progress(文字列 snboqId)

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

    表 : 5. パラメーター
    名前 タイプ 説明
    snboqId 文字列 必須。ブラウザオーケストレーションキュー [sn_atf_tg_sn_boq] テーブル内の BOQ レコードのsys_id。
    表 : 6. 戻り値
    タイプ 説明
    オブジェクト テストの進行状況を示す 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 である必要があります。

    次の例は、admin ユーザーのテストユーザーを開始し、進捗状況を取得して、テストユーザーをキャンセルする方法を示しています。ロックアウトされたユーザーが有効なクラウドユーザーであることを確認した後、コードはクラウドユーザーを ITIL アドミニストレーターとして設定します。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

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

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    出力：

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False

    TestUserApi – selectCloudUser(文字列username)

    クラウドランナーでエンドツーエンドのテストユーザージョブを開始します。ユーザーが admin ロールで正しくログインできる場合、クラウドランナーインフラストラクチャでの今後のテスト実行およびテスト生成に対して、クラウドユーザープロパティがこのユーザーとして設定されます。

    表 : 7. パラメーター
    名前 タイプ 説明
    ユーザー名 オブジェクト 必須。ユーザー [sys_user] テーブルにリストされている有効なユーザーのユーザー ID。この値は、JSON オブジェクトで文字列として提供されます。例: {username: "abel.tuter"}。
    表 : 8. 戻り値
    タイプ 説明
    Null 成功した場合は null。それ以外の場合はエラーメッセージ。
    クラウドユーザーをクラウドユーザーとして設定できません (Unable to set cloud user as cloud user not valid ) – このエラーは、指定されたユーザーが次の 1 つ以上の理由で無効であることを示します。
    • ユーザーが見つかりませんでした。
    • ユーザーは非アクティブです。
    • ユーザーはロックアウトされています。
    • ユーザーはパスワードリセットが必要です。
    • ユーザーに admin ロールがありません。
    • ユーザーには読み取り専用アクセス権があります。
    • ユーザーは Web サービスのみにアクセスできます。

    次の例は、admin ユーザーのテストユーザーを開始し、進捗状況を取得して、テストユーザーをキャンセルする方法を示しています。ロックアウトされたユーザーが有効なクラウドユーザーであることを確認した後、コードはクラウドユーザーを ITIL アドミニストレーターとして設定します。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

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

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    出力：

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False

    TestUserApi – startJob(文字列 username)

    クラウドランナーでエンドツーエンドのテストユーザージョブを開始します。

    表 : 9. パラメーター
    名前 タイプ 説明
    ユーザー名 文字列 必須。クラウドランナーのエンドツーエンドインフラストラクチャをテストするsys_userのユーザー名。
    表 : 10. 戻り値
    タイプ 説明
    文字列 ブラウザオーケストレーションキュー [sn_atf_tg_sn_boq] テーブル内の BOQ レコードのsys_id。

    次の例は、admin ユーザーのテストユーザーを開始し、進捗状況を取得して、テストユーザーをキャンセルする方法を示しています。ロックアウトされたユーザーが有効なクラウドユーザーであることを確認した後、コードはクラウドユーザーを ITIL アドミニストレーターとして設定します。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

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

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    出力：

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False