Création d'un script de pipeline à partir de Jenkins

Vous devez créer un script de pipeline pour exécuter des actifs de test à partir de Jenkins Pipeline projet.

Vous devez avoir accompli les tâches suivantes:

Vous devez renseigner certaines valeurs de champs dans l’interface Jenkins pour exécuter des tests depuis Jenkins. Les champs minimaux à configurer avec Name sont Workspace, Project et Test Suite Name ou Config File. Les autres champs sont facultatifs.

Par exemple, si vous fournissez dans le champ Config File un chemin complet vers un fichier de configuration contenant les paramètres pour l’exécution d’un test ou d’un plan, vous n’avez pas besoin de renseigner les champs Workspace, Project et Test Suite Name.

Note:
Si Test Performance n'est pas installé dans l'emplacement par défaut, alors vous devez fournir la valeur pour le champ Emplacement IMShared ainsi que pour les autres champs obligatoires.
  1. Ouvrez votre projet Jenkins Pipeline à partir de la liste.
  2. Cliquez sur Configurer, puis sélectionnez l'onglet Pipeline.
  3. Cliquez sur Syntaxe des pipelines pour générer un script de pipeline.
  4. Sélectionnez le étape: étape de construction générale option dans la liste déroulante du Exemple d'étape champ.
  5. Sélectionnez le Exécuter le test de performances IBM DevOps Test option dans la liste déroulante du Étape de construction champ.
  6. Fournissez les détails de l’exécution de test pour les champs en vous référant au tableau suivant :

    Le tableau suivant répertorie les champs obligatoires que vous pouvez renseigner pour exécuter le test depuis Jenkins :

    Champs Description
    Fichier de configuration

    Saisissez le chemin complet vers un fichier qui contient les paramètres pour l'exécution d'un test ou d'un planning.

    Par exemple, C:\Users\IBM\devopstest\workspace\Project1\config.txt

    Pour plus d'informations sur la création d'un fichier de configuration en ligne de commande à partir de Test Performance, voir la section Informations connexes.

    Remember:
    Si vous fournissez un chemin complet d'un fichier de configuration dans le champ Fichier de configuration, vous n'avez alors pas besoin de fournir des valeurs pour les champs Espace de travail, Projet et Nom de la suite de test.
    Nom

    Saisissez le nom de l’étape de build Jenkins.

    Par exemple, testrun1
    Projet

    Saisissez le nom du projet qui contient des ressources de Test Performance.

    Par exemple, testproj1
    Nom de la suite de tests

    Saisissez le nom de fichier des ressources de test de performance, relatif au projet.

    Par exemple, test1.testsuite
    Espace de travail

    Entrez le chemin complet de l’espace de travail Eclipse.

    Par exemple, C:/Users/IBM/devopstest/workspace1

    Le tableau suivant répertorie les champs facultatifs que vous pouvez renseigner pour exécuter le test depuis Jenkins :

    Champs Description
    Fichiers de format de rapport personnalisé

    Utilisez ce champ pour indiquer les ID des rapports que vous souhaitez exporter à la place des rapports par défaut.

    Vous pouvez fournir plusieurs ID de rapport séparés par une virgule. Vous pouvez accéder aux Préférences de Test Performance (Window > Preferences > Test > Performance Test Reports > Export Reports), puis cocher la case Afficher les ID de rapport pour afficher les ID de rapport.

    Vous devez utiliser le champ Fichiers de format de rapport personnalisé conjointement avec le champ Fichier de données de rapport statistique exporté ou Rapport statistique exporté en HTML.

    Par exemple, vous pouvez fournir http comme valeur dans le champ Custom Report Format Files pour exporter un rapport de performance.
    Remplacement de l’ensemble de données

    Utilisez ce champ pour remplacer les valeurs du jeu de données lors de l'exécution d'un test ou d'un planning.

    Vous devez vous assurer que les jeux de données d'origine et de remplacement se trouvent dans le même espace de travail et ont les mêmes noms de colonnes. Lorsque vous saisissez une valeur pour le champ Dataset Override, vous devez également inclure le chemin vers le jeu de données. Vous devez fournir les valeurs pour le champ Dataset Override dans le format suivant :

    /project_name/ds_path/original_ds.csv:/project_name/ds_path/new_ds.csv

    Par exemple, /proj1/Datasets/ds1.csv:/proj1023/Datasets/new_ds1.csv

    Vous pouvez remplacer plusieurs jeux de données qui sont enregistrés dans un projet différent en ajoutant plusieurs chemins vers le jeu de données séparés par un point-virgule. Pour un test ou un planning, la valeur par défaut est le jeu de données spécifié dans le Test Editor ou l'éditeur de planning.
    Durée

    Utilisez ce champ pour modifier la durée des étapes dans le planning de taux.

    Par exemple, Stage1=10s, Stage2=3m

    Le numéro d'étape spécifié doit exister dans le planning de taux.

    Note:
    Le champ Durée crée une nouvelle copie du planning de taux qui contient la durée spécifiée.
    Fichier de journal de test HTTP exporté

    Utilisez ce champ pour spécifier le chemin du répertoire de fichiers où stocker le journal de test HTTP exporté au format .txt.

    Par exemple, C:/Users/Documents/Jenkins/logexp.txt

    Note:
    Si vous ne spécifiez pas de valeur pour le Fichier de journal de test HTTP exporté, alors aucun journal de l’exécution du test n’est stocké dans le répertoire Jenkins workspace/temp.
    Fichier de données de rapport statistique exporté

    Utilisez ce champ pour fournir le chemin complet d’un répertoire que vous pouvez utiliser pour stocker les rapports exportés au format CSV (valeurs séparées par des virgules).

    Par exemple, C:/Users/Documents/tests

    Note:
    Si vous ne spécifiez aucune valeur pour le champ Custom Report Format Files, les rapports que vous avez sélectionnés dans les Préférences de Test Performance (Window > Preferences > Test > Performance Test Reports > Export Reports) sont exportés.
    Format de rapport statistique exporté

    Utilisez ce champ pour spécifier un format pour le rapport que vous souhaitez exporter.

    Vous devez utiliser au moins une des options suivantes avec le champ Exported Statistical Report Data File :

    • simple.csv

    • full.csv

    • simple.json

    • full.json

    • csv

    • json

    Par exemple, json.

    Vous pouvez ajouter plusieurs formats pour le rapport, séparés par une virgule. Lorsque vous souhaitez exporter à la fois les types de rapport simple et complet au format json ou csv, vous pouvez spécifier json ou csv comme format dans le champ.

    Les rapports sont enregistrés à l’emplacement spécifié dans le champ Exported Statistical Report Data File.

    Note:
    Les valeurs fournies dans le champ Format de rapport statistique exporté priment toujours sur les options Exporter les rapports définies dans les préférences du produit (Window > Preferences > Test > Performance Test Reports > Export Reports).
    Rapport statistique exporté en HTML

    Utilisez ce champ pour fournir le chemin complet d’un répertoire que vous pouvez utiliser pour exporter des résultats d’analyse Web.

    Les résultats sont exportés vers le répertoire spécifié. Vous pouvez analyser les résultats dans un navigateur Web sans utiliser Test Performance.

    Par exemple, C:/Users/Documents/Reports

    Note:
    Lorsque vous n’utilisez pas le champ Rapport statistique exporté en HTML, le rapport de performance est stocké dans un répertoire workspace/temp.
    Historique

    Utilisez ce champ lorsque vous souhaitez afficher un enregistrement de tous les événements survenus pendant l’exécution d’un test ou d’une planification.

    Vous pouvez utiliser l’une des options suivantes :
    • jaeger : Pour envoyer les journaux de test à l’interface Jaeger pendant l’exécution d’un test ou d’une planification.
      Note:
      Vous devez définir la propriété JAEGER_AGENT_HOST comme variable d’environnement en utilisant la ligne de commande avant d’utiliser l’option jaeger pour envoyer les journaux de test à l’interface Jaeger.

    • testlog : Pour envoyer les journaux de test comme journaux de test traditionnels dans Test Performance pendant l’exécution d’un test ou d’une planification.

    • null : Pour n’envoyer aucun journal de test ni à l’interface Jaeger ni à Test Performance pendant l’exécution d’un test ou d’une planification.

    Par exemple, jaeger

    Vous pouvez ajouter plusieurs options séparées par une virgule pour envoyer les journaux de test pendant l’exécution d’un test ou d’une planification vers Test Performance et l’interface Jaeger.

    Par exemple, jaeger,testlog

    Pour plus d’informations sur la façon d’afficher les journaux de test dans l’interface Jaeger et dans Test Performance, voir la section Informations connexes.
    Emplacement IMShared

    Saisissez le chemin complet vers le répertoire IMShared, s’il ne se trouve pas à l’emplacement par défaut.

    Par exemple, D:\Testtool\IBM\IBMIMShared

    L’emplacement par défaut du répertoire IMShared est le suivant :
    Système d’exploitation Chemin par défaut vers le répertoire
    Windows® C:\Program Files\IBM\IBMIMShared
    Linux™ /opt/IBM/IBMIMShared
    Mac /Application/IBM/IBMIMShared
    Libellés

    Utilisez ce champ pour ajouter des libellés aux résultats de test lorsque l’exécution du test est terminée.

    Par exemple, label1, label2

    Vous pouvez ajouter plusieurs libellés à un résultat de test, séparés par une virgule. Lorsque vous exécutez des actifs de test, les libellés que vous avez ajoutés s’affichent dans le rapport de performance dans Test Performance.

    La page Résultats de Test Hub affiche le libellé que vous avez ajouté dans le champ Labels pour l’actif de test spécifique dans les conditions suivantes :

    • Lorsque vous définissez Publier le résultat après l’exécution sur Toujours ou Invite dans les Préférences de Test Performance (Windows > Preferences > Test > DevOps Test Hub).

    • Lorsque vous utilisez le champ Labels avec le champ Publish.

    Note:
    Lorsque vous exécutez des tests en utilisant des guillemets doubles (« ») pour le champ Labels, les libellés dans le résultat de test n’incluent alors pas les guillemets doubles.

    Par exemple, si vous indiquez pour le champ Labels la valeur « 100 » utilisateurs, alors les libellés affichent 100 utilisateurs dans le résultat de test.

    Pour contourner ce problème, vous devez créer un fichier de configuration en ligne de commande, puis exécuter le test en utilisant le champ Config File.
    Nombre d’utilisateurs virtuels

    Utilisez ce champ pour remplacer le nombre par défaut d’utilisateurs virtuels lors de l’exécution du test ou du plan.

    Pour un plan, la valeur par défaut est le nombre d’utilisateurs spécifié dans l’éditeur de plan, et pour un test, la valeur par défaut est d’un utilisateur.

    Note:
    Le champ Number of Virtual Users crée une nouvelle copie du plan qui contient le nombre d’utilisateurs spécifié.
    Écraser le fichier de résultats

    Cochez ou décochez ce champ pour déterminer si un fichier de résultats portant le même nom doit être écrasé ou non.

    L’état par défaut du champ est sélectionné. Par conséquent, le fichier est écrasé et conserve le même nom de fichier.
    Publier

    Utilisez ce champ pour publier les résultats des tests vers Test Hub depuis Jenkins.

    Remember:
    Avant d’utiliser le champ Publish, vous devez fournir le jeton utilisateur hors ligne de Test Hub en utilisant l’une des méthodes suivantes :

    • Définissez la valeur de la variable d’environnement RTCP_OFFLINE_TOKEN sur le jeton utilisateur hors ligne de Test Hub à l’aide de l’interface de ligne de commande.

    • Fournissez le jeton utilisateur hors ligne de Test Hub dans les préférences de Test Performance (Window > Preferences > Test > DevOps Test Hub)

    Vous devez utiliser l’une des valeurs suivantes dans le champ Publish :

    • serverURL#project.name=name_of_the_project&teamspace.name=name_of_the _teamspace

    • serverURL#project.name=name_of_the_project&teamspace.alias=name_of_the _teamspace_alias

    • no

      L’option no est utile si les préférences du produit sont définies pour publier les résultats, mais que vous ne souhaitez pas les publier.

    Par exemple, URL_OF_ Test Hub#project.name=test&teamspace.name=ts1

    Où :

    • URL_OF_Test Hub est l’URL de Test Hub.

    • test est le nom du projet dans Test Hub.

    • ts1 est le nom de l’espace d’équipe.

    Notes:

    • Si vous avez un projet portant le même nom dans différents espaces d’équipe, vous devez alors ajouter les options &teamspace.name=name_of_the _teamspace ou &teamspace.alias=name_of_the_teamspace_alias.

    • Si le nom du projet ou de l’espace d’équipe contient un caractère spécial, vous devez alors le remplacer par %<Hexvalue_of_special_character>.

      Par exemple, si le nom de l’espace d’équipe est Initial Team Space, vous devez alors l’indiquer comme Intial%20Team%20Space.

      Où %20 est la valeur hexadécimale du caractère Espace.

    • Les valeurs fournies dans le champ Publish priment toujours sur les options Results définies dans les préférences du produit (Window > Preferences > Test > DevOps Test Hub > Results).

    La section Informations sur les rapports sur la page Sortie de la console affiche les noms des rapports avec leurs URL correspondantes dans les conditions suivantes :
    • Lorsque vous avez configuré l’URL de Test Hub dans les Préférences de Test Performance (Window > Preferences > Test > DevOps Test Hub).
    • Lorsque vous définissez Publish result after execution sur Always ou Prompt dans les Préférences de Test Performance (Window > Preferences > Test > DevOps Test Hub > Results).
    • Lorsque vous avez utilisé le champ Publish, ou le champ Publish conjointement avec le champ Publishreports.
    Publier_pour

    Utilisez ce champ pour publier les résultats des tests vers Test Hub depuis Jenkins en fonction de l’état d’achèvement des tests.

    Vous devez utiliser le champ Publish_for conjointement avec le champ Publish. Vous pouvez ajouter plusieurs options séparées par une virgule. Voici les options disponibles que vous pouvez utiliser pour le champ Publish_for :

    • ALL : Vous pouvez utiliser cette option quel que soit l’état du test.

    • PASS : Vous pouvez utiliser cette option pour publier les résultats des tests qui ont réussi.

    • FAIL : Vous pouvez utiliser cette option pour publier les résultats des tests qui ont échoué.

    • ERROR : Vous pouvez utiliser cette option pour publier les résultats des tests qui ont comporté des erreurs.

    • INCONCLUSIVE : Vous pouvez utiliser cette option pour publier les résultats des tests non concluants.

    Par exemple, FAIL,ERROR
    Publier_rapports

    Utilisez ce champ pour publier des résultats de test spécifiques vers Test Hub.

    Les options que vous pouvez utiliser avec Publishreports sont les suivantes :

    • STATS

    • TESTLOG

    Par exemple, STATS

    Vous devez utiliser le champ Publishreports conjointement avec le champ Publish. Vous pouvez préfixer la valeur de Publishreports avec ! pour publier les rapports à l’exception de celui spécifié.

    Par exemple, !STATS
    Taux

    Utilisez ce champ pour modifier le taux du groupe rate runner.

    Par exemple, Rate Runner Group1=1/s, 3/m

    Où « Rate Runner Group1 » est le nom du groupe Rate Runner qui comporte deux étapes. Le taux souhaité pour la première étape est d’une itération par seconde et le taux pour la deuxième étape est de trois itérations par minute.
    Notes:
    • Le nom du groupe Rate Runner doit correspondre au nom dans le plan de cadence.
    • Le champ Taux crée une nouvelle copie du plan de cadence qui contient le nombre de valeurs de cadence spécifié.
    Remplacement des libellés de supervision des ressources
    Utilisez ce champ pour effectuer l’une des actions suivantes :

    • Activez l’option Resource Monitoring from Service pour un plan de performance si l’option Resource Monitoring from Service n’est pas activée depuis l’éditeur de plan dans Test Performance.

    • Ignorez les sources Resource Monitoring qui ont été définies dans le plan de performance et passez à un mode de correspondance par étiquette.

    • Remplacez un ensemble existant d’étiquettes Resource Monitoring qui avait été défini dans le plan de performance et exécutez le plan avec un nouvel ensemble d’étiquettes Resource Monitoring.

    Si vous avez ajouté une étiquette dans Test Hub pour une source Resource Monitoring telle que rm1, vous pouvez alors fournir une valeur comme dans l’exemple suivant pour collecter des données depuis la source :

    rm1

    Si votre étiquette Resource Monitoring contient une virgule (,), vous devez remplacer la virgule simple par une double virgule lors de la saisie de la valeur. Par exemple, si vous avez ajouté une étiquette à une source Resource Monitoring comme rm1,test, vous devez fournir la valeur comme dans l’exemple suivant pour collecter des données depuis la source :

    rm1,,test

    Notes:

    • Vous pouvez utiliser ce champ uniquement lorsque vous souhaitez exécuter un plan de cadence ou un plan d’utilisateurs virtuels (VU).

    • Vous pouvez ajouter plusieurs étiquettes Resource Monitoring séparées par une virgule.

    • Vous devez ajouter les étiquettes Resource Monitoring aux sources Resource Monitoring sur la page Resource Monitoring dans le projet Test Hub.
    Fichier de résultats

    Utilisez ce champ pour donner un nom différent au fichier de résultats.

    Le fichier de résultats est stocké dans le répertoire Results. Le nom par défaut du fichier de résultats est le nom du test ou du plan avec un horodatage ajouté.
    Commentaires utilisateur

    Utilisez ce champ pour ajouter le texte que vous souhaitez afficher dans la ligne Commentaires utilisateur du rapport.

    Par exemple, exécution de test avec jeu de données

    Note:
    Lorsque vous exécutez des tests en utilisant des guillemets doubles ("") pour le champ User Comments, la ligne des commentaires utilisateur d’un rapport ne contient pas de guillemets doubles.

    Par exemple, si vous renseignez le champ User Comments avec test run with "dataset", alors la ligne des commentaires utilisateur d’un rapport affiche la valeur comme test run with dataset.

    Pour contourner ce problème, vous devez créer un fichier de configuration en ligne de commande, puis exécuter le test en utilisant le champ Config File.
    Fichier Var

    Utilisez ce champ pour fournir un chemin complet vers un fichier XML qui contient des paires nom de variable/valeur.
    Arguments de VM

    Utilisez ce champ pour spécifier la taille maximale du tas pour le processus Java.

    Vous pouvez ajouter plusieurs arguments de VM séparés par une virgule.

    Échouer le job si le test ou l’un des tests qu’il contient échoue

    Indicateur permettant de préciser si le job doit être marqué comme ayant échoué lorsque le test, ou tout test enfant au sein du test, échoue.
  7. Cliquez sur Générer un script de pipeline et copiez le script que vous avez créé pour l'étape de génération afin de l'utiliser dans l'exemple de script.
    Note:

    Vous avez besoin de ce script généré pour entrer à l'étape 5.c dans le sujet suivant:

    Configuration du projet Pipeline à l'aide de l'exemple de script

Vous avez créé le script de pipeline.
Vous pouvez configurer le Pipeline projet en utilisant le Script de pipeline option. Voir Configuration du projet Pipeline à l'aide de l'exemple de script.