--- sourceDocument: Référence de l’API Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference Release : - xanadu ft:locale : - fr-FR ft:publication_title : - Référence de l’API Xanadu ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # TestUserAPI de l'exécuteur dans le cloud : délimité, global # TestUserAPI de l'exécuteur dans le cloud : délimité, global {#ariaid-title1} * Rversion finale: Xanadu * * Mis à jour 1 août 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 minutes de lecture Gère les tâches de l'utilisateur test à exécuter dans un exécuteur dans le cloud pour Framework de tests automatisés (ATF). Cette API fait partie de l'include de script CloudRunnerApi. Vous pouvez utiliser cette API pour les tâches suivantes : * Démarrez la tâche de test de l'utilisateur. * Définissez l'utilisateur du cloud. * Vérifiez si l'utilisateur spécifié est valide. * Vérifiez la progression de la tâche de test de l'utilisateur. * Annulez la tâche de test. {#cloudrnr-TestUserAPI-scoped__cloudrnr-TestUserAPI-scoped_ul_vwb_wvn_31c} Dans le périmètre global, cette API est exécutée dans l'espace de noms sn_atf_tg. Vous devez avoir activé le module d'extension [ATF Test Generator and Cloud Runner](https://www.servicenow.com/docs/access?context=atf-tg-cr-intro&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) (sn_atf_tg) pour utiliser cette API. Voir aussi : * [TestGenerationAPI de l'exécuteur cloud : champ d'application, global](https://servicenow-prod.fluidtopics.net/Da55eqP7uVI4nut45sw9lg#cloudrnr-TestGenerationAPI-scoped "Gère la génération de tâches de test à exécuter dans un exécuteur dans le cloud pour Framework de tests automatisés (ATF). Cette API fait partie de l’include de script CloudRunnerApi.") * [Cloud Runner TestRunnerAPI : champ d'application, global](https://servicenow-prod.fluidtopics.net/RP~ylShxNLgz0o0yDWmfDA#cloudrnr-TestRunnerAPI-scoped "Gère les tests à exécuter dans un exécuteur dans le cloud pour Framework de tests automatisés (ATF). Cette API fait partie de l’include de script CloudRunnerApi.") * [API REST de test exécutable de l'exécuteur dans le cloud](https://servicenow-prod.fluidtopics.net/lrFtnJbZRIvDuRWaYgl04A#cloudrunner-testrunner-api "Gère les tests à exécuter dans un exécuteur dans le cloud pour Framework de tests automatisés (ATF).") {#cloudrnr-TestUserAPI-scoped__ul_gd4_zsn_31c} ## TestUserApi -- cancelJob(String snboqId) {#ariaid-title2} Définit l'état de la tâche de l'utilisateur test dans la table File d'attente Orchestration du navigateur \[sn_atf_tg_sn_boq\] pour terminer. {#cr-TestUserAPI-cancelJob_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-cancelJob_S__cr-snboqId-ph-desc} | Nom | Type | Description | |-|-|-| | snboqId | Chaîne | Requis. Le sys_id de l'enregistrement BOQ dans la table File d'attente Orchestration du navigateur \[sn_atf_tg_sn_boq\]. | [Tableau 1. Paramètres] {#cr-TestUserAPI-cancelJob_S__table_epx_lv4_g1c} {#cr-TestUserAPI-cancelJob_S__table_fpx_lv4_g1c__entry__2} | Type | Description | |-|-| | null | Nul en cas de réussite, message d'erreur dans le cas contraire. | | Erreur | En cas d'échec, des messages d'erreur sont possibles : * Aucun ID de BOQ transmis : l'objet JSON fourni n'a pas d'entrée d'ID de BOQ. Vérifiez que l'objet JSON est structuré comme `suit : {snboqId : << "}`. * sys_id de nomenclature non valide transmis : l'ID fourni doit correspondre à un enregistrement de nomenclature dans la table File d'attente Orchestration du navigateur \[sn_atf_tg_sn_boq\]. {#cr-TestUserAPI-cancelJob_S__ul_wqr_slb_j1c} | [Tableau 2. Renvoie] {#cr-TestUserAPI-cancelJob_S__table_fpx_lv4_g1c} L'exemple suivant montre comment démarrer un utilisateur test pour l'utilisateur administrateur, obtenir la progression et annuler l'utilisateur test. Après avoir confirmé que l'utilisateur verrouillé est un utilisateur cloud valide, le code définit l'utilisateur cloud comme administrateur ITIL. Dans le champ d'application global, utilisez l'espace de noms 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: })); CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"}); Sortie : {progress: 64, state: running} User is missing the following criteria: User is locked out False ## TestUserApi -- isValidCloudUser (chaîne, nom d'utilisateur) {#ariaid-title3} Vérifie si un utilisateur fourni est un utilisateur cloud valide. {#cr-TestUserAPI-isValidCloudUser_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-isValidCloudUser_S__cr-userNm-ph-desc} | Nom | Type | Description | |-|-|-| | nom d'utilisateur | Objet | Requis. ID d'utilisateur d'un utilisateur valide répertorié dans la table Utilisateurs \[sys_user\]. Cette valeur est fournie sous forme de chaîne dans un objet JSON. Par exemple, `{username : << abel.tuter"}`. | [Tableau 3. Paramètres] {#cr-TestUserAPI-isValidCloudUser_S__table_epx_lv4_g1c} {#cr-TestUserAPI-isValidCloudUser_S__table_fpx_lv4_g1c__entry__2} | Type | Description | |-|-| | Booléen | Marqueur indiquant si l'utilisateur fourni est un utilisateur cloud valide. Valeurs valides : * true : l'utilisateur fourni est un utilisateur cloud valide. * false : l'utilisateur fourni n'est pas valide pour une ou plusieurs des raisons suivantes : * L'utilisateur est introuvable. * L'utilisateur est inactif. * L'utilisateur est verrouillé. * L'utilisateur a besoin d'une réinitialisation du mot de passe. * L'utilisateur n'a pas de rôle administrateur. * L'utilisateur dispose d'un accès en lecture seule. * L'utilisateur dispose d'un accès uniquement aux services Web. {#cr-TestUserAPI-isValidCloudUser_S__ul_gzz_dcg_m1c} {#cr-TestUserAPI-isValidCloudUser_S__ul_ofc_wzf_m1c} | [Tableau 4. Renvoie] {#cr-TestUserAPI-isValidCloudUser_S__table_fpx_lv4_g1c} L'exemple suivant montre comment démarrer un utilisateur test pour l'utilisateur administrateur, obtenir la progression et annuler l'utilisateur test. Après avoir confirmé que l'utilisateur verrouillé est un utilisateur cloud valide, le code définit l'utilisateur cloud comme administrateur ITIL. Dans le champ d'application global, utilisez l'espace de noms 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: })); CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"}); Sortie : {progress: 64, state: running} User is missing the following criteria: User is locked out False ## TestUserApi -- progress(String snboqId) {#ariaid-title4} Fournit l'état de chaque test utilisateur pour un enregistrement fourni de file d'attente Orchestration du navigateur (BOQ). {#cr-TestUserAPI-progress_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-progress_S__cr-snboqId-ph-desc} | Nom | Type | Description | |-|-|-| | snboqId | Chaîne | Requis. Le sys_id de l'enregistrement BOQ dans la table File d'attente Orchestration du navigateur \[sn_atf_tg_sn_boq\]. | [Tableau 5. Paramètres] {#cr-TestUserAPI-progress_S__table_epx_lv4_g1c} {#cr-TestUserAPI-progress_S__table_fpx_lv4_g1c__entry__2}{#cr-TestUserAPI-progress_S__cr-prog-state-ph-desc} | Type | Description | |-|-| | Objet | Objet JSON indiquant la progression du test. { "progress": Number, "state": "String" } | | Objet.progrès | Indique le pourcentage de progression du test terminé. Type : nombre | | Objet.État | État de l'enregistrement de la nomenclature. Valeurs possibles : * En attente : l'activité de test demandée a été créée et attend d'être exécutée.{#cr-TestUserAPI-progress_S__cr-prog-state-li-pending} {#cr-TestUserAPI-progress_S__cr-prog-state-li-pending} * Traitement : l'instance recherche les enregistrements pour s'assurer que les suivis des exécutions sont marqués pour l'exécuteur dans le cloud avant que la demande ne soit envoyée à l'infrastructure dans le cloud. * Navigateurs demandés : une demande a été envoyée à l'infrastructure dans le cloud pour démarrer les navigateurs pour la génération ou l'exécution de tests.{#cr-TestUserAPI-progress_S__cr-prog-state-li-brsreq} {#cr-TestUserAPI-progress_S__cr-prog-state-li-brsreq} * En cours d'exécution : les navigateurs d'infrastructure cloud trouvent et exécutent les tests en attente. * Terminée : la tâche de test est terminée.{#cr-TestUserAPI-progress_S__cr-prog-state-li-complete} {#cr-TestUserAPI-progress_S__cr-prog-state-li-complete} * État d'échec : échec de la tâche de test.{#cr-TestUserAPI-progress_S__cr-prog-state-li-failed} {#cr-TestUserAPI-progress_S__cr-prog-state-li-failed} {#cr-TestUserAPI-progress_S__ul_rvl_vsg_l1c} Type : chaîne | | Erreur | En cas d'échec, des messages d'erreur sont possibles : * Aucun ID de BOQ transmis : l'objet JSON fourni n'a pas d'entrée d'ID de BOQ. Vérifiez que l'objet JSON est structuré comme `suit : {snboqId : << "}`. * sys_id de nomenclature non valide transmis : l'ID fourni doit correspondre à un enregistrement de nomenclature dans la table File d'attente Orchestration du navigateur \[sn_atf_tg_sn_boq\]. {#cr-TestUserAPI-progress_S__ul_wqr_slb_j1c} | [Tableau 6. Renvoie] {#cr-TestUserAPI-progress_S__table_fpx_lv4_g1c} L'exemple suivant montre comment démarrer un utilisateur test pour l'utilisateur administrateur, obtenir la progression et annuler l'utilisateur test. Après avoir confirmé que l'utilisateur verrouillé est un utilisateur cloud valide, le code définit l'utilisateur cloud comme administrateur ITIL. Dans le champ d'application global, utilisez l'espace de noms 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: })); CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"}); Sortie : {progress: 64, state: running} User is missing the following criteria: User is locked out False ## TestUserApi -- selectCloudUser (nom d'utilisateur de chaîne) {#ariaid-title5} Démarre une tâche d'utilisateur test de bout en bout sur l'exécuteur dans le cloud. Si l'utilisateur parvient à se connecter correctement avec le rôle administrateur, la propriété d'utilisateur dans le cloud est définie comme cet utilisateur pour les futures exécutions de tests et générations de tests sur l'infrastructure d'exécution dans le cloud. {#cr-TestUserAPI-selectCloudUser_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-selectCloudUser_S__cr-userNm-ph-desc} | Nom | Type | Description | |-|-|-| | nom d'utilisateur | Objet | Requis. ID d'utilisateur d'un utilisateur valide répertorié dans la table Utilisateurs \[sys_user\]. Cette valeur est fournie sous forme de chaîne dans un objet JSON. Par exemple, `{username : << abel.tuter"}`. | [Tableau 7. Paramètres] {#cr-TestUserAPI-selectCloudUser_S__table_epx_lv4_g1c} {#cr-TestUserAPI-selectCloudUser_S__table_fpx_lv4_g1c__entry__2} | Type | Description | |-|-| | Zéro | Nul en cas de réussite. Message d'erreur sinon. Impossible de définir l'utilisateur du cloud en tant qu'utilisateur du cloud non valide : cette erreur indique que l'utilisateur fourni n'est pas valide pour une ou plusieurs des raisons suivantes : * L'utilisateur est introuvable. * L'utilisateur est inactif. * L'utilisateur est verrouillé. * L'utilisateur a besoin d'une réinitialisation du mot de passe. * L'utilisateur n'a pas de rôle administrateur. * L'utilisateur dispose d'un accès en lecture seule. * L'utilisateur dispose d'un accès uniquement aux services Web. {#cr-TestUserAPI-selectCloudUser_S__ul_gzz_dcg_m1c} | [Tableau 8. Renvoie] {#cr-TestUserAPI-selectCloudUser_S__table_fpx_lv4_g1c} L'exemple suivant montre comment démarrer un utilisateur test pour l'utilisateur administrateur, obtenir la progression et annuler l'utilisateur test. Après avoir confirmé que l'utilisateur verrouillé est un utilisateur cloud valide, le code définit l'utilisateur cloud comme administrateur ITIL. Dans le champ d'application global, utilisez l'espace de noms 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: })); CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"}); Sortie : {progress: 64, state: running} User is missing the following criteria: User is locked out False ## TestUserApi -- startJob (chaîne, nom d'utilisateur) {#ariaid-title6} Démarre une tâche d'utilisateur de test de bout en bout sur l'exécuteur dans le cloud. {#cr-TestUserAPI-startJob_S__table_epx_lv4_g1c__entry__3} | Nom | Type | Description | |-|-|-| | nom d'utilisateur | Chaîne | Requis. Nom d'utilisateur du sys_user pour tester l'infrastructure de bout en bout de l'exécuteur dans le cloud. | [Tableau 9. Paramètres] {#cr-TestUserAPI-startJob_S__table_epx_lv4_g1c} {#cr-TestUserAPI-startJob_S__table_fpx_lv4_g1c__entry__2} | Type | Description | |-|-| | Chaîne | Le sys_id de l'enregistrement BOQ dans la table File d'attente Orchestration du navigateur \[sn_atf_tg_sn_boq\]. | [Tableau 10. Renvoie] {#cr-TestUserAPI-startJob_S__table_fpx_lv4_g1c} L'exemple suivant montre comment démarrer un utilisateur test pour l'utilisateur administrateur, obtenir la progression et annuler l'utilisateur test. Après avoir confirmé que l'utilisateur verrouillé est un utilisateur cloud valide, le code définit l'utilisateur cloud comme administrateur ITIL. Dans le champ d'application global, utilisez l'espace de noms 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: })); CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"}); Sortie : {progress: 64, state: running} User is missing the following criteria: User is locked out False