Cloud Runner TestUserApi – Scoped, Global

  • Freigeben Version: Washingtondc
  • Aktualisiert 29. Januar 2024
  • 5 Minuten Lesedauer

    • Verwaltet Testbenutzeraufträ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 Benutzertestauftrag.
    • Legen Sie den Cloud-Benutzer fest.
    • Überprüfen Sie, ob der angegebene Benutzer gültig ist.
    • Überprüfen Sie den Fortschritt des Benutzertestauftrags.
    • 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.

    Siehe auch:

    TestUserApi – cancelJob(String snboqId)

    Legt den Status der Testbenutzeraufgabe 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 bei Erfolg, andernfalls Fehlermeldung.
    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 einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der ausgesperrte Benutzer als gültiger Cloud-Benutzer bestätigt wurde, legt der Code den Cloud-Benutzer 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(String username)

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

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

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

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

    Das folgende Beispiel zeigt, wie Sie einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der ausgesperrte Benutzer als gültiger Cloud-Benutzer bestätigt wurde, legt der Code den Cloud-Benutzer 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 – progress(String snboqId)

    Stellt den Status jedes Benutzertests 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 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 einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der ausgesperrte Benutzer als gültiger Cloud-Benutzer bestätigt wurde, legt der Code den Cloud-Benutzer 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(String username)

    Startet einen End-to-End-Testbenutzerauftrag in Cloud Runner. Wenn sich der Benutzer mit der Administratorrolle ordnungsgemäß anmelden kann, wird die Cloud-Benutzereigenschaft für zukünftige Testläufe und Testgenerierungen in der Cloud Runner-Infrastruktur als dieser Benutzer festgelegt.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    username Objekt Erforderlich. Benutzer-ID eines gültigen Benutzers, der in der Benutzertabelle [sys_user] aufgeführt ist. Dieser Wert wird als Zeichenfolge in einem JSON-Objekt bereitgestellt. Beispiel: {username: "abel.tuter"}.
    Tabelle : 8. Ausgabe
    Typ Beschreibung
    NULL NULL, wenn erfolgreich. Andernfalls Fehlermeldung.
    Cloud-Anwender kann nicht als ungültiger Cloud-Anwender festgelegt werden  – Dieser Fehler weist darauf hin, dass der angegebene Anwender aus einem oder mehreren der folgenden Gründe ungültig ist:
    • Der Anwender wurde nicht gefunden.
    • Der Anwender ist inaktiv.
    • Der Benutzer ist ausgesperrt.
    • Der Benutzer benötigt eine Passwortzurücksetzung.
    • Der Benutzer hat keine Administratorrolle.
    • Der Benutzer hat schreibgeschützten Zugriff.
    • Der Benutzer hat nur Zugriff auf Webservices.

    Das folgende Beispiel zeigt, wie Sie einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der ausgesperrte Benutzer als gültiger Cloud-Benutzer bestätigt wurde, legt der Code den Cloud-Benutzer 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(String username)

    Startet einen End-to-End-Testbenutzerauftrag in Cloud Runner.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    username Zeichenfolge Erforderlich. Benutzername sys_user zum Testen der End-to-End-Infrastruktur von Cloud Runner.
    Tabelle : 10. 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 einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der ausgesperrte Benutzer als gültiger Cloud-Benutzer bestätigt wurde, legt der Code den Cloud-Benutzer 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