--- sourceDocument: Xanadu-API-Referenz sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference Release : - xanadu ft:locale : - de-DE ft:publication_title : - Xanadu-API-Referenz ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Cloud Runner TestRunnerApi -- Bereichsbezogen, Global # Cloud Runner TestRunnerApi -- Bereichsbezogen, Global {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer Verwaltet Tests, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden sollen. Diese API ist Teil der CloudRunnerApi-Skripteinbindung. Sie können diese API für die folgenden Aufgaben verwenden: * Starten Sie einen ATF-Test oder eine ATF-Test-Suite im Cloud Runner-Browser. * Überprüft den Fortschritt des Testauftrags. * Brechen Sie den Testauftrag ab. {#cloudrnr-TestRunnerAPI-scoped__cloudrnr-TestRunnerAPI-scoped_ul_vwb_wvn_31c} Im globalen Bereich wird diese API innerhalb des Namespace sn_atf_tg ausgeführt. Sie müssen das Plugin [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) aktivieren, um diese API verwenden zu können. Siehe auch: * [Cloud Runner TestGenerationApi -- Bereichsbezogen, Global](https://www.servicenow.com/docs/SO3H_yflqAlcG2QIMoqY0w#cloudrnr-TestGenerationAPI-scoped "Verwaltet die Testauftragsgenerierung, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden soll. Diese API ist Teil der CloudRunnerApi-Skripteinbindung.") * [Cloud Runner TestUserApi -- Bereichsbezogen, Global](https://www.servicenow.com/docs/gbDZ~ScrqVPI9I6gaCV0Jg#cloudrnr-TestUserAPI-scoped "Verwaltet Testanwenderaufträge, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden sollen. Diese API ist Teil der CloudRunnerApi-Skripteinbindung.") * [REST API für Cloud Runner-Testanwender](https://www.servicenow.com/docs/pBMj2YlrLniExXfO0cX6pA#cloudrunner-testuser-api "Verwaltet Testanwenderaufträge, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden sollen.") {#cloudrnr-TestRunnerAPI-scoped__ul_gd4_zsn_31c} ## TestRunnerApi -- cancelJob(String snboqId) {#ariaid-title2} Legt den Test Runner-Auftrag auf den Status „Abgeschlossen" fest und bricht die Stammtracker aller generierten Tests ab, die ausgeführt werden. {#cr-TestRunnerAPI-cancelJob_S__table_epx_lv4_g1c__entry__3}{#cr-TestRunnerAPI-cancelJob_S__cr-snboqId-ph-desc} | Name | Typ | Beschreibung | |-|-|-| | snboqId | Zeichenfolge | Erforderlich. Die sys_id des BOQ-Datensatzes in der Tabelle „Browser-Orchestrationswarteschlange" \[sn_atf_tg_sn_boq\]. | [Tabelle : 1. Parameter] {#cr-TestRunnerAPI-cancelJob_S__table_epx_lv4_g1c} {#cr-TestRunnerAPI-cancelJob_S__table_fpx_lv4_g1c__entry__2} | Typ | Beschreibung | |-|-| | Null | NULL bei Erfolg, andernfalls Fehlermeldung. | [Tabelle : 2. Ausgabe] {#cr-TestRunnerAPI-cancelJob_S__table_fpx_lv4_g1c} Das folgende Beispiel zeigt, wie Sie einen Testlauf eines ATF-Tests starten, den Fortschritt anzeigen und den Testlauf stoppen. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg. var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({ "testId": "" }); gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId}))); CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId}); Ausgabe: {progress: 64, state: running} ## TestRunnerApi -- Progress(String snboqId) {#ariaid-title3} Stellt den Status jedes Tests bereit, der für einen angegebenen BOQ-Datensatz (Browser Orchestration Queue) ausgeführt wurde. {#cr-TestRunnerAPI-progress_S__table_epx_lv4_g1c__entry__3}{#cr-TestRunnerAPI-progress_S__cr-snboqId-ph-desc} | Name | Typ | Beschreibung | |-|-|-| | snboqId | Zeichenfolge | Erforderlich. Die sys_id des BOQ-Datensatzes in der Tabelle „Browser-Orchestrationswarteschlange" \[sn_atf_tg_sn_boq\]. | [Tabelle : 3. Parameter] {#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} | Typ | Beschreibung | |-|-| | Objekt | JSON-Objekt, das den Testfortschritt angibt. { "progress": Number, "state": "String" } | | Object.progress | Gibt den abgeschlossenen Prozentsatz des Testfortschritts an. Typ: Nummer | | Objekt.status | Status des BOQ-Datensatzes. Mögliche Werte: * Ausstehend: Die angeforderte Testaktivität wurde erstellt und wartet auf die Ausführung.{#cr-TestRunnerAPI-progress_S__cr-prog-state-li-pending} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-pending} * Wird verarbeitet -- Die Instanz scannt Datensätze, um sicherzustellen, dass die Ausführungstracker für Cloud Runner markiert sind, bevor die Anforderung an die Cloud-Infrastruktur gesendet wird. * Browser angefordert: An die Cloud-Infrastruktur wurde eine Anforderung zum Starten von Browsern für die Testgenerierung oder den Testlauf gesendet.{#cr-TestRunnerAPI-progress_S__cr-prog-state-li-brsreq} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-brsreq} * Wird ausgeführt -- Cloud-Infrastrukturbrowser suchen ausstehende Tests und führen sie aus. * Abgeschlossen: Die Testaufgabe ist abgeschlossen.{#cr-TestRunnerAPI-progress_S__cr-prog-state-li-complete} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-complete} * Status „Fehlgeschlagen" -- Die Testaufgabe ist fehlgeschlagen.{#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} Typ: Zeichenfolge | | Fehler | Falls nicht erfolgreich, mögliche Fehlermeldungen: * Keine BOQ-ID übergeben -- Das angegebene JSON-Objekt hat keinen BOQ-ID-Eintrag. Vergewissern Sie sich, dass das JSON-Objekt wie folgt strukturiert ist: `{snboqId: "`\ "} . * Ungültige BOQ-sys_id übergeben: Die angegebene ID muss für einen BOQ-Datensatz in der Tabelle „Browser-Orchestrationswarteschlange" \[sn_atf_tg_sn_boq\] gelten. {#cr-TestRunnerAPI-progress_S__ul_wqr_slb_j1c} | [Tabelle : 4. Ausgabe] {#cr-TestRunnerAPI-progress_S__table_fpx_lv4_g1c} Das folgende Beispiel zeigt, wie Sie einen Testlauf eines ATF-Tests starten, den Fortschritt anzeigen und den Testlauf stoppen. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg. var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({ "testId": "" }); gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId}))); CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId}); Ausgabe: {progress: 64, state: running} ## TestRunnerApi -- startJob(String testId) {#ariaid-title4} Startet einen ATF-Test oder eine Test-Suite im Cloud Runner-Browser. {#cr-TestRunnerAPI-startJob_S__table_epx_lv4_g1c__entry__3} | Name | Typ | Beschreibung | |-|-|-| | testId | Zeichenfolge | Erforderlich. Die sys_id des ATF-Tests oder der ATF-Test-Suite, der im Cloud Runner-Browser ausgeführt werden soll. Befindet sich in einer der folgenden Tabellen: * Testen \[sys_atf_test\] * Test-Suites \[sys_atf_test_suite\] {#cr-TestRunnerAPI-startJob_S__ul_gqc_yj4_l1c} | [Tabelle : 5. Parameter] {#cr-TestRunnerAPI-startJob_S__table_epx_lv4_g1c} {#cr-TestRunnerAPI-startJob_S__table_fpx_lv4_g1c__entry__2} | Typ | Beschreibung | |-|-| | Zeichenfolge | Die sys_id des BOQ-Datensatzes in der Tabelle „Browser-Orchestrationswarteschlange" \[sn_atf_tg_sn_boq\]. | [Tabelle : 6. Ergebnisse] {#cr-TestRunnerAPI-startJob_S__table_fpx_lv4_g1c} Das folgende Beispiel zeigt, wie Sie einen Testlauf eines ATF-Tests starten, den Fortschritt anzeigen und den Testlauf stoppen. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg. var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({ "testId": "" }); gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId}))); CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId}); Ausgabe: {progress: 64, state: running}