--- 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 --- # Cloud Runner TestRunnerAPI : champ d'application, global # Cloud Runner TestRunnerAPI : champ d'application, global {#ariaid-title1} * Rversion finale: Xanadu * * Mis à jour 1 août 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes de lecture 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. Vous pouvez utiliser cette API pour les tâches suivantes : * Démarrez un test ATF ou une suite de tests dans le navigateur Cloud Runner. * Vérifiez la progression de la tâche de test. * Annulez la tâche de test. {#cloudrnr-TestRunnerAPI-scoped__cloudrnr-TestRunnerAPI-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.") * [TestUserAPI de l'exécuteur dans le cloud : délimité, global](https://servicenow-prod.fluidtopics.net/fG_00zkvb3lrJnKxtgmoog#cloudrnr-TestUserAPI-scoped "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.") * [API REST de l'utilisateur test de l'exécuteur dans le cloud](https://servicenow-prod.fluidtopics.net/NZcWhnv_11ZWmrNp7fooZg#cloudrunner-testuser-api "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).") {#cloudrnr-TestRunnerAPI-scoped__ul_gd4_zsn_31c} ## TestRunnerApi -- cancelJob(String snboqId) {#ariaid-title2} Définit la tâche du test exécutable sur l'état Terminé et annule les suivis racine de tous les tests générés en cours d'exécution. {#cr-TestRunnerAPI-cancelJob_S__table_epx_lv4_g1c__entry__3}{#cr-TestRunnerAPI-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-TestRunnerAPI-cancelJob_S__table_epx_lv4_g1c} {#cr-TestRunnerAPI-cancelJob_S__table_fpx_lv4_g1c__entry__2} | Type | Description | |-|-| | null | Nul en cas de réussite, message d'erreur dans le cas contraire. | [Tableau 2. Renvoie] {#cr-TestRunnerAPI-cancelJob_S__table_fpx_lv4_g1c} L'exemple suivant montre comment démarrer un test, exécuter un test ATF, afficher la progression et arrêter l'exécution du test. Dans le champ d'application global, utilisez l'espace de noms sn_atf_tg. var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({ "testId": "" }); gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId}))); CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId}); Sortie : {progress: 64, state: running} ## TestRunnerApi -- progress(String snboqId) {#ariaid-title3} Fournit l'état de chaque test exécuté pour un enregistrement de file d'attente Orchestration du navigateur (BOQ) fourni. {#cr-TestRunnerAPI-progress_S__table_epx_lv4_g1c__entry__3}{#cr-TestRunnerAPI-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 3. Paramètres] {#cr-TestRunnerAPI-progress_S__table_epx_lv4_g1c} {#cr-TestRunnerAPI-progress_S__table_fpx_lv4_g1c__entry__2}{#cr-TestRunnerAPI-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-TestRunnerAPI-progress_S__cr-prog-state-li-pending} {#cr-TestRunnerAPI-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-TestRunnerAPI-progress_S__cr-prog-state-li-brsreq} {#cr-TestRunnerAPI-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-TestRunnerAPI-progress_S__cr-prog-state-li-complete} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-complete} * État d'échec : échec de la tâche de test.{#cr-TestRunnerAPI-progress_S__cr-prog-state-li-failed} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-failed} {#cr-TestRunnerAPI-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-TestRunnerAPI-progress_S__ul_wqr_slb_j1c} | [Tableau 4. Renvoie] {#cr-TestRunnerAPI-progress_S__table_fpx_lv4_g1c} L'exemple suivant montre comment démarrer un test, exécuter un test ATF, afficher la progression et arrêter l'exécution du test. Dans le champ d'application global, utilisez l'espace de noms sn_atf_tg. var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({ "testId": "" }); gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId}))); CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId}); Sortie : {progress: 64, state: running} ## TestRunnerApi -- startJob(String testId) {#ariaid-title4} Démarre un test ATF ou une suite de tests sur le navigateur Cloud Runner. {#cr-TestRunnerAPI-startJob_S__table_epx_lv4_g1c__entry__3} | Nom | Type | Description | |-|-|-| | ID test | Chaîne | Requis. La sys_id du test ATF ou de la suite de tests à exécuter dans le navigateur de l'exécuteur dans le cloud. Situé dans l'une des tables suivantes : * Test \[sys_atf_test\] * Suites de tests \[sys_atf_test_suite\] {#cr-TestRunnerAPI-startJob_S__ul_gqc_yj4_l1c} | [Tableau 5. Paramètres] {#cr-TestRunnerAPI-startJob_S__table_epx_lv4_g1c} {#cr-TestRunnerAPI-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 6. Renvoie] {#cr-TestRunnerAPI-startJob_S__table_fpx_lv4_g1c} L'exemple suivant montre comment démarrer un test, exécuter un test ATF, afficher la progression et arrêter l'exécution du test. Dans le champ d'application global, utilisez l'espace de noms sn_atf_tg. var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({ "testId": "" }); gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId}))); CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId}); Sortie : {progress: 64, state: running}