Cloud Runner TestGenerationApi – Bereichsbezogen, Global

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 3 Minuten Lesedauer
  • 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.

    Sie können diese API für die folgenden Aufgaben verwenden:
    • Starten Sie den Testgenerierungsauftrag.
    • Überprüft 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 das Plugin ATF Test Generator and Cloud Runner (sn_atf_tg) aktivieren, um diese API verwenden zu können.

    TestGenerationApi – cancelJob(String snboqId)

    Setzt den Testgenerierungsauftrag und den zugehörigen Update-Satz-Datensatz auf den Status „Abgeschlossen“. Bricht die Stammtracker aller generierten Tests ab, die ausgeführt werden. Wenn bei Abbruch Testaufträge in Bearbeitung sind, legt diese Methode einen der in Bearbeitung befindlichen Testdatensätze als übersprungen fest.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    snboqId Zeichenfolge Erforderlich. Die sys_id des BOQ-Datensatzes in der Tabelle „Browser-Orchestrationswarteschlange“ [sn_atf_tg_sn_boq].
    Tabelle : 2. Ausgabe
    Typ Beschreibung
    Null NULL bei Erfolg, andernfalls Fehlermeldung.

    Das folgende Beispiel zeigt, wie Sie die Generierung von Tests für die Incident-Tabelle starten 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 – Progress(String snboqId)

    Stellt den Status jedes generierten Tests für einen angegebenen 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-Orchestrationswarteschlange“ [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_generate_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_generate_test] aufgeführt.

    Datentyp: Zahl

    testInProgress Die Anzahl der erstellten Anwendungsfälle.

    Datentyp: Zahl

    TestsAusstehend Anzahl der verbleibenden Anwendungsfälle, die generiert werden müssen.

    Datentyp: Zahl

    TestsÜbersprungen Die Anzahl der Tests, die aufgrund eines Auftragsabbruchs übersprungen wurden.

    Datentyp: Zahl

    Tests erfolgreich Die Anzahl der erfolgreich generierten Tests.

    Datentyp: Zahl

    Das folgende Beispiel zeigt, wie Sie die Generierung von Tests für die Incident-Tabelle starten, 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, Zeichenfolge userEncodedQuery, Zeichenfolge catalogEncodedQuery, Anzahl maxTestCount, Anzahl maxTestCountPerTable, Anzahl maxTestCountPerItem, Zeichenfolge email)

    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
    katalogEncodedQuery 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 wird, wenn die Testgenerierung abgeschlossen ist.

    Standard: Keine E-Mail (leere Zeichenfolge)

    maxTestCount Nummer Optional. Maximale Anzahl der zu generierenden Tests.

    Mögliche Werte: 1–9999

    Standard: 9999 (Maximalwert)

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

    Mögliche Werte: 1–10

    Standard: 10 (Maximalwert)

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

    Mögliche Werte: 1–10

    Standard: 10 (Maximalwert)

    separateUpdateSetPerBereich Boolean

    Optional. Kennzeichnung, die angibt, ob generierte Tests in die entsprechenden Suiten, Update-Sätze und Bereiche getrennt oder Tests in einer Suite, einem Update-Satz und einem Bereich platziert werden sollen.

    Gültige Werte:
    • wahr: Tests werden in der jeweiligen Suite und im Update Set entsprechend dem Umfang der einzelnen Tabellen oder Katalogelemente platziert.
    • „false“: Alle generierten Tests werden in derselben Suite, demselben Update Set und demselben Umfang platziert. Bei „false“ ist scopeForGeneratingTests in der Anforderung erforderlich.

    Standardwert: wahr

    scopeForGeneratingTests Zeichenfolge Erforderlich, wenn separateUpdateSetPerScope auf „falsch“ festgelegt ist. Sys_id des Bereichs, in dem alle generierten Tests platziert werden sollen.

    Standard: Keine sys_id (leere Zeichenfolge)

    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-Orchestrationswarteschlange“ [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",
      maxTestCount: 10
    });
    
    gs.info(insertedSnboqId);

    Ausgabe:

    <sys_id of inserted BOQ record>