Cloud Runner Test Runner REST API
Verwaltet Tests, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden sollen.
Die Cloud Runner Test Runner API erfordert das Plugin ATF Test Generator and Cloud Runner (sn_atf_tg). Die mit dieser API verfügbaren Methoden werden im Now -Namespace ausgeführt und können mit dem API-Namen, Ein-Klick-Regressionstests für ATF, im REST-API-Explorer aufgerufen werden. Für den Zugriff auf diese API ist die Administratorrolle erforderlich.
- 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.
Die Cloud Runner Test Runner API kann zusammen mit REST API für Cloud Runner-Testgenerierung und REST API für Cloud Runner-Testanwenderverwendet werden. Sie können beispielsweise einen Test generieren (Cloud Runner-Testgenerierungs-API), dann den Fortschritt des Tests in der Browser-Orchestrationswarteschlange abrufen (Cloud Runner-TEST-Generierungs-API) und die Anzahl der Tests überprüfen, die bestanden oder fehlgeschlagen sind.
Informationen zum Anzeigen der Server-API-Referenzdokumentation dieser API finden Sie unter Cloud Runner TestRunnerApi – Bereichsbezogen, Global.
Cloud Runner-Test Runner – GET /now/sn_atf_tg/test_runner_progress
Stellt den Status jedes Tests bereit, der für einen angegebenen BOQ-Datensatz (Browser Orchestration Queue) ausgeführt wurde.
URL-Format
Standard-URL: GET /api/now/sn_atf_tg/test_runner_progress
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| snboqId | Erforderlich. Die sys_id des BOQ-Datensatzes des Test-Runner-Auftrags, dessen Fortschritt abgerufen werden soll. Datentyp: Zeichenfolge Tabelle: BOQ [sn_atf_tg_sn_boq] |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Der Fortschritt des BOQ-Auftrags wurde erfolgreich abgerufen. |
| 400 | Fehler beim Abrufen des Status des BOQ-Datensatzes. Gibt eine der folgenden Nachrichten zurück:
|
| 403 | Fehler beim Gewähren des Anwenderzugriffs auf den Endpunkt. Vergewissern Sie sich, dass der Benutzer über die Administratorrolle verfügt. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Fortschrittsergebnisse des Test-Runner-Auftrags oder eine Nachricht enthält, die erklärt, warum die Anforderung fehlgeschlagen ist. Datentyp: Objekt Oder: |
| result.message | Fehlermeldung, in der beschrieben wird, warum der Test Runner-Fortschritt nicht abgerufen werden kann. Der Nachrichtenparameter wird in einer erfolgreichen Antwort nicht zurückgegeben. Datentyp: Zeichenfolge |
| result.progress | Prozentsatz, der angibt, wie kurz der Abschluss eines Tests ist, während er ausgeführt wird. Datentyp: Zahl |
| result.state | Aktueller Status des BOQ-Datensatzes. Mögliche Werte:
Datentyp: Zeichenfolge |
cURL-Anforderung
Die folgende Anforderung ruft den Test Runner-Auftragsfortschritt des BOQ-Datensatzes ab.
curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress?snboqId=<sys_id of SNBOQ record>" \
--request GET \
--header "Accept:application/json" \
--user "username:password"Die Antwort gibt an, dass der Test zu 100 % abgeschlossen ist.
{
"result": {
"progress": 100,
"state": "completed"
}
}Im folgenden Beispiel wird eine Fehlermeldung 400 zurückgegeben, wenn keine BOQ-ID übergeben wird.
curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress" \
--request GET \
--header "Accept:application/json" \
--user "username:password"Antwort:
{
"result": {
"message": "No SNBOQ ID passed in, add snboqId to request body"
}
}Im folgenden Beispiel wird eine Fehlermeldung 400 zurückgegeben, wenn eine ungültige BOQ-ID übergeben wird.
curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress?snboqId=invalid_sys_id" \
--request GET \
--header "Accept:application/json" \
--user "username:password"Antwort:
{
"result": {
"message": "Invalid SNBOQ sys_id passed in"
}
}Cloud Runner Test Runner – POST /now/sn_atf_tg/cancel_test_runner
Legt den Test Runner-Auftrag auf den Status „Abgeschlossen“ fest und bricht die Stammtracker aller generierten Tests ab, die ausgeführt werden.
URL-Format
Standard-URL: GET /now/sn_atf_tg/cancel_test_runner
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| snboqId | Sys_id des BOQ-Datensatzes (Browser Orchestration Queue) (sn_atf_tg_sn_boq), der dem abzubrechenden Test-Runner-Auftrag zugeordnet ist. Datentyp: Zeichenfolge Tabelle: BOQ [sn_atf_tg_sn_boq] |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehler beim Abbrechen des Auftrags. Gibt eine der folgenden Nachrichten zurück:
|
| 403 | Fehler beim Gewähren des Anwenderzugriffs auf den Endpunkt. Vergewissern Sie sich, dass der Benutzer über die Administratorrolle verfügt. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt mit den Ergebnissen der Anforderung.Datentyp: Objekt |
| result.message | Meldung, die beschreibt, ob der Testabbruch erfolgreich war. Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Beispiel zeigt, wie eine Anforderung zum Abbrechen des Test Runners entsprechend der sys_id des BOQ-Datensatzes erstellt wird.
curl "https://instance.service-now.com/api/now/sn_atf_tg/cancel_test_runner" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"snboqId\":\"<sys_id of BOQ record>\"}" \
--user "username:password"Die Antwortnachricht, die angibt, dass der Test Runner erfolgreich abgebrochen wurde.
{
"result": {
"message": "success"
}
} Cloud Runner Test Runner – POST /now/sn_atf_tg/test_runner
Fügt einen Test Runner-Auftrag in die BOQ-Tabelle [sn_atf_tg_sn_boq] für den angegebenen Test oder die angegebene Test-Suite ein, die dann auf dem Cloud Runner ausgeführt wird.
URL-Format
Standard-URL: POST api/now/sn_atf_tg/test_runner
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| testId | Sys_id des Tests [sys_atf_test] oder der Test-Suite [sys_atf_test_suite], der auf dem Cloud Runner ausgeführt werden soll. |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Es wurde erfolgreich ein Test-Runner-BOQ-Auftrag eingefügt. |
| 400 | Fehler beim Starten des Test-Runner-Auftrags. Gibt eine der folgenden Nachrichten zurück:
|
| 403 | Fehler beim Gewähren des Anwenderzugriffs auf den Endpunkt. Vergewissern Sie sich, dass der Benutzer über die Administratorrolle verfügt. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt mit den Ergebnissen der Anforderung. Datentyp: Objekt Oder: |
| result.snboqId | Sys_id des BOQ-Datensatzes, der beim Start des Test Runners eingefügt wird. Datentyp: Zeichenfolge Tabelle: BOQ [sn_atf_tg_sn_boq] |
| result.message | Fehlermeldung, die beschreibt, warum der Test Runner nicht gestartet werden kann. Datentyp: Zeichenfolge |
cURL-Anforderung
Mit der folgenden Anforderung wird ein Test Runner-Auftrag in die Tabelle „BOQ“ [sn_atf_tg_sn_boq] eingefügt.
curl "https://instance.service-now.com/api/now/sn_atf_tg/test_runner" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"testId\":\"<sys_id of ATF test or test suite>\"}" \
--user "username:password"Der Antworttext gibt die sys_id des Test-Runner-Auftrags zurück, der erfolgreich eingefügt wurde.
{
"result": {
"snboqId": "<sys_id of newly inserted SNBOQ record>"
}
}