Configurer manuellement votre workflow CI/CD pour exécuter des tests de charge

Article
12/15/2023

Vous pouvez automatiser un test de charge dans Azure Load Testing en créant un pipeline CI/CD. Dans cet article, vous allez apprendre à configurer manuellement GitHub Actions, Azure Pipelines ou d’autres outils CI pour appeler un test existant dans Azure Load Testing. Automatisez un test de charge pour valider en continu les performances et la stabilité de votre application sous charge.

Pour ajouter un test de charge existant à un pipeline CI/CD :

Configurez l’authentification de service pour permettre à l’outil CI de se connecter à votre ressource de test de charge Azure.
Ajoutez des fichiers d’entrée de test de charge à votre référentiel, tels que le script de test JMeter et la configuration YAML du test de charge.
Mettez à jour la définition de pipeline CI/CD pour appeler le test de charge Azure.

Prérequis

Compte Azure avec un abonnement actif. Créez un compte gratuitement.
Un Test de charge Azure. Créez un test de charge basé sur une URL ou utilisez un script JMeter existant pour créer un test de charge.

Une organisation et un projet Azure DevOps. Si vous ne possédez pas d’organisation Azure DevOps, vous pouvez en créer une gratuitement. Si vous avez besoin d’aide pour prendre en main Azure Pipelines, consultez Créer votre premier pipeline.

Configurer l’authentification au service

Pour exécuter un test de charge dans votre workflow CI/CD, vous devez accorder au workflow CI/CD l’autorisation d’accéder à votre ressource de test de charge. Créez un principal de service pour le workflow CI/CD et attribuez le rôle RBAC Azure de contributeur au test de charge.

Créer une connexion de service dans Azure Pipelines

Dans Azure Pipelines, créez une connexion de service dans votre projet Azure DevOps pour accéder aux ressources de votre abonnement Azure. Lorsque vous créez la connexion de service, Azure DevOps crée un objet principal de service Microsoft Entra.

Connectez-vous à votre organisation Azure DevOps (https://dev.azure.com/<your-organization>) et sélectionnez votre projet.

Remplacez l’espace réservé de texte <your-organization> par votre identificateur de projet.
Sélectionnez Paramètres de projet>Connexions de service>+ Nouvelle connexion de service.
Dans le volet Nouvelle connexion de service, sélectionnez Azure Resource Manager, puis sélectionnez Suivant.
Sélectionnez la méthode d’authentification Principal de service (automatique), puis Suivant.

Entrez les informations de connexion de service, puis sélectionnez Enregistrer pour créer la connexion de service.

Champ	Valeur
Niveau de portée	Abonnement.
Abonnement	Sélectionnez l’abonnement Azure qui héberge votre ressource de test de charge.
Groupe de ressources	Sélectionnez le groupe de ressources qui contient votre ressource de test de charge.
Nom de la connexion de service	Saisissez un nom unique pour la connexion de service.
Accorder une autorisation d’accès à tous les pipelines	Coché.

Dans la liste des connexions de service, sélectionnez celle que vous avez précédemment créée, puis sélectionnez Gérer le principal de service.

Le portail Azure s’ouvre dans un onglet de navigateur séparé et affiche les détails du principal du service.
Copiez la valeur Nom d’affichage dans le portail Azure.

Vous utilisez cette valeur dans l’étape suivante pour accorder des autorisations d’exécution de tests de charge vers le principal de service.

Accorder l'accès au service Test de charge Azure

Le Test de charge Azure utilise le contrôle d’accès en fonction du rôle (RBAC) Azure pour accorder des autorisations afin d’effectuer des activités spécifiques sur votre ressource de test de charge. Pour exécuter un test de charge à partir de votre pipeline CI/CD, vous accordez le rôle de Contributeur au test de charge au principal de service.

Dans le Portail Azure, accédez à votre ressource de test de charge Azure.
Sélectionnez Contrôle d’accès (IAM)>Ajouter>Ajouter une attribution de rôle.
Sous l’onglet Rôle, sélectionnez Contributeur au test de charge dans la liste des rôles de fonction de travail.
Sous l’onglet Membres, choisissez Sélectionner des membres, puis utilisez le nom d’affichage que vous avez précédemment copié pour rechercher le principal de service.
Sélectionnez le principal du service, puis choisissez Sélectionner.
Dans l’onglet Passer en revue + attribuer, sélectionnez Passer en revue + attribuer pour ajouter l’attribution de rôle.

Vous pouvez maintenant utiliser la connexion de service dans votre définition de workflow Azure Pipelines pour accéder à votre ressource de test de charge Azure.

Pour accéder à votre ressource Azure Load Testing à partir du workflow GitHub Actions, vous créez d’abord un principal de service Microsoft Entra. Ce principal de service représente votre flux de travail GitHub Actions dans l’ID Microsoft Entra.

Ensuite, vous accordez des autorisations au principal de service pour créer et exécuter un test de charge avec votre ressource Test de charge Azure.

Créer un principal du service

Créez un principal de service dans l’abonnement Azure et attribuez le rôle de Contributeur au test de charge afin que votre workflow GitHub Actions ait accès à votre ressource de test de charge Azure pour effectuer des tests de charge.

Créez un principal de service et attribuez le rôle Load Test Contributor :

# Get the resource ID for the load testing resource - replace the text place holders.
loadtest=$(az resource show -g <resource-group-name> -n <load-testing-resource-name> --resource-type "Microsoft.LoadTestService/loadtests" --query "id" -o tsv)
echo $loadtest

# Create a service principal and assign the Load Test Contributor role - the scope is limited to the load testing resource.
az ad sp create-for-rbac --name "my-load-test-cicd" --role "Load Test Contributor" \
                         --scopes $loadtest \
                         --json-auth

La sortie est un objet JSON qui représente le principal de service. Vous utilisez ces informations pour vous authentifier auprès d’Azure dans le workflow GitHub Actions.

Creating 'Load Test Contributor' role assignment under scope
{
  "clientId": "00000000-0000-0000-0000-000000000000",
  "clientSecret": "00000000-0000-0000-0000-000000000000",
  "subscriptionId": "00000000-0000-0000-0000-000000000000",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "activeDirectoryEndpointUrl": "https://login.microsoftonline.com",
  "resourceManagerEndpointUrl": "https://management.azure.com/",
  "activeDirectoryGraphResourceId": "https://graph.windows.net/",
  "sqlManagementEndpointUrl": "https://management.core.windows.net:8443/",
  "galleryEndpointUrl": "https://gallery.azure.com/",
  "managementEndpointUrl": "https://management.core.windows.net/"    
}

Notes

Il est possible que vous ayez un avertissement de dépréciation --sdk-auth lorsque vous exécutez cette commande. Vous pouvez également utiliser l’authentification basée sur OpenID Connect (OIDC) pour authentifier GitHub avec Azure. Apprenez comment utiliser l’action Azure login avec OpenID Connect.

Copiez l’objet JSON de sortie dans le presse-papiers.

Dans l’étape suivante, vous stockez les informations de principal de service en tant que secret GitHub Actions.

Stocker les informations d’identification Azure dans le secret GitHub Actions

Créez un secret GitHub Actions pour stocker en toute sécurité les informations du principal de service. Vous utilisez ce secret dans votre définition de workflow pour vous connecter à l’authentification auprès d’Azure et accéder à votre ressource de test de charge Azure.

Notes

Si vous utilisez OpenID Connect pour vous authentifier auprès d’Azure, vous n’avez pas besoin de transmettre l’objet principal de service dans l’action de connexion Azure. Apprenez comment utiliser l’action Azure login avec OpenID Connect.

Pour créer un secret GitHub Actions :

Dans GitHub, naviguez vers votre référentiel.
Sélectionnez Paramètres> Secrets & variables>Actions.
Sélectionnez Nouveau secret de référentiel, entrez les informations de secret, puis sélectionnez Ajouter un secret pour créer un nouveau secret.

Champ Valeur

Nom AZURE_CREDENTIALS

Secret Collez la sortie JSON de la commande de création du principal de service que vous avez précédemment copiée.

Champ	Valeur
Nom	AZURE_CREDENTIALS
Secret	Collez la sortie JSON de la commande de création du principal de service que vous avez précédemment copiée.

Vous pouvez désormais accéder à votre abonnement Azure et à votre ressource de test de charge à partir de votre workflow GitHub Actions à l’aide des informations d’identification stockées.

Si vous utilisez un autre outil CI/CD, vous utilisez Azure CLI pour interagir avec vos ressources Azure. Procédez comme suit pour autoriser l’accès de l’outil CI à votre ressource de test de charge :

Créez un principal de service Microsoft Entra pour vous connecter à votre abonnement Azure et accéder à votre ressource de test de charge Azure.
Accordez aux principaux de service les autorisations nécessaires pour créer et exécuter un test de charge en affectant le rôle Contributeur de test de charge.
Stockez les informations d’identification Azure en toute sécurité dans l’outil CI.

Procédez comme suit pour configurer l’autorisation de service pour votre outil CI :

Créez un principal de service et attribuez le rôle Contributeur de test de charge :

Remplacez les <resource-group-name> espaces réservés et <load-testing-resource-name> les espaces réservés de texte.

# Get the resource ID for the load testing resource - replace the text place holders.
loadtest=$(az resource show -g <resource-group-name> -n <load-testing-resource-name> --resource-type "Microsoft.LoadTestService/loadtests" --query "id" -o tsv)
echo $loadtest

# Create a service principal and assign the Load Test Contributor role - the scope is limited to the load testing resource.
az ad sp create-for-rbac --name "my-load-test-cicd" --role "Load Test Contributor" \
                         --scopes $loadtest \
                         --json-auth

La sortie est un objet JSON qui représente le principal de service.

Creating 'Load Test Contributor' role assignment under scope
{
  "clientId": "00000000-0000-0000-0000-000000000000",
  "clientSecret": "00000000-0000-0000-0000-000000000000",
  "subscriptionId": "00000000-0000-0000-0000-000000000000",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "activeDirectoryEndpointUrl": "https://login.microsoftonline.com",
  "resourceManagerEndpointUrl": "https://management.azure.com/",
  "activeDirectoryGraphResourceId": "https://graph.windows.net/",
  "sqlManagementEndpointUrl": "https://management.core.windows.net:8443/",
  "galleryEndpointUrl": "https://gallery.azure.com/",
  "managementEndpointUrl": "https://management.core.windows.net/"    
}

Copiez les clientIdvaleurs , clientSecretet tenantId stockez-les en toute sécurité en tant que secrets dans votre outil CI.

Vous utilisez ces valeurs pour vous connecter à votre abonnement Azure avec la commande Azure CLI az login .

Ajouter des fichiers de test de charge dans votre référentiel

Pour exécuter un test de charge avec Azure Load Testing dans un flux de travail CI/CD, vous devez ajouter tous les fichiers d’entrée de test de charge dans votre référentiel de contrôle de code source.

Si vous n’avez pas de test de charge existant, ajoutez les fichiers suivants à votre référentiel de code source :

Fichier YAML de configuration de test de charge. Découvrez comment créer un fichier YAML de configuration de test de charge.
Fichier de plan de test. Pour les tests JMeter, ajoutez un script de test JMeter (JMX fichier). Pour les tests basés sur des URL, ajoutez un fichier JSON de requête.
Tous les fichiers de propriétés utilisateur JMeter.
Tous les fichiers de données d’entrée utilisés par votre plan de test. Par exemple, les fichiers de données CSV.

Si vous avez un test de charge existant, vous pouvez télécharger les paramètres de configuration et tous les fichiers d’entrée directement à partir du Portail Azure. Effectuez les étapes suivantes pour télécharger les fichiers d’entrée d’un test de charge existant dans le Portail Azure :

Dans le Portail Azure, accédez à votre ressource de test de charge Azure.
Dans le volet de gauche, sélectionnez Tests pour afficher la liste des tests, puis sélectionnez votre test.
Sélectionnez les points de suspension (...) en regard de la série de tests de charge sur laquelle vous travaillez, puis sélectionnez Télécharger le fichier d’entrée.

Le navigateur télécharge un dossier compressé qui contient les fichiers d’entrée de test de charge.
Utilisez n’importe quel outil de compression pour extraire les fichiers d’entrée.

Ce dossier contient les fichiers suivants :
- config.yaml : fichier de configuration de test de charge YAML. Vous référencez ce fichier dans la définition du workflow CI/CD.
- .jmx : le script de test JMeter
- Tous les fichiers d’entrée supplémentaires, tels que les fichiers CSV ou les fichiers de propriétés utilisateur nécessaires pour exécuter le test de charge.
Commitez tous les fichiers d’entrée extraits vers votre référentiel de contrôle de code source.

Utilisez le référentiel de code source dans lequel vous configurez le pipeline CI/CD.

Mettre à jour la définition de workflow CI/CD

Azure Load Testing prend en charge GitHub Actions et Azure Pipelines pour l’exécution de tests de charge.

Installer l'extension de Test de charge pour Azure DevOps

Pour créer et exécuter un test de charge, la définition du workflow Azure Pipelines utilise l’extension de tâche Test de charge Azure disponible dans la Place de marché Azure DevOps.

Ouvrez l’extension de tâche Test de charge Azure dans la Place de marché Azure DevOps, puis sélectionnez Obtenir gratuitement.
Sélectionnez votre organisation Azure DevOps, puis sélectionnez Installer pour installer l’extension.

Si vous n’avez pas de privilèges d’administrateur pour l’organisation Azure DevOps sélectionnée, sélectionnez Demander pour demander à un administrateur d’installer l’extension.

Mettre à jour le workflow Azure Pipelines

Mettez à jour votre workflow Azure Pipelines pour exécuter un test de charge pour votre ressource de test de charge Azure.

Connectez-vous à votre organisation Azure DevOps (https://dev.azure.com/<your-organization>) et sélectionnez votre projet.
Sélectionnez Pipelines dans le volet de navigation gauche, sélectionnez votre pipeline, puis sélectionnez Modifier pour modifier la définition de votre workflow.

Sinon, sélectionnez Créer un pipeline pour créer un nouveau pipeline dans Azure Pipelines.
Utilisez la tâche AzureLoadTest pour exécuter le test de charge.

Spécifiez le fichier de configuration de test de charge que vous avez précédemment exporté dans la propriété loadTestConfigFile.

Remplacez les espaces réservés de texte <load-testing-resource> et <load-testing-resource-group> par le nom de votre ressource de test de charge Azure et le groupe de ressources.
```
    - task: AzureLoadTest@1
      inputs:
        azureSubscription: $(serviceConnection)
        loadTestConfigFile: 'config.yaml'
        loadTestResource: <load-testing-resource>
        resourceGroup: <load-testing-resource-group>
```
Vous pouvez éventuellement passer des paramètres ou des secrets vers le test de charge à l’aide de la propriété env ou secrets.
Utilisez la tâche publish pour publier les résultats des tests en tant qu’artefacts dans votre exécution de workflow Azure Pipelines.
```
    - publish: $(System.DefaultWorkingDirectory)/loadTest
      artifact: loadTestResults
```

Mettre à jour le workflow GitHub Actions

Mettez à jour votre workflow GitHub Actions pour exécuter un test de charge pour votre ressource de test de charge Azure.

Dans GitHub, naviguez vers votre référentiel.
Modifiez votre workflow GitHub Actions ou créez un nouveau workflow dans votre référentiel GitHub.
Utilisez l’action actions/checkout pour case activée le référentiel avec les fichiers d’entrée de test de charge.
```
    - name: Checkout
      uses: actions/checkout@v3
```
Utilisez l’action azure/login pour vous authentifier auprès d’Azure à l’aide des informations d’identification stockées.

Collez le contenu YAML suivant dans votre définition de workflow :
```
    - name: Login to Azure
      uses: azure/login@v1
      continue-on-error: false
      with:
        creds: ${{ secrets.AZURE_CREDENTIALS }}
```
Utilisez l’action azure/load-testing pour exécuter le test de charge.

Spécifiez le fichier de configuration de test de charge que vous avez précédemment exporté dans la propriété loadTestConfigFile.

Remplacez les espaces réservés de texte <load-testing-resource> et <load-testing-resource-group> par le nom de votre ressource de test de charge Azure et le groupe de ressources.
```
    - name: 'Azure Load Testing'
      uses: azure/load-testing@v1
      with:
        loadTestConfigFile: 'config.yaml'
        loadTestResource: <load-testing-resource>
        resourceGroup: <load-testing-resource-group>
```
Vous pouvez éventuellement passer des paramètres ou des secrets vers le test de charge à l’aide de la propriété env ou secrets.
Utilisez l’action actions/upload-artifact pour publier les résultats de test en tant qu’artefacts dans votre exécution de workflow GitHub Actions.
```
    - uses: actions/upload-artifact@v2
      with:
        name: loadTestResults
        path: ${{ github.workspace }}/loadTest
```

Mettez à jour votre flux de travail CI pour exécuter un test de charge pour votre ressource de test de charge Azure à l’aide d’Azure CLI. Utilisez les spécificités de votre outil CI pour ajouter les commandes suivantes à votre flux de travail CI :

Connectez-vous à l’abonnement Azure à l’aide du principal de service.

Utilisez les clientIdvaleurs , clientSecretet tenandId les valeurs que vous avez stockées précédemment.
```
az login --service-principal -u $AZURE_CLIENT_ID -p $AZURE_CLIENT_SECRET -t $AZURE_TENANT_ID
az account set -s $AZURE_SUBSCRIPTION_ID
```
Créez un test de charge à l’aide du fichier YAML de configuration de test de charge.

Remplacez les <load-testing-resource>espaces réservés , <load-testing-resource-group>et <load-test-config-yaml> texte par le nom de la ressource de test de charge, le nom du groupe de ressources et le nom de fichier du fichier YAML de configuration de test de charge que vous avez ajouté au référentiel précédemment.
```
az load test create --load-test-resource <load-testing-resource> --resource-group <load-testing-resource-group> --test-id sample-test-id --load-test-config-file <load-test-config-yaml>
```

Exécutez le test de charge.

testRunId="run_"`date +"%Y%m%d%_H%M%S"`
displayName="Run"`date +"%Y/%m/%d_%H:%M:%S"`

az load test-run create --load-test-resource <load-testing-resource> --test-id sample-test-id --test-run-id $testRunId --display-name $displayName --description "Test run from CLI"

Récupérez et affichez les métriques côté client pour l’exécution du test de charge.

az load test-run metrics list --load-test-resource <load-testing-resource> --test-run-id $testRunId --metric-namespace LoadTestRunMetrics

Voir les résultats des tests de charge

Lorsque vous exécutez un test de charge à partir de votre pipeline CI/CD, vous pouvez afficher les résultats récapitulatifs directement dans le journal de sortie CI/CD. Si vous avez publié les résultats de test en tant qu’artefact de pipeline, vous pouvez également télécharger un fichier CSV pour créer des rapports supplémentaires.

Screenshot that shows the workflow logging information.

Nettoyer les ressources

Si vous n’avez pas l’intention d’utiliser les ressources que vous avez créées, supprimez-les pour éviter la facturation de frais supplémentaires.

Supprimer les modifications d’Azure Pipelines :
1. Connectez-vous à votre organisation Azure DevOps (https://dev.azure.com/<your-organization>) et sélectionnez votre projet.
  
  Remplacez l’espace réservé de texte <your-organization> par votre identificateur de projet.
2. Si vous avez créé un pipeline » :
  1. Sélectionnez Pipelines, puis choisissez votre pipeline.
  2. Sélectionnez les points de suspension, puis sélectionnez Supprimer.
  3. Entrez le nom du pipeline, puis sélectionnez Supprimer pour supprimer le pipeline.
3. Si vous avez modifié une définition de workflow existante, annulez les modifications pour l’exécution du test de charge et enregistrez le workflow.
Supprimez la connexion de service :
1. Sélectionnez Paramètres de projet>Connexions de service, puis sélectionnez votre connexion de service.
2. Sélectionnez Modifier>Supprimer pour supprimer la connexion de service.

Supprimez les modifications GitHub Actions :
1. Dans GitHub, naviguez vers votre référentiel.
2. Si vous avez créé une nouvelle définition de workflow, supprimez le fichier YAML du workflow dans le dossier .github/workflows.
3. Si vous avez modifié une définition de workflow existante, annulez les modifications pour l’exécution du test de charge et enregistrez le workflow.

Supprimez le principal de service :

az ad sp delete --id $(az ad sp show --display-name "my-load-test-cicd" -o tsv)

Étapes suivantes

Passez à l’article suivant pour apprendre à identifier les régressions de performances en définissant des critères d’échec de test et en comparant les séries de tests.