Uw CI/CD-werkstroom handmatig configureren voor het uitvoeren van belastingstests

Artikel
12/15/2023

U kunt een belastingstest in Azure Load Testing automatiseren door een CI/CD-pijplijn te maken. In dit artikel leert u hoe u GitHub Actions, Azure Pipelines of andere CI-hulpprogramma's handmatig configureert om een bestaande test aan te roepen in Azure Load Testing. Automatiseer een belastingstest om de prestaties en stabiliteit van uw toepassing continu te valideren onder belasting.

Een bestaande belastingstest toevoegen aan een CI/CD-pijplijn:

Configureer serviceverificatie zodat het CI-hulpprogramma verbinding kan maken met uw Azure Load Testing-resource.
Voeg invoerbestanden voor belastingtests toe aan uw opslagplaats, zoals het JMeter-testscript en de YAML-configuratie voor de belastingstest.
Werk de CI/CD-pijplijndefinitie bij om Azure Load Testing aan te roepen.

Vereisten

Een Azure-account met een actief abonnement. Gratis een account maken
Een Azure Load Testing-test. Maak een op URL gebaseerde belastingstest of gebruik een bestaand JMeter-script om een belastingstest te maken.

Een Azure DevOps-organisatie en -project. Als u geen Azure DevOps-organisatie hebt, kunt u er gratis een maken. Zie Uw eerste pijplijn maken als u hulp nodig hebt bij het aan de slag gaan met Azure Pipelines.

Serviceverificatie configureren

Als u een belastingstest wilt uitvoeren in uw CI/CD-werkstroom, moet u toestemming verlenen aan de CI/CD-werkstroom om toegang te krijgen tot uw resource voor belastingstests. Maak een service-principal voor de CI/CD-werkstroom en wijs de Azure RBAC-rol Inzender voor belastingtests toe.

Een serviceverbinding maken in Azure Pipelines

In Azure Pipelines maakt u een serviceverbinding in uw Azure DevOps-project voor toegang tot resources in uw Azure-abonnement. Wanneer u de serviceverbinding maakt, maakt Azure DevOps een Microsoft Entra-service-principalobject.

Meld u aan bij uw Azure DevOps-organisatie (https://dev.azure.com/<your-organization>) en selecteer uw project.

Vervang de tijdelijke aanduiding voor tekst <your-organization> door de project-id.
Selecteer Serviceverbindingen> met Project-instellingen>+ Nieuwe serviceverbinding.
Selecteer in het deelvenster Nieuwe serviceverbinding de Azure Resource Manager en selecteer vervolgens Volgende.
Selecteer de verificatiemethode service-principal (automatisch) en selecteer vervolgens Volgende.

Voer de details van de serviceverbinding in en selecteer Opslaan om de serviceverbinding te maken.

Veld	Waarde
Bereikniveau	Abonnement.
Abonnement	Selecteer het Azure-abonnement dat als host fungeert voor uw resource voor belastingstests.
Resourcegroep	Selecteer de resourcegroep die de resource voor belastingtests bevat.
Serviceverbindingsnaam	Voer een unieke naam in voor de serviceverbinding.
Toegangsmachtigingen verlenen aan alle pijplijnen	Geselecteerd.

Selecteer in de lijst met serviceverbindingen de service die u eerder hebt gemaakt en selecteer vervolgens Service-principal beheren.

Azure Portal wordt geopend in een afzonderlijk browsertabblad en toont de details van de service-principal.
Kopieer in Azure Portal de waarde van de weergavenaam .

U gebruikt deze waarde in de volgende stap om machtigingen te verlenen voor het uitvoeren van belastingstests aan de service-principal.

Toegang verlenen tot Azure Load Testing

Azure Load Testing maakt gebruik van Azure RBAC om machtigingen te verlenen voor het uitvoeren van specifieke activiteiten op uw resource voor belastingstests. Als u een belastingstest wilt uitvoeren vanuit uw CI/CD-pijplijn, verleent u de rol Inzender voor belastingtests aan de service-principal.

Ga in Azure Portal naar uw Azure Load Testing-resource.
Selecteer Toegangsbeheer (IAM)>Roltoewijzing toevoegen.>
Selecteer op het tabblad Rol de optie Inzender voor belastingtests in de lijst met functierollen.
Selecteer leden selecteren op het tabblad Leden en gebruik vervolgens de weergavenaam die u eerder hebt gekopieerd om de service-principal te doorzoeken.
Selecteer de service-principal en selecteer vervolgens Selecteren.
Selecteer Op het tabblad Beoordelen en toewijzen de optie Beoordelen en toewijzen om de roltoewijzing toe te voegen.

U kunt nu de serviceverbinding in uw Azure Pipelines-werkstroomdefinitie gebruiken om toegang te krijgen tot uw Azure Load Testing-resource.

Als u toegang wilt krijgen tot uw Azure Load Testing-resource vanuit de GitHub Actions-werkstroom, maakt u eerst een Microsoft Entra-service-principal. Deze service-principal vertegenwoordigt uw GitHub Actions-werkstroom in Microsoft Entra-id.

Vervolgens verleent u machtigingen aan de service-principal om een belastingstest te maken en uit te voeren met uw Azure Load Testing-resource.

Een service-principal maken

Maak een service-principal in het Azure-abonnement en wijs de rol Inzender voor belastingtests toe, zodat uw GitHub Actions-werkstroom toegang heeft tot uw Azure-resource voor belastingstests om belastingstests uit te voeren.

Maak een service-principal en wijs de Load Test Contributor rol toe:

# 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

De uitvoer is een JSON-object dat de service-principal vertegenwoordigt. U gebruikt deze informatie om te verifiëren met Azure in de GitHub Actions-werkstroom.

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/"    
}

Notitie

Mogelijk krijgt u een --sdk-auth waarschuwing over afschaffing wanneer u deze opdracht uitvoert. U kunt ook op OpenID Verbinding maken (OIDC) gebaseerde verificatie gebruiken voor het verifiëren van GitHub met Azure. Meer informatie over het gebruik van de azure-aanmeldingsactie met OpenID Verbinding maken.

Kopieer het JSON-uitvoerobject naar het klembord.

In de volgende stap slaat u de gegevens van de service-principal op als een GitHub Actions-geheim.

Azure-referenties opslaan in gitHub Actions-geheim

Maak een GitHub Actions-geheim om de gegevens van de service-principal veilig op te slaan. U gebruikt dit geheim in uw werkstroomdefinitie om verbinding te maken met verificatie met Azure en toegang te krijgen tot uw Azure Load Testing-resource.

Notitie

Als u OpenID Verbinding maken gebruikt om te verifiëren met Azure, hoeft u het service-principal-object niet door te geven in de azure-aanmeldingsactie. Meer informatie over het gebruik van de azure-aanmeldingsactie met OpenID Verbinding maken.

Een GitHub Actions-geheim maken:

Blader in GitHub naar uw opslagplaats.
Selecteer Instellingen> Secrets & variables>Actions.
Selecteer Nieuw opslagplaatsgeheim, voer de geheime gegevens in en selecteer vervolgens Geheim toevoegen om een nieuw geheim te maken.

Veld Weergegeven als

Naam AZURE_CREDENTIALS

Geheim Plak de JSON-uitvoer van de opdracht voor het maken van de service-principal die u eerder hebt gekopieerd.

Veld	Weergegeven als
Naam	AZURE_CREDENTIALS
Geheim	Plak de JSON-uitvoer van de opdracht voor het maken van de service-principal die u eerder hebt gekopieerd.

U hebt nu toegang tot uw Azure-abonnement en de resource voor belastingstests vanuit uw GitHub Actions-werkstroom met behulp van de opgeslagen referenties.

Als u een ander CI/CD-hulpprogramma gebruikt, gebruikt u de Azure CLI om te communiceren met uw Azure-resources. Voer de volgende stappen uit om toegang te verlenen tot het CI-hulpprogramma voor de resource voor belastingtests:

Maak een Microsoft Entra-service-principal om verbinding te maken met uw Azure-abonnement en toegang te krijgen tot uw Azure Load Testing-resource.
Verwijs de service-principal machtigingen om een belastingstest te maken en uit te voeren door de rol Inzender voor belastingtests toe te wijzen.
Sla de Azure-referenties veilig op in het CI-hulpprogramma.

Voer de volgende stappen uit om de serviceautorisatie voor uw CI-hulpprogramma te configureren:

Maak een service-principal en wijs de rol Inzender voor belastingtest toe:

Vervang de <resource-group-name> tijdelijke aanduidingen en <load-testing-resource-name> tekst.

# 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

De uitvoer is een JSON-object dat de service-principal vertegenwoordigt.

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/"    
}

Kopieer de clientIdwaarden clientSecreten waarden en tenantId sla ze veilig op als geheimen in uw CI-hulpprogramma.

U gebruikt deze waarden om u aan te melden bij uw Azure-abonnement met de Azure CLI-opdracht az login .

Laadtestbestanden toevoegen in uw opslagplaats

Als u een belastingtest wilt uitvoeren met Azure Load Testing in een CI/CD-werkstroom, moet u alle invoerbestanden voor belastingtests toevoegen in uw opslagplaats voor broncodebeheer.

Als u geen bestaande belastingstest hebt, voegt u de volgende bestanden toe aan uw broncodeopslagplaats:

YAML-bestand voor belastingtestconfiguratie. Meer informatie over het maken van een YAML-bestand voor de belastingtestconfiguratie.
Testplanbestand. Voeg voor op JMeter gebaseerde tests een JMeter-testscript (JMX bestand) toe. Voeg voor op URL gebaseerde tests een JSON-aanvraagbestand toe.
Bestanden met JMeter-gebruikerseigenschappen.
Alle invoergegevensbestanden die door uw testplan worden gebruikt. Bijvoorbeeld CSV-gegevensbestanden.

Als u een bestaande belastingstest hebt, kunt u de configuratie-instellingen en alle invoerbestanden rechtstreeks vanuit Azure Portal downloaden. Voer de volgende stappen uit om de invoerbestanden voor een bestaande belastingstest te downloaden in Azure Portal:

Ga in Azure Portal naar uw Azure Load Testing-resource.
Selecteer in het linkerdeelvenster Tests om de lijst met belastingstests weer te geven en selecteer vervolgens uw test.
Selecteer het beletselteken (...) naast de testuitvoering waarmee u werkt en selecteer vervolgens Invoerbestand downloaden.

De browser downloadt een gezipte map die de invoerbestanden voor de belastingtest bevat.
Gebruik een zip-hulpprogramma om de invoerbestanden te extraheren.

De map bevat de volgende bestanden:
- config.yaml: het YAML-configuratiebestand voor de belastingstest. U verwijst naar dit bestand in de CI/CD-werkstroomdefinitie.
- .jmx: het JMeter-testscript
- Aanvullende invoerbestanden, zoals CSV-bestanden of bestanden met gebruikerseigenschappen die nodig zijn om de belastingstest uit te voeren.
Voer alle geëxtraheerde invoerbestanden door naar uw opslagplaats voor broncodebeheer.

Gebruik de opslagplaats voor broncode waarin u de CI/CD-pijplijn configureert.

De CI/CD-werkstroomdefinitie bijwerken

Azure Load Testing ondersteunt zowel GitHub Actions als Azure Pipelines voor het uitvoeren van belastingstests.

De Azure Load Testing-extensie voor Azure DevOps installeren

Voor het maken en uitvoeren van een belastingstest maakt de Azure Pipelines-werkstroomdefinitie gebruik van de azure Load Testing-taakextensie van Azure DevOps Marketplace.

Open de azure Load Testing-taakextensie in Azure DevOps Marketplace en selecteer Gratis downloaden.
Selecteer uw Azure DevOps-organisatie en selecteer vervolgens Installeren om de extensie te installeren.

Als u geen beheerdersbevoegdheden hebt voor de geselecteerde Azure DevOps-organisatie, selecteert u Aanvraag om een beheerder aan te vragen om de extensie te installeren.

De Azure Pipelines-werkstroom bijwerken

Werk uw Azure Pipelines-werkstroom bij om een belastingstest uit te voeren voor uw Azure Load Testing-resource.

Meld u aan bij uw Azure DevOps-organisatie (https://dev.azure.com/<your-organization>) en selecteer uw project.
Selecteer Pijplijnen in het linkernavigatievenster, selecteer uw pijplijn en selecteer vervolgens Bewerken om uw werkstroomdefinitie te bewerken.

U kunt ook Pijplijn maken selecteren om een nieuwe pijplijn te maken in Azure Pipelines.
Gebruik de AzureLoadTest taak om de belastingstest uit te voeren.

Geef het configuratiebestand voor de belastingtest op dat u eerder in de loadTestConfigFile eigenschap hebt geëxporteerd.

Vervang de <load-testing-resource> tijdelijke aanduidingen en <load-testing-resource-group> tekst door de naam van uw Azure Load Testing-resource en de resourcegroep.
```
    - task: AzureLoadTest@1
      inputs:
        azureSubscription: $(serviceConnection)
        loadTestConfigFile: 'config.yaml'
        loadTestResource: <load-testing-resource>
        resourceGroup: <load-testing-resource-group>
```
U kunt eventueel parameters of geheimen doorgeven aan de belastingstest met behulp van de env of secrets eigenschap.
Gebruik de taak om de publish testresultaten te publiceren als artefacten in uw Azure Pipelines-werkstroom worden uitgevoerd.
```
    - publish: $(System.DefaultWorkingDirectory)/loadTest
      artifact: loadTestResults
```

De Werkstroom voor GitHub Actions bijwerken

Werk uw GitHub Actions-werkstroom bij om een belastingstest uit te voeren voor uw Azure-resource voor belastingstests.

Blader in GitHub naar uw opslagplaats.
Bewerk uw GitHub Actions-werkstroom of maak een nieuwe werkstroom in uw GitHub-opslagplaats.
Gebruik de actions/checkout actie om de opslagplaats te uitchecken met de invoerbestanden voor de belastingtest.
```
    - name: Checkout
      uses: actions/checkout@v3
```
Gebruik de azure/login actie om te verifiëren met Azure met behulp van de opgeslagen referenties.

Plak de volgende YAML-inhoud in uw werkstroomdefinitie:
```
    - name: Login to Azure
      uses: azure/login@v1
      continue-on-error: false
      with:
        creds: ${{ secrets.AZURE_CREDENTIALS }}
```
Gebruik de azure/load-testing actie om de belastingtest uit te voeren.

Geef het configuratiebestand voor de belastingtest op dat u eerder in de loadTestConfigFile eigenschap hebt geëxporteerd.

Vervang de <load-testing-resource> tijdelijke aanduidingen en <load-testing-resource-group> tekst door de naam van uw Azure Load Testing-resource en de resourcegroep.
```
    - name: 'Azure Load Testing'
      uses: azure/load-testing@v1
      with:
        loadTestConfigFile: 'config.yaml'
        loadTestResource: <load-testing-resource>
        resourceGroup: <load-testing-resource-group>
```
U kunt eventueel parameters of geheimen doorgeven aan de belastingstest met behulp van de env of secrets eigenschap.
Gebruik de actie om de actions/upload-artifact testresultaten te publiceren als artefacten in uw GitHub Actions-werkstroom die wordt uitgevoerd.
```
    - uses: actions/upload-artifact@v2
      with:
        name: loadTestResults
        path: ${{ github.workspace }}/loadTest
```

Werk uw CI-werkstroom bij om een belastingstest uit te voeren voor uw Azure Load Testing-resource met behulp van de Azure CLI. Gebruik de specifieke kenmerken van uw CI-hulpprogramma om de volgende opdrachten toe te voegen aan uw CI-werkstroom:

Meld u aan bij het Azure-abonnement met behulp van de service-principal.

Gebruik de clientIdwaarden clientSecreten tenandId waarden die u eerder hebt opgeslagen.
```
az login --service-principal -u $AZURE_CLIENT_ID -p $AZURE_CLIENT_SECRET -t $AZURE_TENANT_ID
az account set -s $AZURE_SUBSCRIPTION_ID
```
Maak een belastingstest met behulp van het YAML-bestand voor de belastingtestconfiguratie.

Vervang de <load-testing-resource>tijdelijke aanduidingen voor , <load-testing-resource-group>en <load-test-config-yaml> tekst door de naam van de resource voor belastingtests, de naam van de resourcegroep en de bestandsnaam van het YAML-bestand voor de belastingtestconfiguratie dat u eerder aan de opslagplaats hebt toegevoegd.
```
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>
```

Voer de belastingstest uit.

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"

Haal de metrische gegevens aan de clientzijde op en geef deze weer voor de belastingtestuitvoering.

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

Resultaten van belastingtest weergeven

Wanneer u een belastingstest uitvoert vanuit uw CI/CD-pijplijn, kunt u de samenvattingsresultaten rechtstreeks in het CI/CD-uitvoerlogboek bekijken. Als u de testresultaten hebt gepubliceerd als een pijplijnartefact, kunt u ook een CSV-bestand downloaden voor verdere rapportage.

Screenshot that shows the workflow logging information.

Resources opschonen

Als u niet van plan bent om een van de resources te gebruiken die u hebt gemaakt, verwijdert u deze zodat er geen extra kosten in rekening worden gebracht.

Wijzigingen in Azure Pipelines verwijderen:
1. Meld u aan bij uw Azure DevOps-organisatie (https://dev.azure.com/<your-organization>) en selecteer uw project.
  
  Vervang de tijdelijke aanduiding voor tekst <your-organization> door de project-id.
2. Als u een nieuwe pijplijn hebt gemaakt:
  1. Selecteer Pijplijnen en selecteer vervolgens uw pijplijn.
  2. Selecteer het beletselteken en selecteer vervolgens Verwijderen.
  3. Voer de naam van de pijplijn in en selecteer Vervolgens Verwijderen om de pijplijn te verwijderen.
3. Als u een bestaande werkstroomdefinitie hebt gewijzigd, moet u de wijzigingen voor het uitvoeren van de belastingstest ongedaan maken en de werkstroom opslaan.
Verwijder de serviceverbinding:
1. Selecteer Project settings>Service-verbindingen en selecteer vervolgens uw serviceverbinding.
2. Selecteer Verwijderen bewerken>om de serviceverbinding te verwijderen.

Wijzigingen in GitHub Actions verwijderen:
1. Blader in GitHub naar uw opslagplaats.
2. Als u een nieuwe werkstroomdefinitie hebt gemaakt, verwijdert u het YAML-bestand van de werkstroom in de .github/workflows map.
3. Als u een bestaande werkstroomdefinitie hebt gewijzigd, moet u de wijzigingen voor het uitvoeren van de belastingstest ongedaan maken en de werkstroom opslaan.

Verwijder de service-principal:

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

Volgende stappen

Ga naar het volgende artikel voor meer informatie over het identificeren van prestatieregressies door testcriteria voor mislukte tests te definiëren en testuitvoeringen te vergelijken.