Exécuteur dans le cloud TestUserApi : dans le champ d’application, global

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 6 minutes de lecture

    • Gère les tâches de l’utilisateur de test à exécuter dans un exécuteur dans le cloud pour Framework de tests automatisés (ATF). Cette API fait partie de l’include de script CloudRunnerApi.

    Vous pouvez utiliser cette API pour les tâches suivantes :
    • Démarrez la tâche de test utilisateur.
    • Définissez l’utilisateur du cloud.
    • Vérifiez si l’utilisateur spécifié est valide.
    • Vérifiez la progression de la tâche de test utilisateur.
    • Annulez la tâche de test.

    Dans le champ d’application global, cette API est exécutée dans l’espace de noms sn_atf_tg. Vous devez avoir activé le (sn_atf_tg) module d’extension ATF Test Generator and Cloud Runner pour utiliser cette API.

    Voir aussi :

    TestUserApi – cancelJob(String snboqId)

    Définit l’état de la tâche de l’utilisateur test dans la table File d’attente Orchestration du navigateur [sn_atf_tg_sn_boq] comme terminé.

    Tableau 1. Paramètres
    Nom Type Description
    snboqId Chaîne Requis. sys_id de l’enregistrement BOQ dans la table File d’attente Orchestration du navigateur [sn_atf_tg_sn_boq].
    Tableau 2. Renvoie
    Type Description
    null Nul en cas de réussite, message d’erreur dans le cas contraire.
    Erreur En cas d’échec, messages d’erreur possibles :
    • Aucun ID de nomenclature transmis : l’objet JSON fourni n’a pas d’entrée d’ID de nomenclature. Vérifiez que l’objet JSON est structuré comme suit : {snboqId : « <sys_id>"}.
    • sys_id de demande de commande non valide transmise : l’ID fourni doit se trouver pour un enregistrement de demande de changement dans la table File d’attente Orchestration du navigateur [sn_atf_tg_sn_boq].

    L’exemple suivant montre comment démarrer un utilisateur test pour l’utilisateur administrateur, obtenir la progression et annuler l’utilisateur test. Après avoir confirmé l’utilisateur verrouillé en tant qu’utilisateur cloud valide, le code définit l’utilisateur cloud en tant qu’administrateur ITIL. Dans le champ d’application global, utilisez l’espace de noms 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"});

    Sortie :

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

    TestUserApi : isValidCloudUser(nom d’utilisateur de chaîne)

    Vérifie si un utilisateur fourni est un utilisateur valide du cloud.

    Tableau 3. Paramètres
    Nom Type Description
    nom d'utilisateur Objet Requis. ID d’utilisateur d’un utilisateur valide répertorié dans la table Utilisateurs [sys_user]. Cette valeur est fournie sous forme de chaîne dans un objet JSON. Par exemple, {username : « abel.tuter"}.
    Tableau 4. Renvoie
    Type Description
    Booléen

    Marqueur indiquant si l’utilisateur fourni est un utilisateur valide du cloud.

    Valeurs valides :
    • vrai : l’utilisateur fourni est un utilisateur valide du cloud.
    • faux : l’utilisateur fourni n’est pas valide pour une ou plusieurs des raisons suivantes :
      • L’utilisateur est introuvable.
      • L’utilisateur est inactif.
      • L’utilisateur est verrouillé.
      • L’utilisateur a besoin d’une réinitialisation du mot de passe.
      • L’utilisateur ne dispose pas d’un rôle administrateur.
      • L’utilisateur dispose d’un accès en lecture seule.
      • L’utilisateur n’a qu’un accès aux services web.

    L’exemple suivant montre comment démarrer un utilisateur test pour l’utilisateur administrateur, obtenir la progression et annuler l’utilisateur test. Après avoir confirmé l’utilisateur verrouillé en tant qu’utilisateur cloud valide, le code définit l’utilisateur cloud en tant qu’administrateur ITIL. Dans le champ d’application global, utilisez l’espace de noms 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"});

    Sortie :

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

    TestUserApi : progression (chaîne snboqId)

    Fournit l’état de chaque test utilisateur pour un enregistrement de file d’attente d’orchestration du navigateur (BOQ) fourni.

    Tableau 5. Paramètres
    Nom Type Description
    snboqId Chaîne Requis. sys_id de l’enregistrement BOQ dans la table File d’attente Orchestration du navigateur [sn_atf_tg_sn_boq].
    Tableau 6. Renvoie
    Type Description
    Objet Objet JSON indiquant la progression du test.
    {
  "progress": Number,
  "state": "String"
}
    Objet.progression Indique le pourcentage de progression du test terminé.

    Type : numéro
    Objet.état État de l’enregistrement de la demande de commande.
    Valeurs possibles :
    • En attente : l’activité de test demandée a été créée et attend d’être exécutée.
    • Traitement : l’instance recherche les enregistrements pour s’assurer que les suivis d’exécution sont marqués pour l’exécuteur dans le cloud avant que la demande ne soit envoyée à l’infrastructure dans le cloud.
    • Navigateurs demandés : une demande a été envoyée à l’infrastructure cloud pour démarrer les navigateurs pour la génération ou l’exécution du test.
    • En cours d’exécution – Les navigateurs d’infrastructure cloud trouvent et exécutent des tests en attente.
    • Terminé : la tâche de test est terminée.
    • État Échoué : la tâche de test a échoué.

    Type : chaîne
    Erreur En cas d’échec, messages d’erreur possibles :
    • Aucun ID de nomenclature transmis : l’objet JSON fourni n’a pas d’entrée d’ID de nomenclature. Vérifiez que l’objet JSON est structuré comme suit : {snboqId : « <sys_id>"}.
    • sys_id de demande de commande non valide transmise : l’ID fourni doit se trouver pour un enregistrement de demande de changement dans la table File d’attente Orchestration du navigateur [sn_atf_tg_sn_boq].

    L’exemple suivant montre comment démarrer un utilisateur test pour l’utilisateur administrateur, obtenir la progression et annuler l’utilisateur test. Après avoir confirmé l’utilisateur verrouillé en tant qu’utilisateur cloud valide, le code définit l’utilisateur cloud en tant qu’administrateur ITIL. Dans le champ d’application global, utilisez l’espace de noms 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"});

    Sortie :

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

    TestUserApi – selectCloudUser(nom d’utilisateur de chaîne)

    Démarre une tâche d’utilisateur test de bout en bout sur l’exécuteur dans le cloud. Si l’utilisateur est en mesure de se connecter correctement avec le rôle d’administrateur, la propriété d’utilisateur dans le cloud est définie comme cet utilisateur pour les futures exécutions de tests et générations de tests sur l’infrastructure de l’exécuteur dans le cloud.

    Tableau 7. Paramètres
    Nom Type Description
    nom d'utilisateur Objet Requis. ID d’utilisateur d’un utilisateur valide répertorié dans la table Utilisateurs [sys_user]. Cette valeur est fournie sous forme de chaîne dans un objet JSON. Par exemple, {username : « abel.tuter"}.
    Tableau 8. Renvoie
    Type Description
    Zéro Nul en cas de réussite. Message d’erreur sinon.
    Impossible de définir l’utilisateur du cloud en tant qu’utilisateur du cloud non valide : cette erreur indique que l’utilisateur fourni n’est pas valide pour une ou plusieurs des raisons suivantes :
    • L’utilisateur est introuvable.
    • L’utilisateur est inactif.
    • L’utilisateur est verrouillé.
    • L’utilisateur a besoin d’une réinitialisation du mot de passe.
    • L’utilisateur ne dispose pas d’un rôle administrateur.
    • L’utilisateur dispose d’un accès en lecture seule.
    • L’utilisateur n’a qu’un accès aux services web.

    L’exemple suivant montre comment démarrer un utilisateur test pour l’utilisateur administrateur, obtenir la progression et annuler l’utilisateur test. Après avoir confirmé l’utilisateur verrouillé en tant qu’utilisateur cloud valide, le code définit l’utilisateur cloud en tant qu’administrateur ITIL. Dans le champ d’application global, utilisez l’espace de noms 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"});

    Sortie :

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

    TestUserApi – startJob(nom d’utilisateur de chaîne)

    Démarre une tâche d’utilisateur de test de bout en bout sur l’exécuteur dans le cloud.

    Tableau 9. Paramètres
    Nom Type Description
    nom d'utilisateur Chaîne Requis. Nom d’utilisateur de sys_user pour tester l’infrastructure de bout en bout de l’exécuteur dans le cloud.
    Tableau 10. Renvoie
    Type Description
    Chaîne sys_id de l’enregistrement BOQ dans la table File d’attente Orchestration du navigateur [sn_atf_tg_sn_boq].

    L’exemple suivant montre comment démarrer un utilisateur test pour l’utilisateur administrateur, obtenir la progression et annuler l’utilisateur test. Après avoir confirmé l’utilisateur verrouillé en tant qu’utilisateur cloud valide, le code définit l’utilisateur cloud en tant qu’administrateur ITIL. Dans le champ d’application global, utilisez l’espace de noms 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"});

    Sortie :

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