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 ATF Test Generator and Cloud Runner Plugin (sn_atf_tg). Die mit dieser API verfügbaren Methoden werden in ausgeführt Jetzt Namespace und kann mit API-Name aufgerufen werden, Ein-Klick-Regressionstests für ATF , Im REST API Explorer. Für den Zugriff auf diese API ist die Administratorrolle erforderlich.
- Starten Sie eine ATF-Test- oder -Test-Suite im Cloud Runner-Browser.
- Überprüfen Sie den Fortschritt des Testauftrags.
- Brechen Sie den Testauftrag ab.
Die Cloud Runner Test Runner API kann zusammen mit verwendet werden Cloud Runner-Testgenerierungs-REST-API Und Cloud Runner-Test-Anwender-REST-API. Sie können beispielsweise einen Test generieren (Cloud Runner Test Generation API), dann den Fortschritt des Tests in der Browser-Orchestration-Warteschlange (Cloud Runner TEST Generation API) abrufen und die Anzahl der bestandenen oder fehlgeschlagenen Tests überprüfen.
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
Gibt den Status jedes ausgeführten Tests für einen angegebenen BOQ-Datensatz (Browser Orchestration Queue) an.
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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Der Fortschritt des BOQ-Auftrags wurde erfolgreich abgerufen. |
| 400 | Fehler beim Abrufen des BOQ-Datensatzstatus. Gibt eine der folgenden Nachrichten zurück:
|
| 403 | Fehler beim Gewähren des Anwenderzugriffs auf den Endpunkt. Stellen Sie sicher, dass der Anwender über die Administratorrolle verfügt. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt mit den Fortschrittsergebnissen des Test Runner-Auftrags oder einer Meldung, die erklärt, warum die Anforderung fehlgeschlagen ist. Datentyp: Objekt Oder: |
| Ergebnis.Nachricht | Fehlermeldung, die angibt, 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 vor dem Abschluss eines Tests steht, während er ausgeführt wird. Datentyp: Zahl |
| Ergebnis.Status | Aktueller Status des BOQ-Datensatzes. Mögliche Werte:
Datentyp: Zeichenfolge |
cURL-Anforderung
Die folgende Anforderung ruft den Fortschritt des Test Runner-Auftrags 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"
}
}Das folgende Beispiel gibt eine Fehlermeldung 400 zurück, 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"
}
}Das folgende Beispiel gibt eine Fehlermeldung 400 zurück, 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 |
| Inhaltstyp | 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 REST API-HTTP-Antwortcodes .
| 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. Stellen Sie sicher, dass der Anwender über die Administratorrolle verfügt. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält.Datentyp: Objekt |
| Ergebnis.Nachricht | Nachricht, die angibt, ob der Testabbruch erfolgreich war. Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Beispiel zeigt, wie eine Anforderung zum Abbrechen des Testlaufs gemäß 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: VERÖFFENTLICHEN SIE /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 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 |
| Inhaltstyp | 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Ein Test Runner-BOQ-Auftrag wurde erfolgreich 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. Stellen Sie sicher, dass der Anwender über die Administratorrolle verfügt. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält. Datentyp: Objekt Oder: |
| Ergebnis.snboqId | SYS_ID des BOQ-Datensatzes, der beim Start des Test Runners eingefügt wird. Datentyp: Zeichenfolge Tabelle: BOQ [sn_atf_tg_sn_boq] |
| Ergebnis.Nachricht | Fehlermeldung, die angibt, warum der Test Runner nicht gestartet werden kann. Datentyp: Zeichenfolge |
cURL-Anforderung
Die folgende Anforderung fügt einen Test Runner-Auftrag in die Tabelle „BOQ“ [sn_atf_tg_sn_boq] ein.
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>"
}
}