Cloud Runner TestUserApi – Bereichsbezogen, Global

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 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üft 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 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 des Testanwenderauftrags in der Tabelle der Browser-Orchestrationswarteschlange [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-Orchestrationswarteschlange“ [sn_atf_tg_sn_boq].
    Tabelle : 2. Ausgabe
    Typ Beschreibung
    Null NULL bei Erfolg, andernfalls Fehlermeldung.
    Fehler Falls nicht erfolgreich, mögliche Fehlermeldungen:
    • Keine BOQ-ID übergeben – Das angegebene JSON-Objekt hat keinen BOQ-ID-Eintrag. Vergewissern Sie sich, dass das JSON-Objekt wie folgt strukturiert ist: {snboqId: "<sys_id> "} .
    • Ungültige BOQ-sys_id übergeben: Die angegebene ID muss für einen BOQ-Datensatz in der Tabelle „Browser-Orchestrationswarteschlange“ [sn_atf_tg_sn_boq] gelten.

    Das folgende Beispiel zeigt, wie Sie einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der gesperrte 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. 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: {username: "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 einem oder mehreren der folgenden Gründe ungültig:
      • Der Anwender wurde nicht gefunden.
      • Der Anwender ist inaktiv.
      • Der Anwender ist ausgesperrt.
      • Der Anwender benötigt eine Passwortzurücksetzung.
      • Der Anwender 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 gesperrte 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 Anwendertests für einen angegebenen 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-Orchestrationswarteschlange“ [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 abgeschlossenen Prozentsatz des 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 Datensätze, um sicherzustellen, dass die Ausführungstracker für Cloud Runner markiert sind, bevor die Anforderung an die Cloud-Infrastruktur gesendet wird.
    • Browser angefordert: An die Cloud-Infrastruktur wurde eine Anforderung zum Starten von Browsern für die Testgenerierung oder den Testlauf gesendet.
    • 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 Falls nicht erfolgreich, mögliche Fehlermeldungen:
    • Keine BOQ-ID übergeben – Das angegebene JSON-Objekt hat keinen BOQ-ID-Eintrag. Vergewissern Sie sich, dass das JSON-Objekt wie folgt strukturiert ist: {snboqId: "<sys_id> "} .
    • Ungültige BOQ-sys_id übergeben: Die angegebene ID muss für einen BOQ-Datensatz in der Tabelle „Browser-Orchestrationswarteschlange“ [sn_atf_tg_sn_boq] gelten.

    Das folgende Beispiel zeigt, wie Sie einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der gesperrte 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 – auswählenCloudUser(String username)

    Startet einen End-to-End-Testanwenderauftrag 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 auf diesen Benutzer 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: {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 gibt an, 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 Anwender ist ausgesperrt.
    • Der Anwender benötigt eine Passwortzurücksetzung.
    • Der Anwender 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 gesperrte 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 (Zeichenfolge username)

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

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    username Zeichenfolge Erforderlich. Anwendername von sys_user zum Testen der End-to-End-Infrastruktur von Cloud Runner.
    Tabelle : 10. 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 einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der gesperrte 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