Cloud Runner TestRunnerApi – Scoped, Global

  • Freigeben Version: Washingtondc
  • Aktualisiert 29. Januar 2024
  • 2 Minuten Lesedauer
  • Verwaltet Tests, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden sollen. Diese API ist Teil der CloudRunnerApi-Skripteinbindung.

    Sie können diese API für die folgenden Aufgaben verwenden:
    • Starten Sie einen ATF-Test oder eine Test-Suite im Cloud Runner-Browser.
    • Überprüfen Sie den Fortschritt des Testauftrags.
    • Brechen Sie den Testauftrag 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.

    TestRunnerApi – cancelJob(String snboqId)

    Legt den Test-Runner-Auftrag auf den Status „Abgeschlossen“ fest und bricht die Stammtracker aller generierten Tests ab, die ausgeführt werden.

    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 bei Erfolg, andernfalls Fehlermeldung.

    Das folgende Beispiel zeigt, wie Sie eine Testausführung eines ATF-Tests starten, den Fortschritt anzeigen und die Testausführung stoppen. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({
    	"testId": "<sys_id>"
    });
    
    gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId})));
    
    CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId});

    Ausgabe:

    {progress: 64, state: running}

    TestRunnerApi – progress(String snboqId)

    Stellt den Status jedes Tests bereit, der für einen angegebenen BOQ-Datensatz (Browser Orchestration Queue) ausgeführt wurde.

    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 JSON-Objekt, das den Testfortschritt anzeigt.
    {
      "progress": Number,
      "state": "String"
    }
    Objekt.Fortschritt Gibt den Prozentsatz des abgeschlossenen Testfortschritts an.

    Typ: Nummer

    Objekt.Status Status des BOQ-Datensatzes.
    Mögliche Werte:
    • Ausstehend – Die angeforderte Testaktivität wurde erstellt und wartet auf die Ausführung.
    • Wird verarbeitet – Die Instanz scannt nach Datensätzen, um sicherzustellen, dass die Ausführungstracker für Cloud Runner markiert sind, bevor die Anforderung an die Cloud-Infrastruktur gesendet wird.
    • Angeforderte Browser: Es wurde eine Anforderung an die Cloud-Infrastruktur gesendet, um Browser zur Testgenerierung oder Testausführung zu starten.
    • Wird ausgeführt – Cloud-Infrastrukturbrowser suchen nach ausstehenden Tests und führen sie aus.
    • Abgeschlossen: Die Testaufgabe ist abgeschlossen.
    • Status „Fehlgeschlagen“: Die Testaufgabe ist fehlgeschlagen.

    Typ: Zeichenfolge

    Fehler Mögliche Fehlermeldungen, wenn nicht erfolgreich:
    • Keine BOQ-ID übergeben: Das angegebene JSON-Objekt hat keinen BOQ-ID-Eintrag. Stellen Sie sicher, dass das JSON-Objekt als {snboqId: "strukturiert ist.<sys_id> "} .
    • Ungültige sys_id für BOQ übergeben – Die angegebene ID muss für einen BOQ-Datensatz in der Tabelle „Browser-Orchestration-Warteschlange“ [sn_atf_tg_sn_boq] sein.

    Das folgende Beispiel zeigt, wie Sie eine Testausführung eines ATF-Tests starten, den Fortschritt anzeigen und die Testausführung stoppen. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({
    	"testId": "<sys_id>"
    });
    
    gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId})));
    
    CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId});

    Ausgabe:

    {progress: 64, state: running}

    TestRunnerApi – startJob(String testId)

    Startet einen ATF-Test oder eine Test-Suite im Cloud Runner-Browser.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    testId Zeichenfolge Erforderlich. Die sys_id des ATF-Tests oder der Test-Suite, der im Cloud Runner-Browser ausgeführt werden soll. Befindet sich in einer der folgenden Tabellen:
    • Test [sys_atf_test]
    • Test-Suites [sys_atf_test_suite]
    Tabelle : 6. Ergebnisse
    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 eine Testausführung eines ATF-Tests starten, den Fortschritt anzeigen und die Testausführung stoppen. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({
    	"testId": "<sys_id>"
    });
    
    gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId})));
    
    CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId});

    Ausgabe:

    {progress: 64, state: running}