Ruční konfigurace pracovního postupu CI/CD pro spouštění zátěžových testů

Zátěžový test ve službě Azure Load Testing můžete automatizovat vytvořením kanálu CI/CD. V tomto článku se dozvíte, jak ručně nakonfigurovat GitHub Actions, Azure Pipelines nebo jiné nástroje CI pro vyvolání existujícího testu ve službě Azure Load Testing. Automatizujte zátěžový test, abyste nepřetržitě ověřili výkon a stabilitu vaší aplikace při zatížení.

Chcete-li přidat existující zátěžový test do kanálu CI/CD:

• Nakonfigurujte ověřování služby, aby se nástroj CI mohl připojit k vašemu prostředku zátěžového testování Azure.
• Přidejte do úložiště vstupní soubory zátěžového testu, jako je testovací skript a konfigurace YAML zátěžového testu.
• Aktualizujte definici kanálu CI/CD tak, aby vyvolala zátěžové testování Azure.

Požadavky

• Účet Azure s aktivním předplatným. Vytvořte si bezplatný účet.
• Test zátěžového testování Azure Vytvořte zátěžový test založený na adrese URL, pomocí existujícího skriptu JMeter nebo existujícího skriptu Pythont vytvořte zátěžový test.

Kanály Azure

• Organizace a projekt Azure DevOps Pokud nemáte organizaci Azure DevOps, můžete si ji zdarma vytvořit. Pokud potřebujete pomoc se zahájením práce se službou Azure Pipelines, přečtěte si téma Vytvoření prvního kanálu.

GitHub Actions

• Účet GitHubu. Pokud nemáte účet GitHubu, můžete si ho zdarma vytvořit.
• Úložiště GitHub pro ukládání vstupních souborů zátěžového testu a vytvoření pracovního postupu GitHub Actions Pokud ho chcete vytvořit, přečtěte si téma Vytvoření nového úložiště.

Ostatní

• Oprávnění k vytvoření nebo úpravě CI pipeline.
• Úložiště zdrojového kódu pro uložení vstupních souborů zátěžového testu.

Konfigurace ověřování služby

Pokud chcete spustit zátěžový test v pracovním postupu CI/CD, musíte udělit oprávnění pracovnímu postupu CI/CD pro přístup k vašemu prostředku zátěžového testování. Vytvořte instanční objekt pro pracovní postup CI/CD a přiřaďte roli Přispěvatel zátěžového testu Azure RBAC.

Kanály Azure

Vytvoření služebního připojení v Azure Pipelines

V Azure Pipelines vytvoříte v projektu Azure DevOps připojení ke službě pro přístup k prostředkům v předplatném Azure. Při vytváření připojení služby vytvoří Azure DevOps objekt instančního objektu Microsoft Entra.

1. Přihlaste se ke své organizaci Azure DevOps (https://dev.azure.com/<your-organization>) a vyberte svůj projekt.

   <your-organization> Zástupný text nahraďte identifikátorem projektu.

2. Vyberte Nastavení projektu>Připojení služeb>+ Nové připojení služby.

3. V podokně Připojení k nové službě vyberte Azure Resource Manager a pak vyberte Další.

4. Vyberte metodu ověřování Service Principal (automaticky) a pak vyberte Další.

5. Zadejte podrobnosti o připojení služby a pak výběrem možnosti Uložit vytvořte připojení služby.

   Obor	Hodnota
   Úroveň oboru	Předplatné
   Předplatné	Vyberte předplatné Azure, které hostuje váš prostředek zátěžového testování.
   Skupina zdrojů	Vyberte skupinu prostředků, která obsahuje váš prostředek zátěžového testování.
   Název připojení služby	Zadejte jedinečný název připojení služby.
   Udělit přístupové oprávnění všem potrubím	Zkontrolováno.

6. V seznamu připojení služeb vyberte to, které jste vytvořili dříve, a poté vyberte Spravovat prvek služby.

   

   Azure Portal se otevře na samostatné kartě prohlížeče a zobrazí podrobnosti služebního objektu.

7. Na portálu Azure zkopírujte hodnotu zobrazeného názvu.

   Tuto hodnotu použijete v dalším kroku, abyste udělili oprávnění ke spouštění zátěžových testů služebnímu hlavnímu objektu.

Udělení přístupu k zátěžovým testováním Azure

Azure Load Testing pomocí Azure RBAC uděluje oprávnění k provádění konkrétních aktivit u vašeho prostředku zátěžového testování. Pokud chcete spustit zátěžový test z vašeho kanálu CI/CD, udělte roli Přispěvatele zátěžového testu služebnímu principálu.

1. Na webu Azure Portal přejděte k prostředku azure Load Testing.

2. Vyberte Řízení přístupu (IAM)>Přidat>přiřadit roli.

3. Na kartě Role v seznamu pracovních rolí vyberte Přispěvatel zátěžového testu.

   

4. Na kartě Členové vyberte Vybrat členy a pak pomocí zobrazovaného názvu, který jste zkopírovali dříve, vyhledejte služební objekt.

5. Vyberte service principal a pak vyberte Vybrat.

6. Na kartě Revize + přiřazení vyberte Revize + přiřadit a přidejte přiřazení role.

K přístupu k prostředku zátěžového testování Azure teď můžete použít připojení služby v definici pracovního postupu Azure Pipelines.

GitHub Actions

Pokud chcete získat přístup k prostředku Azure Load Testing z pracovního postupu GitHub Actions, nejprve vytvořte hlavní službu Microsoft Entra. Tento služební principál představuje váš pracovní postup GitHub Actions v Microsoft Entra ID.

Dále udělíte aplikačnímu objektu oprávnění k vytvoření a spuštění zátěžového testu při využití prostředku Azure Load Testing.

Vytvořte služebního principála

Vytvořte principála služby v předplatném Azure a přiřaďte roli Přispěvatel zátěžového testu, aby váš pracovní postup GitHub Actions měl přístup k vašemu prostředku zátěžového testování Azure pro spuštění zátěžových testů.

1. Vytvořte instanční objekt a přiřaďte Load Test Contributor roli:

   # 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
   

   Výstup je objekt JSON, který představuje služební principal. Tyto informace použijete k ověření v Azure v pracovním postupu 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/"    
   }
   

   Poznámka:

   Při spuštění tohoto příkazu se může zobrazit --sdk-auth upozornění na vyřazení. Alternativně můžete použít ověřování založené na OpenID Connect (OIDC) pro ověřování GitHubu v Azure. Naučte se používat akci přihlášení k Azure s OpenID Connect.

2. Zkopírujte výstupní objekt JSON do schránky.

   V dalším kroku uchováte informace hlavního objektu služby jako tajemství GitHub Actions.

Uložení přihlašovacích údajů Azure v tajném kódu GitHub Actions

Vytvořte tajemství GitHub Actions pro bezpečné uložení informací služebního účtu. Tento tajný kód v definici pracovního postupu použijete pro připojení k ověřování pomocí Azure a přístupu k prostředku zátěžového testování Azure.

Poznámka:

Pokud k ověřování v Azure používáte OpenID Connect, nemusíte v akci přihlášení k Azure předávat objekt hlavní služby. Naučte se používat akci přihlášení k Azure s OpenID Connect.

Chcete-li vytvořit tajemství pro GitHub Actions:

1. Na GitHubu přejděte do úložiště.

2. Vyberte Nastavení>Tajnosti a proměnné>Akce.

3. Vyberte Nový tajný klíč úložiště, zadejte informace o tajných klíčích a pak vyberte Přidat tajný kód a vytvořte nový tajný kód.

   Obor	Hodnota
   název	AZURE_CREDENTIALS
   Tajný kód	Vložte výstup JSON z příkazu pro vytvoření služebního principálu, který jste zkopírovali dříve.

Teď můžete přistupovat ke svému předplatnému Azure a prostředku zátěžového testování z pracovního postupu GitHub Actions pomocí uložených přihlašovacích údajů.

Ostatní

Pokud používáte jiný nástroj CI/CD, použijete Azure CLI k interakci s prostředky Azure. Provedením následujících kroků autorizujete přístup nástroje CI k vašemu prostředku zátěžového testování:

1. Vytvořte služební účet Microsoft Entra pro připojení k vašemu předplatnému Azure a přístup k vašemu prostředku zátěžového testování Azure.
2. Udělte instančnímu objektu oprávnění k vytvoření a spuštění zátěžového testu přiřazením role Přispěvatel zátěžového testu.
3. Bezpečně ukládejte přihlašovací údaje Azure v nástroji CI.

Provedením následujících kroků nakonfigurujte autorizaci služby pro nástroj CI:

1. Vytvořte instanční objekt a přiřaďte roli Přispěvatel zátěžového testu:

   Nahraďte zástupné symboly <resource-group-name> a <load-testing-resource-name> textem.

   # 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
   

   Výstup je objekt JSON, který představuje služební principal.

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

2. clientIdZkopírujte , clientSecreta hodnoty a tenantId bezpečně je uložte jako tajné kódy v nástroji CI.

   Tyto hodnoty použijete k přihlášení k předplatnému Azure pomocí příkazu Azure CLI az login .

Přidání souborů zátěžového testu do úložiště

Pokud chcete spustit zátěžový test s Využitím zátěžového testování Azure v pracovním postupu CI/CD, musíte do úložiště správy zdrojového kódu přidat všechny vstupní soubory zátěžového testu.

Pokud nemáte existující zátěžový test, přidejte do úložiště zdrojového kódu následující soubory:

• YAML konfigurační soubor zátěžového testu. Zjistěte, jak vytvořit soubor YAML konfigurace zátěžového testu.
• Soubor testovacího plánu. Pro testy založené na JMeter přidejte testovací skript JMeter (JMX soubor). Pro testy založené na Locustu přidejte testovací skript Locustu (.py soubor). Pro testy založené na adrese URL přidejte soubor JSON požadavků.
• Všechny soubory vlastností uživatele JMeter.
• Všechny vstupní datové soubory, které váš testovací plán používá. Například datové soubory CSV.

Pokud máte existující zátěžový test, můžete si stáhnout nastavení konfigurace a všechny vstupní soubory přímo z webu Azure Portal. Pomocí následujících kroků stáhněte vstupní soubory pro stávající zátěžové testování na webu Azure Portal:

1. Na webu Azure Portal přejděte k prostředku azure Load Testing.

2. V levém podokně vyberte Testy , abyste zobrazili seznam zátěžových testů a pak ho vybrali.

   

3. Vyberte tři tečky (výpustku) (...) vedle testovacího běhu, se kterým pracujete, a pak vyberte Stáhnout vstupní soubor.

   Prohlížeč stáhne zazipovanou složku, která obsahuje vstupní soubory zátěžového testu.

   

4. Pomocí libovolného nástroje ZIP extrahujte vstupní soubory.

   Složka obsahuje následující soubory:

   • config.yaml: konfigurační soubor YAML zátěžového testu. Na tento soubor odkazujete v definici pracovního postupu CI/CD.
   • .jmx nebo .py: Testovací skript JMeter nebo Locust
   • Všechny další vstupní soubory, například soubory CSV nebo soubory vlastností uživatele potřebné ke spuštění zátěžového testu.

5. Potvrďte všechny extrahované vstupní soubory do úložiště správy zdrojového kódu.

   Použijte úložiště zdrojového kódu, ve kterém konfigurujete kanál CI/CD.

Aktualizace definice pracovního postupu CI/CD

Azure Load Testing podporuje GitHub Actions i Azure Pipelines pro spouštění zátěžových testů.

Kanály Azure

Instalace rozšíření Azure Load Testing pro Azure DevOps

K vytvoření a spuštění zátěžového testu se v definici pracovního postupu Azure Pipelines používá rozšíření úlohy Zátěžové testování Azure z Azure DevOps Marketplace.

1. Otevřete rozšíření úlohy Zátěžové testování Azure v Azure DevOps Marketplace a vyberte Získat zdarma.

2. Vyberte svoji organizaci Azure DevOps a pak vyberte Nainstalovat a nainstalujte rozšíření.

   Pokud nemáte oprávnění správce pro vybranou organizaci Azure DevOps, vyberte Požádat správce o instalaci rozšíření.

Aktualizace pracovního postupu Azure Pipelines

Aktualizujte pracovní postup Azure Pipelines tak, aby se spustil zátěžový test pro prostředek zátěžového testování Azure.

1. Přihlaste se ke své organizaci Azure DevOps (https://dev.azure.com/<your-organization>) a vyberte svůj projekt.

2. V levém navigačním panelu vyberte Kanály , vyberte kanál a pak vyberte Upravit a upravte definici pracovního postupu.

   Případně vyberte Vytvořit kanál a vytvořte nový kanál v Azure Pipelines.

3. AzureLoadTest Pomocí úlohy spusťte zátěžový test.

   Zadejte konfigurační soubor zátěžového testu, který jste vyexportovali dříve ve loadTestConfigFile vlastnosti.

   Nahraďte textové zástupné symboly <load-testing-resource> a <load-testing-resource-group> názvem vašeho prostředku zátěžového testování Azure a skupiny prostředků.

       - task: AzureLoadTest@1
         inputs:
           azureSubscription: $(serviceConnection)
           loadTestConfigFile: 'config.yaml'
           loadTestResource: <load-testing-resource>
           resourceGroup: <load-testing-resource-group>
   

   Volitelně můžete zátěžovým testům předat parametry nebo tajné kódy pomocí env vlastnosti.secrets

4. Pomocí úlohy publish publikujte výsledky testu jako artefakty v rámci pracovního postupu spuštěného v Azure Pipelines.

       - publish: $(System.DefaultWorkingDirectory)/loadTest
         artifact: loadTestResults
   

GitHub Actions

Aktualizace pracovního postupu GitHub Actions

Aktualizujte pracovní postup GitHub Actions tak, aby se spustil zátěžový test pro prostředek zátěžového testování Azure.

1. Na GitHubu přejděte do úložiště.

2. Upravte pracovní postup GitHub Actions nebo vytvořte nový pracovní postup v úložišti GitHub.

3. Použijte akci actions/checkout ke stažení úložiště se vstupními soubory zátěžového testu.

       - name: Checkout
         uses: actions/checkout@v3
   

4. azure/login Pomocí akce se můžete ověřit v Azure pomocí uložených přihlašovacích údajů.

   Do definice pracovního postupu vložte následující obsah YAML:

       - name: Login to Azure
         uses: azure/login@v1
         continue-on-error: false
         with:
           creds: ${{ secrets.AZURE_CREDENTIALS }}
   

5. azure/load-testing Pomocí akce spusťte zátěžový test.

   Zadejte konfigurační soubor zátěžového testu, který jste vyexportovali dříve ve loadTestConfigFile vlastnosti.

   Nahraďte textové zástupné symboly <load-testing-resource> a <load-testing-resource-group> názvem vašeho prostředku zátěžového testování Azure a skupiny prostředků.

       - name: 'Azure Load Testing'
         uses: azure/load-testing@v1
         with:
           loadTestConfigFile: 'config.yaml'
           loadTestResource: <load-testing-resource>
           resourceGroup: <load-testing-resource-group>
   

   Volitelně můžete zátěžovým testům předat parametry nebo tajné kódy pomocí env vlastnosti.secrets

6. Pomocí akce actions/upload-artifact publikujte výsledky testu jako artefakty ve spuštění pracovního postupu GitHub Actions.

       - uses: actions/upload-artifact@v2
         with:
           name: loadTestResults
           path: ${{ github.workspace }}/loadTest
   

Ostatní

Aktualizujte pracovní postup CI tak, aby se spustil zátěžový test pro prostředek zátěžového testování Azure pomocí Azure CLI. Pomocí specifik nástroje CI přidejte do pracovního postupu CI následující příkazy:

1. Přihlaste se k předplatnému Azure pomocí služebního principálu.

   Použijte hodnoty clientId, clientSecret a tenantId, které jste uložili dříve.

   az login --service-principal -u $AZURE_CLIENT_ID -p $AZURE_CLIENT_SECRET -t $AZURE_TENANT_ID
   az account set -s $AZURE_SUBSCRIPTION_ID
   

2. Vytvořte zátěžový test pomocí souboru YAML konfigurace zátěžového testu.

   Nahraďte textové zástupce <load-testing-resource>, <load-testing-resource-group> a <load-test-config-yaml> názvem prostředku pro zátěžové testování, názvem skupiny prostředků a názvem souboru konfiguračního souboru YAML zátěžového testu, který jste do úložiště přidali dříve.

   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>
   

3. Spusťte zátěžový test.

   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"
   

4. Načtěte a zobrazte metriky na straně klienta pro spuštění zátěžového testu.

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

Zobrazení výsledků zátěžového testu

Když spustíte zátěžový test z kanálu CI/CD, můžete zobrazit souhrnné výsledky přímo ve výstupním protokolu CI/CD. Pokud jste výsledky testu publikovali jako artefakt pipeliny, můžete si také stáhnout soubor CSV pro další zpracování zpráv.

Vyčistěte zdroje

Pokud nechcete používat žádné prostředky, které jste vytvořili, odstraňte je, abyste za ně nemuseli účtovat žádné další poplatky.

Kanály Azure

1. Odstraňte změny Azure Pipelines:

   1. Přihlaste se ke své organizaci Azure DevOps (https://dev.azure.com/<your-organization>) a vyberte svůj projekt.

      <your-organization> Zástupný text nahraďte identifikátorem projektu.

   2. Pokud jste vytvořili nový kanál:

      1. Vyberte Pipelinesa pak vyberte vaše potrubí.

      2. Vyberte ikonu s třemi tečkami a pak vyberte Odstranit.

         

      3. Zadejte název kanálu a pak vyberte Odstranit , abyste kanál odstranili.

   3. Pokud jste upravili existující definici pracovního postupu, vraťte změny pro spuštění zátěžového testu a uložte pracovní postup.

2. Odeberte připojení služby:

   1. Vyberte Nastavení projektu>Připojení služby, a poté vyberte vaše připojení služby.
   2. Vyberte Upravit>Odstranit pro odebrání připojení služby.

GitHub Actions

1. Odstraňte změny GitHub Actions

   1. Na GitHubu přejděte do úložiště.
   2. Pokud jste vytvořili novou definici pracovního postupu, odstraňte soubor YAML pracovního postupu ve .github/workflows složce.
   3. Pokud jste upravili existující definici pracovního postupu, vraťte změny pro spuštění zátěžového testu a uložte pracovní postup.

2. Odeberte instanční objekt:

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

Ostatní

1. Vrátit zpět změny ve vašem CI pracovním toku

2. Odeberte instanční objekt:

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

Další kroky

V dalším článku se dozvíte, jak identifikovat regrese výkonu definováním kritérií selhání testu a porovnáním testovacích běhů.

• Kurz: Automatizace regresních testů
• Definování kritérií selhání testu
• Zobrazení trendů výkonu v průběhu času