TestGenerationAPI de l’exécuteur cloud : champ d’application, global

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 4 minutes de lecture

    • Gère la génération de tâches 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 génération des tests.
    • Vérifiez la progression de la tâche de génération des tests.
    • Annuler la tâche de génération des tests.

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

    Voir aussi :

    TestGenerationApi – cancelJob(String snboqId)

    Définit la tâche de génération des tests et son enregistrement d’ensemble de mises à jour associé sur l’état Terminé. Annule les suivis racine de tous les tests générés en cours d’exécution. Si des tâches de test sont en cours lors de l’annulation, cette méthode définit tous les enregistrements de test en cours générés comme ignorés.

    Tableau 1. Paramètres
    Nom Type Description
    snboqId Chaîne Requis. Le 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.

    L’exemple suivant montre comment démarrer la génération de tests pour la table d’incidents et annuler la génération des tests. Dans le champ d’application global, utilisez l’espace de noms sn_atf_tg.

    var insertedSnboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
  tableEncodedQuery: "nameISincident",
  catalogEncodedQuery: "sysIdISEMPTY",
  maxTestCount: 10
});

CloudRunnerAPI.TestGenerationAPI.cancelJob({snboqId: insertedSnboqId});

    TestGenerationApi – progress(String snboqId)

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

    Tableau 3. Paramètres
    Nom Type Description
    snboqId Chaîne Requis. Le sys_id de l’enregistrement BOQ dans la table File d’attente Orchestration du navigateur [sn_atf_tg_sn_boq].
    Tableau 4. Renvoie
    Type Description
    Objet Informations sur la tâche de test. Vous trouverez les détails des tests avancés dans la table Tests générés [sn_atf_tg_generated_test].
    {
  "testsFailed": Number,
  "testsInProgress": Number,
  "testsPending": Number,
  "testsSkipped": Number,
  "testsSucceeded": Number
}
    testsFailed Nombre de tests ayant échoué générés. Les causes de l’échec sont répertoriées dans la table Tests générés [sn_atf_tg_generated_test].

    Type de données : nombre
    testsInProgress Nombre de cas d’utilisation en cours de création.

    Type de données : nombre
    testsEn attente Nombre de cas d’utilisation restant à générer.

    Type de données : nombre
    testsIgnoré Nombre de tests ignorés en raison de l’annulation d’une tâche.

    Type de données : nombre
    testsSucceeded Nombre de tests générés avec succès.

    Type de données : nombre

    L’exemple suivant montre comment démarrer la génération de tests pour la table d’incidents, obtenir la progression et annuler la génération des tests. Dans le champ d’application global, utilisez l’espace de noms sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
  "tableEncodedQuery": "nameISincident",
  "catalogEncodedQuery": "sysIdISEMPTY",
  "maxTestCount": 10
});

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

CloudRunnerAPI.TestGenerationAPI.cancelJob({"snboqId": snboqId});

    Sortie :

    {
  "testsSucceeded": 4,
  "testsFailed": 2,
  "testsPending": 2,
  "testsInProgress": 8,
  "testsSkipped": 0
}

    TestGenerationApi – startJob(String tableEncodedQuery, String userEncodedQuery, String catalogEncodedQuery, Number maxTestCount, Number maxTestCountPerTable, Number maxTestCountPerItem, String email)

    Insère un enregistrement dans la table File d’attente Orchestration du navigateur (BOQ) [sn_atf_tg_sn_boq] pour démarrer une tâche de test.

    Tableau 5. Paramètres
    Nom Type Description
    catalogEncodedQuery Chaîne Facultatif. Requête codée spécifiant les éléments de catalogue (CI) sur lesquels générer des tests.

    Par défaut : Tous les CI (chaîne vide)
    E-mail Chaîne Facultatif. Adresse e-mail à laquelle envoyer une notification lorsque la génération des tests est terminée.

    Par défaut : pas d’e-mail (chaîne vide)
    maxTestCount (en anglais seulement) Numéro Facultatif. Nombre maximal de tests à générer.

    Valeurs possibles : 1-9999

    Par défaut : 9999 (valeur maximale)
    maxTestCountPerTable Numéro Facultatif. Nombre maximal de tests à générer par table.

    Valeurs possibles : 1-10

    Par défaut : 10 (valeur maximale)
    maxTestCountPerItem Numéro Facultatif. Nombre maximum de tests à générer par CI.

    Valeurs possibles : 1-10

    Par défaut : 10 (valeur maximale)
    separateUpdateSetPerScope Booléen

    Facultatif. Marqueur indiquant s’il faut séparer les tests générés en suites, ensembles de mises à jour et champs d’application respectifs, ou placer les tests dans une suite, un ensemble de mises à jour et un champ d’application.

    Valeurs valides :
    • true : les tests sont placés dans leur suite et leur ensemble de mises à jour respectifs en fonction du champ d’application de chaque table ou élément de catalogue.
    • false : tous les tests générés sont placés dans la même suite, ensemble de mises à jour et champ d’application. Si la valeur est définie sur Faux, scopeForGeneratingTests cette option est requise dans la demande.

    Valeur par défaut : true
    scopeForGeneratingTests Chaîne Requis quand separateUpdateSetPerScope est défini sur faux. Sys_id du périmètre dans lequel placer tous les tests générés.

    Par défaut : aucune sys_id (chaîne vide)
    tableEncodedQuery Chaîne Facultatif. Requête codée spécifiant les tables sur lesquelles générer des tests. Consultez Encoded query strings.

    Par défaut : toutes les tables (chaîne vide)
    userEncodedQuery Chaîne Facultatif. Requête codée spécifiant les utilisateurs sur lesquels générer des tests.

    Par défaut : tous les utilisateurs (chaîne vide)
    Tableau 6. Renvoie
    Type Description
    Chaîne Le 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 la génération de tests pour la table d’incidents. Dans le champ d’application global, utilisez l’espace de noms sn_atf_tg.

    var insertedSnboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
  tableEncodedQuery: "nameISincident",
  catalogEncodedQuery: "sysIdISEMPTY",
  maxTestCount: 10
});

gs.info(insertedSnboqId);

    Sortie :

    <sys_id of inserted BOQ record>