Cloud Runner TestGenerationApi: Bereichsbezogen, Global

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 3 Minuten Lesedauer
  • Verwaltet die Generierung von Testaufträgen, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden soll. Diese API ist Teil der CloudRunnerApi-Skripteinbindung.

    Sie können diese API für die folgenden Aufgaben verwenden:
    • Starten Sie den Testgenerierungsauftrag.
    • Überprüfen Sie den Fortschritt des Testgenerierungsauftrags.
    • Brechen Sie den Testgenerierungsauftrag ab.

    Im globalen Bereich wird diese API innerhalb des Namespace sn_atf_tg ausgeführt. Sie müssen haben ATF Test Generator and Cloud Runner Plugin (sn_atf_tg) zur Verwendung dieser API aktiviert.

    TestGenerationApi – cancelJob(Zeichenfolge snboqId)

    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.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    SnboqId Zeichenfolge Erforderlich. Die sys_ID des BOQ-Datensatzes in der Tabelle „Browser Orchestration-Warteschlange“ [sn_atf_tg_sn_boq].
    Tabelle : 2. Ausgabe
    Typ Beschreibung
    Null Null, wenn erfolgreich, andernfalls Fehlermeldung.

    Das folgende Beispiel zeigt, wie Sie mit der Generierung von Tests für die Incident-Tabelle beginnen und die Testgenerierung abbrechen. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var insertedSnboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
      tableEncodedQuery: "nameISincident",
      catalogEncodedQuery: "sysIdISEMPTY",
      maxTestCount: 10
    });
    
    CloudRunnerAPI.TestGenerationAPI.cancelJob({snboqId: insertedSnboqId});

    TestGenerationApi – Fortschritt (Zeichenfolge snboqId)

    Stellt den Status jedes generierten Tests für einen bereitgestellten BOQ-Datensatz (Browser Orchestration Queue) bereit.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    SnboqId Zeichenfolge Erforderlich. Die sys_ID des BOQ-Datensatzes in der Tabelle „Browser Orchestration-Warteschlange“ [sn_atf_tg_sn_boq].
    Tabelle : 4. Ausgabe
    Typ Beschreibung
    Objekt Informationen zum Testauftrag. Erweiterte Testdetails finden Sie in der Tabelle „generierte Tests“ [sn_atf_tg_generated_Test].
    {
      "testsFailed": Number,
      "testsInProgress": Number,
      "testsPending": Number,
      "testsSkipped": Number,
      "testsSucceeded": Number
    }
    TestsFehlgeschlagen Die Anzahl der generierten fehlgeschlagenen Tests. Die Fehlergründe sind in der Tabelle „generierte Tests“ [sn_atf_tg_generated_Test] aufgeführt.

    Datentyp: Zahl

    TestsInProgress Die Anzahl der erstellten Anwendungsfälle.

    Datentyp: Zahl

    Tests ausstehend Die Anzahl der noch zu generierenden Anwendungsfälle.

    Datentyp: Zahl

    TestsÜbersprungen Die Anzahl der Tests, die aufgrund des Abbruchs des Auftrags übersprungen wurden.

    Datentyp: Zahl

    Tests erfolgreich Die Anzahl der erfolgreich generierten Tests.

    Datentyp: Zahl

    Das folgende Beispiel zeigt, wie Sie mit der Generierung von Tests für die Incident-Tabelle beginnen, den Fortschritt abrufen und die Testgenerierung abbrechen. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
      "tableEncodedQuery": "nameISincident",
      "catalogEncodedQuery": "sysIdISEMPTY",
      "maxTestCount": 10
    });
    
    gs.info(JSON.stringify(CloudRunnerAPI.TestGenerationAPI.progress({snboqId: snboqId})));
    
    CloudRunnerAPI.TestGenerationAPI.cancelJob({"snboqId": snboqId});

    Ausgabe:

    {
      "testsSucceeded": 4,
      "testsFailed": 2,
      "testsPending": 2,
      "testsInProgress": 8,
      "testsSkipped": 0
    }

    TestGenerationApi – startJob(String tableEncodedQuery, String userEncodedQuery, String catalogEncodedQuery, Number maxTestCount, Number maxTestCountPerTable, Zahl maxTestCountPerItem, Zeichenfolge-E-Mail, boolescher Wert separateUpdateSetPerScope, Zeichenfolge scope ForGeneratingTests, Zeichenfolge SuiteName )

    Fügt einen Datensatz in die Tabelle „Browser Orchestration Queue“ (BOQ) [sn_atf_tg_sn_boq] ein, um einen Testauftrag zu starten.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    CatalogEncodedQuery Zeichenfolge Optional. Codierte Abfrage, die die Katalogelemente (CIs) angibt, für die Tests generiert werden sollen.

    Standard: Alle CIs (leere Zeichenfolge)

    E-Mail Zeichenfolge Optional. E-Mail-Adresse, an die eine Benachrichtigung gesendet werden soll, wenn die Testgenerierung abgeschlossen ist.

    Standard: Keine E-Mail (leere Zeichenfolge)

    Max. TestCount Anzahl Optional. Maximale Anzahl von Tests, die generiert werden sollen.

    Mögliche Werte: 1-9999

    Standard: 9999 (Höchstwert)

    MaxTestCountPerItem Anzahl Optional. Maximale Anzahl von Tests, die pro CI generiert werden sollen.

    Mögliche Werte: 1-10

    Standard: 10 (Höchstwert)

    MaxTestCountPerTable Anzahl Optional. Maximale Anzahl von Tests, die pro Tabelle generiert werden sollen.

    Mögliche Werte: 1-10

    Standard: 10 (Höchstwert)

    Scope für GeneratingTests Zeichenfolge Erforderlich, wenn separateUpdateSetPerScopeIst auf „falsch“ festgelegt. SYS_ID des Bereichs, in dem alle generierten Tests platziert werden sollen.

    Standard: Keine sys_ID (leere Zeichenfolge)

    SeparateUpdateSetPerScope Boolean Optional. 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:
    • Wahr: Tests werden in ihrer jeweiligen Suite und ihrem Update-Satz entsprechend dem Umfang der einzelnen Tabellen oder Katalogelemente platziert.
    • Falsch: Alle generierten Tests werden in derselben Suite, demselben Update-Satz und demselben Umfang platziert. Bei „falsch“, scopeForGeneratingTestsIst in der Anforderung erforderlich.

    Standardwert: wahr

    Testsuite Zeichenfolge Optional. Legt den Namen der Test-Suite fest, die über die Testgenerierung erstellt werden soll.

    Datentyp: Zeichenfolge

    Standard: ATF-generierte Suite – <time_stamp>

    TableEncodedQuery Zeichenfolge Optional. Codierte Abfrage, die die Tabellen angibt, für die Tests generiert werden sollen. Weitere Informationen finden Sie unter Encoded query strings.

    Standard: Alle Tabellen (leere Zeichenfolge)

    UserEncodedQuery Zeichenfolge Optional. Codierte Abfrage, die die Anwender angibt, für die Tests generiert werden sollen.

    Standard: Alle Anwender (leere Zeichenfolge)

    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Zeichenfolge Die sys_ID des BOQ-Datensatzes in der Tabelle „Browser Orchestration-Warteschlange“ [sn_atf_tg_sn_boq].

    Das folgende Beispiel zeigt, wie Sie mit der Generierung von Tests für die Incident-Tabelle beginnen. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var insertedSnboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
      tableEncodedQuery: "nameISincident",
      catalogEncodedQuery: "sysIdISEMPTY",
      suiteName: "Suite123",
      maxTestCount: 10
    });
    
    gs.info(insertedSnboqId);

    Ausgabe:

    <sys_id of inserted BOQ record>