Cloud Runner TestRunnerApi: Bereichsbezogen, Global

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 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 eine ATF-Test- oder -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 haben ATF Test Generator and Cloud Runner Plugin (sn_atf_tg) zur Verwendung dieser API aktiviert.

    TestRunnerApi – cancelJob(Zeichenfolge 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, wenn erfolgreich, andernfalls Fehlermeldung.

    Das folgende Beispiel zeigt, wie Sie einen Test starten, einen ATF-Test ausführen, den Fortschritt anzeigen und den Testlauf 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 – Fortschritt (Zeichenfolge snboqId)

    Gibt den Status jedes ausgeführten Tests für einen angegebenen BOQ-Datensatz (Browser Orchestration Queue) an.

    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 angibt.
    {
      "progress": Number,
      "state": "String"
    }
    Object.progress Gibt den Prozentsatz des abgeschlossenen Testfortschritts an.

    Typ: Zahl

    Objekt.Status Status des BOQ-Datensatzes.
    Mögliche Werte:
    • Ausstehend: Die angeforderte Testaktivität wurde erstellt und wartet auf die Ausführung.
    • Verarbeitung: 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: Eine Anforderung wurde an die Cloud-Infrastruktur gesendet, um Browser für die Testgenerierung oder Testausführung zu starten.
    • Wird ausgeführt: Cloud-Infrastrukturbrowser suchen ausstehende Tests und führen sie aus.
    • Abgeschlossen: Die Testaufgabe ist abgeschlossen.
    • Status „Fehlgeschlagen“: Die Testaufgabe ist fehlgeschlagen.

    Typ: Zeichenfolge

    Fehler Wenn nicht erfolgreich, mögliche Fehlermeldungen:
    • Keine BOQ-ID übergeben – das angegebene JSON-Objekt hat keinen BOQ-ID-Eintrag. Stellen Sie sicher, dass das JSON-Objekt als strukturiert ist {SnboqId: „<sys_id>“} .
    • Ungültige BOQ-sys_ID übergeben – die angegebene ID muss für einen BOQ-Datensatz in der Tabelle „BrowserOrchestration-Warteschlange“ [sn_atf_tg_sn_boq] angegeben werden.

    Das folgende Beispiel zeigt, wie Sie einen Test starten, einen ATF-Test ausführen, den Fortschritt anzeigen und den Testlauf 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(Zeichenfolge 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 der ATF-Test- oder Test-Suite, die 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. 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 einen Test starten, einen ATF-Test ausführen, den Fortschritt anzeigen und den Testlauf 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}