Cloud Runner TestUserApi: Bereichsbezogen, Global

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 5 Minuten Lesedauer

    • Verwaltet Testanwenderaufträge, 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 den Anwendertestauftrag.
    • Legen Sie den Cloud-Anwender fest.
    • Überprüfen Sie, ob der angegebene Anwender gültig ist.
    • Überprüfen Sie den Fortschritt des Anwendertestauftrags.
    • 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.

    Siehe auch:

    TestUserApi – cancelJob(Zeichenfolge snboqId)

    Legt den Status des Testanwenderauftrags in der Tabelle „Browser Orchestration-Warteschlange“ [sn_atf_tg_sn_boq] auf „Abgeschlossen“ 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.
    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 Testanwender für den Administratoranwender starten, den Fortschritt abrufen und den Testanwender abbrechen. Nachdem der gesperrte Anwender als gültiger Cloud-Anwender bestätigt wurde, legt der Code den Cloud-Anwender als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    Ausgabe:

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False

    TestUserApi – isValidCloudUser(Anwendername der Zeichenfolge)

    Überprüft, ob ein angegebener Anwender ein gültiger Cloud-Anwender ist.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    username Objekt Erforderlich. Anwender-ID eines gültigen Anwenders, der in der Tabelle „Anwender“ [sys_user] aufgeführt ist. Dieser Wert wird als Zeichenfolge in einem JSON-Objekt bereitgestellt. Beispiel: {Anwendername: „abel.tuter“} .
    Tabelle : 4. Ausgabe
    Typ Beschreibung
    Boolean

    Kennzeichnung, die angibt, ob der angegebene Anwender ein gültiger Cloud-Anwender ist.

    Gültige Werte:
    • Wahr: Der angegebene Anwender ist ein gültiger Cloud-Anwender.
    • Falsch: Der angegebene Anwender ist aus mindestens einem der folgenden Gründe ungültig:
      • Der Anwender wurde nicht gefunden.
      • Der Anwender ist inaktiv.
      • Der Anwender ist gesperrt.
      • Der Anwender benötigt eine Passwortzurücksetzung.
      • Der Anwender hat keine Administratorrolle.
      • Der Anwender hat schreibgeschützten Zugriff.
      • Der Anwender hat nur Zugriff auf Webservices.

    Das folgende Beispiel zeigt, wie Sie einen Testanwender für den Administratoranwender starten, den Fortschritt abrufen und den Testanwender abbrechen. Nachdem der gesperrte Anwender als gültiger Cloud-Anwender bestätigt wurde, legt der Code den Cloud-Anwender als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    Ausgabe:

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False

    TestUserApi – Fortschritt (Zeichenfolge snboqId)

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

    Tabelle : 5. 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 : 6. 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 Testanwender für den Administratoranwender starten, den Fortschritt abrufen und den Testanwender abbrechen. Nachdem der gesperrte Anwender als gültiger Cloud-Anwender bestätigt wurde, legt der Code den Cloud-Anwender als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    Ausgabe:

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False

    TestUserApi – selectCloudUser(Anwendername der Zeichenfolge)

    Startet einen End-to-End-Test-Anwenderauftrag im Cloud Runner. Wenn der Anwender sich mit der Administratorrolle richtig anmelden kann, wird die Cloud-Anwendereigenschaft für zukünftige Testläufe und Testgenerierungen in der Cloud Runner-Infrastruktur als dieser Anwender festgelegt.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    username Objekt Erforderlich. Anwender-ID eines gültigen Anwenders, der in der Tabelle „Anwender“ [sys_user] aufgeführt ist. Dieser Wert wird als Zeichenfolge in einem JSON-Objekt bereitgestellt. Beispiel: {Anwendername: „abel.tuter“} .
    Tabelle : 8. Ausgabe
    Typ Beschreibung
    Null Null, wenn erfolgreich. Andernfalls Fehlermeldung.
    Cloud-Anwender kann nicht festgelegt werden, da Cloud-Anwender ungültig ist – Dieser Fehler gibt an, dass der angegebene Anwender aus mindestens einem der folgenden Gründe ungültig ist:
    • Der Anwender wurde nicht gefunden.
    • Der Anwender ist inaktiv.
    • Der Anwender ist gesperrt.
    • Der Anwender benötigt eine Passwortzurücksetzung.
    • Der Anwender hat keine Administratorrolle.
    • Der Anwender hat schreibgeschützten Zugriff.
    • Der Anwender hat nur Zugriff auf Webservices.

    Das folgende Beispiel zeigt, wie Sie einen Testanwender für den Administratoranwender starten, den Fortschritt abrufen und den Testanwender abbrechen. Nachdem der gesperrte Anwender als gültiger Cloud-Anwender bestätigt wurde, legt der Code den Cloud-Anwender als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    Ausgabe:

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False

    TestUserApi – startJob(Anwendername der Zeichenfolge)

    Startet einen End-to-End-Test-Anwenderauftrag im Cloud Runner.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    username Zeichenfolge Erforderlich. Anwendername von sys_user zum Testen der End-to-End-Infrastruktur des Cloud Runners.
    Tabelle : 10. 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 Testanwender für den Administratoranwender starten, den Fortschritt abrufen und den Testanwender abbrechen. Nachdem der gesperrte Anwender als gültiger Cloud-Anwender bestätigt wurde, legt der Code den Cloud-Anwender als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    Ausgabe:

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False