Cloud Runner-Testgenerierungs-REST-API
Verwaltet die Generierung von Testaufträgen, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden soll.
Die Cloud Runner-Testgenerierung 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 den Testgenerierungsauftrag.
- Überprüfen Sie den Fortschritt des Testgenerierungsauftrags.
- Brechen Sie den Testgenerierungsauftrag ab.
Die Cloud Runner-Testgenerierung API kann zusammen mit verwendet werden Cloud Runner Test Runner REST API Und Cloud Runner-Test-Anwender-REST-API. Sie können beispielsweise die Testgenerierungs-API aufrufen, um einen Test auszuführen und dann den Fortschritt des Tests in der Browser-Orchestration-Warteschlange (Cloud Runner-TESTGENERIERUNGS-API) abzurufen, und dann die Anzahl der bestandenen oder fehlgeschlagenen Tests überprüfen.
Informationen zum Anzeigen der Server-API-Referenzdokumentation dieser API finden Sie unter Cloud Runner TestGenerationApi: Bereichsbezogen, Global.
Cloud Runner-Testgenerierung – GET /now/sn_atf_tg/Test_Generation_Progress
Stellt den Status jedes generierten Tests für einen bereitgestellten BOQ-Datensatz (Browser Orchestration Queue) bereit.
URL-Format
Standard-URL: GET /api/now/sn_atf_tg/Test_Generation_Progress
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| SnboqId | Erforderlich. Die sys_ID des BOQ-Datensatzes des Testgenerierungsauftrags, 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, das die Fortschrittsergebnisse des generierten Testauftrags enthält, oder eine Meldung, die erklärt, warum die Anforderung fehlgeschlagen ist. Datentyp: Objekt Oder: |
| Ergebnis.Nachricht | Fehlermeldung, die angibt, warum der Fortschritt der Testgenerierung nicht abgerufen werden kann. Der Nachrichtenparameter wird in einer erfolgreichen Antwort nicht zurückgegeben. Datentyp: Zeichenfolge |
| Ergebnis.Testserfolgreich | Anzahl der generierten Tests, die bestanden haben. Datentyp: Zahl |
| Ergebnis.TestsFehlgeschlagen | Anzahl der generierten Tests, die fehlgeschlagen sind. Datentyp: Zahl |
| Ergebnis.TestenAusstehend | Anzahl der Anwendungsfälle, die auf generierte Tests warten. Datentyp: Zahl |
| Ergebnis.TestinProgress | Anzahl der Anwendungsfälle, für die Tests erstellt werden. Datentyp: Zahl |
| Ergebnis.TestsÜbersprungen | Anzahl der Tests, die aufgrund des Auftragsabbruchs übersprungen wurden. Datentyp: Zahl |
cURL-Anforderung
Der folgende GET-Aufruf gibt Fortschrittsinformationen zu generierten Tests zurück, die der snboqId 1234 zugeordnet sind.
curl "https://instance.service-now.com/api/now/sn_atf_tg/test_generation_progress?snboqId=1234" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"Ausgabe:
{
"result": {
"testsSucceeded": 0,
"testsFailed": 0,
"testsPending": 0,
"testsInProgress": 0,
"testsSkipped": 161
}
}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_generation_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_generation_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-Testgenerierung – POST /now/sn_atf_tg/Cancel_Test_Generation
Legt den Testgenerierungsauftrag und den zugehörigen Update-Satz-Datensatz auf den Status „Abgeschlossen“ fest. Bricht die Stammtracker aller generierten Tests ab, die ausgeführt werden. Wenn beim Abbrechen Testaufträge ausgeführt werden, legt diese Methode einen der generierten in Bearbeitung befindlichen Testdatensätze auf „Übersprungen“ fest.
Tests können aufgrund von Business-Regeln oder Zugriffssteuerungsregeln (ACL)-Problemen fehlschlagen oder automatisch abgebrochen werden. Zeigen Sie die generierte Testtabelle an, um weitere Details zu fehlgeschlagenen oder abgebrochenen Tests zu erhalten.
URL-Format
Standard-URL: POST /api/now/sn_atf_tg/Cancel_Test_Generation
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| SnboqId | Erforderlich. SYS_ID des Datensatzes der Browser Orchestration Queue (BOQ), der abgebrochen werden soll. 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 | Der BOQ-Auftrag wurde erfolgreich abgebrochen. |
| 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 Stornierungsanforderung enthält. Datentyp: Objekt |
| Ergebnis.Nachricht | Nachricht, die angibt, ob der Testabbruch erfolgreich war. Datentyp: Zeichenfolge |
cURL-Anforderung
Die folgende Anforderung bricht den Testgenerierungsauftrag eines angegebenen BOQ-Datensatzes ab.
curl "http://instance.service-now.com/api/now/sn_atf_tg/cancel_test_generation" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"snboqId\":\"<sys_id of BOQ record>\"}" \
--user "username":"password"Der Antworttext gibt eine Erfolgsmeldung des Abbruchs zurück.
{
"result": {
"message": "success"
}
}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/cancel_test_generation" \
--request POST \
--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/cancel_test_generation" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"snboqId\":\"invalid_sys_id\"}" \
--user "username":"password"Antwort:
{
"result": {
"message": "No SNBOQ ID passed in, add snboqId to request body"
}
}Cloud Runner-Testgenerierung – POST /now/sn_atf_tg/Test_Generation
Fügt einen Datensatz in die Tabelle „Browser Orchestration Queue“ (BOQ) [sn_atf_tg_sn_boq] ein, um einen Testauftrag zu starten.
URL-Format
Standard-URL: POST /api/now/sn_atf_tg/Test_Generation
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| CatalogEncodedQuery | Codierte Abfrage, die angibt, für welche Katalogelemente Tests generiert werden sollen. Standardmäßig sind alle Katalogelemente leer. Weitere Informationen zum Erstellen von codierten Abfragen finden Sie unter Encoded query strings. Datentyp: Zeichenfolge |
| E-Mail-Adresse, die gewarnt werden soll, wenn die Testgenerierung abgeschlossen ist. Datentyp: Zeichenfolge |
|
| Max. TestCount | Anzahl der insgesamt zu generierenden Tests. Akzeptierte Werte: Eine beliebige Zahl zwischen 1 und 9999. Datentyp: Zahl Standard: 9999 |
| MaxTestCountPerItem | Anzahl der pro Katalogelement zu generierenden Tests. Akzeptierte Werte: Eine beliebige Zahl zwischen 1 und 10. Datentyp: Zahl Standard: 10 |
| MaxTestCountPerTable | Anzahl der pro Tabelle zu generierenden Tests. Akzeptierte Werte: Eine beliebige Zahl zwischen 1 und 10. Datentyp: Zahl Standard: 10 |
| Scope für GeneratingTests | Erforderlich, wenn separateUpdateSetPerScopeIst auf „falsch“ festgelegt. SYS_ID des Bereichs, in dem alle generierten Tests platziert werden sollen. Datentyp: Zeichenfolge |
| SeparateUpdateSetPerScope | Kennzeichnung, die angibt, ob generierte Tests in die jeweiligen Suites, Update-Sätze und Umfänge getrennt oder Tests in einer Suite, einem Update-Satz und einem Umfang platziert werden sollen. Gültige Werte:
Datentyp: Boolesch Standardwert: wahr |
| Testsuite | Optional. Legt den Namen der Test-Suite fest, die über die Testgenerierung erstellt werden soll. Datentyp: Zeichenfolge Standard: ATF-generierte Suite – <time_stamp> |
| TableEncodedQuery | Codierte Abfrage, die die Tabellen angibt, für die Tests generiert werden sollen. Standardmäßig sind alle Tabellen leer. Weitere Informationen zum Erstellen von codierten Abfragen finden Sie unter Encoded query strings. Datentyp: Zeichenfolge |
| UserEncodedQuery | Codierte Abfrage, die angibt, für welche Anwender Tests generiert werden sollen. Eine leere Zeichenfolgeneingabe ist standardmäßig auf alle Tabellen festgelegt. Weitere Informationen zum Erstellen von codierten Abfragen finden Sie unter Encoded query strings. Datentyp: Zeichenfolge |
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 BOQ-Auftrag zur Testgenerierung wurde erfolgreich eingefügt. Alle Fehler werden während der Verarbeitung in den BOQ-Datensatzprotokollen angezeigt. Alle Eingaben generieren standardmäßig die maximale Anzahl von Tests für alle Tabellen und Servicekatalogelemente. |
| 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.snboqId | SYS_ID des Datensatzes, der in die Tabelle „sn_atf_tg_sn_boq“ eingefügt wird, wenn die Testgenerierung beginnt. Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Anforderungsbeispiel startet einen neuen Testauftrag in der Instanz ohne Anforderungsparameter und fügt den Auftrag in die BOQ-Tabelle ein.
curl "http://instance.service-now.com/api/now/sn_atf_tg/test_generation" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"Antworttext:
{
"result": {
"snboqId": <sys_id of newly inserted BOQ record>
}
}Das folgende Anforderungsbeispiel startet einen neuen Testauftrag mit einer maximalen Testanzahl von 2, filtert die Tests in die Incident-Tabelle und fügt den Auftrag dann in die BOQ-Tabelle ein.
curl "http://instance.service-now.com/api/now/sn_atf_tg/test_generation" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"maxTestCount\":\"2\",\"tableEncodedQuery\":\"name=incident\",\"testSuite\":\"Suite123\"}" \
--user "username":"password"Antworttext:
{
"result": {
"snboqId": <sys_id of newly inserted BOQ record>
}
}