Ręczna konfiguracja przepływu pracy CI/CD do uruchamiania testów obciążeniowych

Test obciążeniowy można zautomatyzować w usłudze Azure Load Testing, tworząc potok CI/CD (ciągłej integracji i ciągłego wdrażania). Z tego artykułu dowiesz się, jak ręcznie skonfigurować funkcję GitHub Actions, usługę Azure Pipelines lub inne narzędzia ciągłej integracji w celu wywołania istniejącego testu w usłudze Azure Load Testing. Zautomatyzuj test obciążeniowy, aby stale weryfikować wydajność i stabilność aplikacji pod obciążeniem.

Aby dodać istniejący test obciążeniowy do procesu CI/CD:

• Skonfiguruj uwierzytelnianie usługi, aby umożliwić narzędziu CI łączenie się z zasobem testowania obciążenia platformy Azure.
• Dodaj pliki wejściowe testu obciążeniowego do swojego repozytorium, na przykład skrypt testowy oraz konfigurację YAML testu obciążeniowego.
• Zaktualizuj definicję potoku CI/CD, aby uruchomić testowanie obciążenia w usłudze Azure.

Wymagania wstępne

• Konto platformy Azure z aktywną subskrypcją. Utwórz konto bezpłatnie.
• Test testowania obciążenia platformy Azure. Utwórz test obciążeniowy oparty na adresie URL, użyj istniejącego skryptu JMeter lub istniejącego skryptu Locust aby utworzyć test obciążeniowy.

Azure Pipelines

• Organizacja i projekt usługi Azure DevOps. Jeśli nie masz organizacji usługi Azure DevOps, możesz go utworzyć bezpłatnie. Jeśli potrzebujesz pomocy dotyczącej rozpoczynania pracy z usługą Azure Pipelines, zobacz Tworzenie pierwszego potoku.

GitHub Actions

• Konto usługi GitHub. Jeśli nie masz konta usługi GitHub, możesz go utworzyć bezpłatnie.
• Repozytorium GitHub do przechowywania plików wejściowych testu obciążenia i tworzenia przepływu pracy funkcji GitHub Actions. Aby go utworzyć, zobacz Tworzenie nowego repozytorium.

Inne

• Uprawnienie do tworzenia lub modyfikowania potoku ciągłej integracji.
• Repozytorium kodu źródłowego do przechowywania plików wejściowych testów obciążeniowych.

Konfigurowanie uwierzytelniania usługi

Aby uruchomić test obciążeniowy w przepływie pracy CI/CD, musisz udzielić przepływowi pracy CI/CD uprawnień do uzyskania dostępu do zasobów testowania obciążeniowego. Utwórz zasadę usługi dla przepływu pracy CI/CD i przypisz rolę współautora testów obciążeniowych RBAC platformy Azure.

Azure Pipelines

Utwórz połączenie usługi w Azure Pipelines

W usłudze Azure Pipelines utworzysz połączenie usługi w projekcie usługi Azure DevOps w celu uzyskania dostępu do zasobów w ramach subskrypcji platformy Azure. Podczas tworzenia połączenia z serwisem usługa Azure DevOps tworzy obiekt jednostki usługi Microsoft Entra.

1. Zaloguj się do organizacji usługi Azure DevOps (https://dev.azure.com/<your-organization>) i wybierz projekt.

   Zastąp <your-organization> symbol zastępczy tekst identyfikatorem projektu.

2. Wybierz Ustawienia projektu>Połączenia usługi>+ Nowe połączenie z usługą.

3. W okienku Nowe połączenie z usługą wybierz usługę Azure Resource Manager, a następnie wybierz pozycję Dalej.

4. Wybierz metodę uwierzytelniania główna usługa (automatyczna), a następnie Dalej.

5. Wprowadź szczegóły połączenia z usługą, a następnie wybierz pozycję Zapisz , aby utworzyć połączenie z usługą.

   Pole	Wartość
   Poziom zakresu	Subskrypcja.
   Subskrypcja	Wybierz subskrypcję platformy Azure, która hostuje zasób testowania obciążenia.
   Grupa zasobów:	Wybierz grupę zasobów zawierającą zasób testowania obciążenia.
   Nazwa połączenia z usługą	Wprowadź unikatową nazwę połączenia z usługą.
   Udziel uprawnień dostępu do wszystkich potoków	Sprawdzono.

6. Z listy połączeń usługowych wybierz tę utworzoną wcześniej, a następnie wybierz pozycję Zarządzaj główną jednostką usługi.

   

   Witryna Azure Portal zostanie otwarta na osobnej karcie przeglądarki i wyświetli szczegóły jednostki usługi.

7. W portalu Azure skopiuj wartość Nazwa wyświetlana.

   Ta wartość jest używana w następnym kroku, aby udzielić uprawnień do uruchamiania testów obciążeniowych podmiotowi usługi.

Udzielanie dostępu do testowania obciążenia platformy Azure

Testowanie obciążenia platformy Azure korzysta z Azure RBAC do przyznawania uprawnień do przeprowadzania określonych działań na zasobie testowania obciążenia. Aby uruchomić test obciążeniowy z potoku CI/CD, należy przypisać rolę Współtwórcy testu obciążeniowego podmiotowi usługi.

1. W witrynie Azure Portal przejdź do zasobu testowania obciążenia platformy Azure.

2. Wybierz pozycję Kontrola dostępu (IAM)>Dodaj>Dodaj przypisanie roli.

3. Na karcie Rola wybierz pozycję Uczestnik testu obciążeniowego na liście ról funkcji zadania.

   

4. Na karcie Członkowie wybierz pozycję Wybierz członków, a następnie użyj skopiowanej wcześniej nazwy wyświetlanej, aby wyszukać główny element usługi.

5. Wybierz główną usługę, a następnie wybierz opcję Wybierz.

6. Na karcie Przegląd i przypisanie wybierz pozycję Przegląd i przypisanie, aby dodać przypisanie roli.

Teraz możesz użyć połączenia usługi w definicji przepływu pracy usługi Azure Pipelines, aby uzyskać dostęp do zasobu testowania obciążenia platformy Azure.

GitHub Actions

Aby uzyskać dostęp do zasobu testowania obciążenia platformy Azure z przepływu pracy funkcji GitHub Actions, najpierw utwórz jednostkę usługi Microsoft Entra. Ta zasada usługi reprezentuje przepływ pracy GitHub Actions w Microsoft Entra ID.

Następnie przyznasz jednostce usługi uprawnienia do tworzenia i uruchamiania testu obciążeniowego przy użyciu zasobu testowania obciążenia platformy Azure.

Tworzenie jednostki usługi

Utwórz jednostkę usługi w subskrypcji Azure i przypisz rolę Współautora testu obciążenia, aby przepływ pracy GitHub Actions miał dostęp do zasobu testów obciążenia na platformie Azure i mógł uruchamiać testy obciążeniowe.

1. Utwórz jednostkę usługi i przypisz Load Test Contributor rolę:

   # 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
   

   Dane wyjściowe to obiekt JSON reprezentujący jednostkę usługi. Używasz tych informacji do uwierzytelniania się w Azure w przepływie pracy 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/"    
   }
   

   Uwaga

   Po uruchomieniu --sdk-auth tego polecenia może zostać wyświetlone ostrzeżenie o wycofaniu. Alternatywnie możesz użyć uwierzytelniania opartego na protokole OpenID Connect (OIDC) do uwierzytelniania usługi GitHub za pomocą platformy Azure. Dowiedz się, jak używać akcji logowania platformy Azure z usługą OpenID Connect.

2. Skopiuj wyjściowy obiekt JSON do schowka.

   W następnym kroku informacje o podstawowym elemencie usługi zostają zapisane jako sekret funkcji GitHub Actions.

Przechowuj poświadczenia platformy Azure w tajemnicy GitHub Actions.

Utwórz tajny klucz w GitHub Actions, aby bezpiecznie przechowywać informacje o tożsamości usługi. Sekret jest używany w definicji przepływu pracy do uwierzytelniania i łączenia się z platformą Azure oraz uzyskiwania dostępu do zasobu testowania obciążenia platformy Azure.

Uwaga

Jeśli używasz programu OpenID Connect do uwierzytelniania za pomocą platformy Azure, nie musisz przekazywać obiektu jednostki usługi w akcji logowania platformy Azure. Dowiedz się, jak używać akcji logowania platformy Azure z usługą OpenID Connect.

Aby utworzyć sekret GitHub Actions:

1. W usłudze GitHub przejdź do repozytorium.

2. Wybierz Ustawienia>Sekrety i zmienne>Akcje.

3. Wybierz Nowy tajny klucz w repozytorium, wprowadź informacje o tajemnicy, a następnie wybierz Dodaj tajemnicę, aby utworzyć nowy sekret.

   Pole	Wartość
   Nazwa/nazwisko	AZURE_CREDENTIALS
   Wpis tajny	Wklej dane wyjściowe JSON z skopiowanego wcześniej polecenia tworzenia głównej usługi.

Teraz możesz uzyskać dostęp do subskrypcji Azure i zasobów testowania obciążenia z przepływu pracy GitHub Actions, korzystając z przechowywanych poświadczeń.

Inne

Jeśli używasz innego narzędzia CI/CD, możesz użyć Azure CLI do interakcji z zasobami platformy Azure. Wykonaj następujące kroki, aby autoryzować dostęp narzędzia CI do zasobu do testów obciążeniowych:

1. Utwórz jednostkę usługi Microsoft Entra, aby nawiązać połączenie z subskrypcją platformy Azure i uzyskać dostęp do zasobu do testowania obciążenia w platformie Azure.
2. Przyznaj jednostce usługi uprawnienia do tworzenia i uruchamiania testu obciążeniowego, przypisując rolę Współautor testu obciążeniowego.
3. Przechowaj bezpiecznie poświadczenia platformy Azure w narzędziu ciągłej integracji.

Wykonaj następujące kroki, aby skonfigurować autoryzację usługi dla twojego narzędzia ciągłej integracji.

1. Utwórz jednostkę usługi i przypisz rolę Współautor testu obciążeniowego:

   Zastąp symbole zastępcze tekstu <resource-group-name> i <load-testing-resource-name>.

   # 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
   

   Dane wyjściowe to obiekt JSON reprezentujący jednostkę usługi.

   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. Skopiuj wartości clientId, clientSecret i tenantId i bezpiecznie zapisz je jako wpisy tajne w swoim narzędziu CI.

   Używasz tych wartości, aby zalogować się do subskrypcji platformy Azure za pomocą polecenia Azure CLI az login.

Dodaj pliki testów obciążeniowych do repozytorium

Aby uruchomić test obciążeniowy za pomocą usługi Azure Load Testing w przepływie pracy CI/CD, należy dodać wszystkie pliki wejściowe testów obciążeniowych do repozytorium kodu źródłowego.

Jeśli nie masz istniejącego testu obciążeniowego, dodaj następujące pliki do repozytorium kodu źródłowego:

• Plik konfiguracji testu obciążeniowego YAML. Dowiedz się, jak utworzyć plik YAML konfiguracji testu obciążeniowego.
• Plik planu testu. W przypadku testów opartych na JMeter dodaj skrypt testowy JMeter (JMX plik). W przypadku testów opartych na Locust dodaj skrypt testowy Locust (plik.py). W przypadku testów opartych na adresach URL, dodaj plik JSON żądań.
• Wszystkie pliki właściwości użytkownika JMeter.
• Wszystkie pliki danych wejściowych używanych przez plan testowy. Na przykład pliki danych CSV.

Jeśli masz istniejący test obciążeniowy, możesz pobrać ustawienia konfiguracji i wszystkie pliki wejściowe bezpośrednio z witryny Azure Portal. Wykonaj następujące kroki, aby pobrać pliki wejściowe na potrzeby istniejącego testowania obciążenia w witrynie Azure Portal:

1. W witrynie Azure Portal przejdź do zasobu testowania obciążenia platformy Azure.

2. W okienku po lewej stronie wybierz pozycję Testy , aby wyświetlić listę testów obciążeniowych, a następnie wybierz test.

   

3. Wybranie wielokropka (...) obok przebiegu testu, z którym pracujesz, a następnie wybierz Pobierz plik wejściowy.

   Przeglądarka pobiera spakowany folder zawierający pliki wejściowe testu obciążeniowego.

   

4. Wyodrębnianie plików wejściowych za pomocą dowolnego narzędzia zip.

   Folder zawiera następujące pliki:

   • config.yaml: plik konfiguracji testu obciążeniowego YAML. Odwołujesz się do tego pliku w definicji workflow dla ciągłej integracji/ciągłego wdrażania.
   • .jmx lub .py: skrypt testowy JMeter lub Locust
   • Wszelkie dodatkowe pliki wejściowe, takie jak pliki CSV lub pliki właściwości użytkownika potrzebne do uruchomienia testu obciążeniowego.

5. Zatwierdź wszystkie wyodrębnione pliki wejściowe do repozytorium kontroli źródła.

   Użyj repozytorium kodu źródłowego, w którym konfigurujesz potok CI/CD.

Zaktualizować definicję procesu roboczego CI/CD.

Platforma testowania obciążenia Azure obsługuje zarówno GitHub Actions, jak i Azure Pipelines do uruchamiania testów obciążeniowych.

Azure Pipelines

Instalowanie rozszerzenia Azure Load Testing dla usługi Azure DevOps

Aby utworzyć i uruchomić test obciążeniowy, definicja przepływu pracy usługi Azure Pipelines używa zadania Azure Load Testing z witryny Azure DevOps Marketplace.

1. Otwórz rozszerzenie zadania Azure Load Testing w witrynie Azure DevOps Marketplace i wybierz pozycję Pobierz bezpłatnie.

2. Wybierz organizację usługi Azure DevOps, a następnie wybierz pozycję Zainstaluj , aby zainstalować rozszerzenie.

   Jeśli nie masz uprawnień administratora dla wybranej organizacji usługi Azure DevOps, wybierz pozycję Zażądaj , aby poprosić administratora o zainstalowanie rozszerzenia.

Aktualizowanie przepływu pracy usługi Azure Pipelines

Zaktualizuj przepływ pracy usługi Azure Pipelines, aby uruchomić test obciążeniowy dla zasobu testowania obciążenia platformy Azure.

1. Zaloguj się do organizacji usługi Azure DevOps (https://dev.azure.com/<your-organization>) i wybierz projekt.

2. Wybierz pozycję Potoki w obszarze nawigacji po lewej stronie, wybierz potok, a następnie wybierz pozycję Edytuj , aby edytować definicję przepływu pracy.

   Alternatywnie wybierz pozycję Utwórz potok , aby utworzyć nowy potok w usłudze Azure Pipelines.

3. Użyj zadania AzureLoadTest, aby uruchomić test obciążeniowy.

   We właściwości loadTestConfigFile określ wyeksportowany wcześniej plik konfiguracji testu obciążeniowego.

   Zastąp symbole zastępcze <load-testing-resource> nazwą zasobu testowania obciążenia platformy Azure oraz <load-testing-resource-group> nazwą grupy zasobów.

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

   Opcjonalnie możesz przekazać parametry lub wpisy tajne do testu obciążeniowego, używając właściwości env lub secrets.

4. Użyj zadania publish, aby opublikować wyniki testu jako artefakty w przepływie pracy Azure Pipelines.

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

GitHub Actions

Aktualizowanie przepływu pracy funkcji GitHub Actions

Zaktualizuj przepływ pracy funkcji GitHub Actions, aby uruchomić test obciążeniowy dla zasobu testowania obciążenia platformy Azure.

1. W usłudze GitHub przejdź do repozytorium.

2. Edytuj przepływ pracy funkcji GitHub Actions lub utwórz nowy przepływ pracy w repozytorium GitHub.

3. Użyj akcji actions/checkout, aby wyewidencjonować repozytorium z plikami wejściowymi do testu obciążeniowego.

       - name: Checkout
         uses: actions/checkout@v3
   

4. azure/login Użyj akcji , aby uwierzytelnić się na platformie Azure przy użyciu przechowywanych poświadczeń.

   Wklej następującą zawartość YAML w definicji przepływu pracy:

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

5. Użyj akcji azure/load-testing do uruchomienia testu obciążeniowego.

   Określ we właściwości plik konfiguracji testu obciążeniowego, który wyeksportowałeś wcześniej, za pomocą loadTestConfigFile.

   Zastąp symbole zastępcze <load-testing-resource> i <load-testing-resource-group> nazwą zasobu testowania obciążenia platformy Azure oraz nazwą grupy zasobów.

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

   Opcjonalnie możesz przekazać parametry lub wpisy tajne do testu obciążeniowego, korzystając z właściwości env lub secrets.

6. Użyj akcji actions/upload-artifact, aby opublikować wyniki testów jako artefakty w przebiegu pracy GitHub Actions.

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

Inne

Zaktualizuj swój przebieg ciągłej integracji, aby uruchomić test obciążeniowy dla zasobu testowania obciążenia w Azure, korzystając z Azure CLI. Użyj specyfikacji narzędzia CI, aby dodać następujące polecenia do przepływu pracy CI.

1. Zaloguj się do subskrypcji platformy Azure używając głównego konta usługi.

   Użyj wcześniej przechowywanych clientIdwartości , clientSecreti tenantId .

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

2. Utwórz test obciążeniowy przy użyciu pliku konfiguracyjnego YAML.

   Zastąp symbole zastępcze <load-testing-resource>, <load-testing-resource-group> i <load-test-config-yaml> nazwą zasobu testowania obciążenia, nazwą grupy zasobów i nazwą pliku YAML konfiguracji testu obciążeniowego, które wcześniej dodałeś do repozytorium.

   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. Uruchom test obciążeniowy.

   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. Pobierz i wyświetl metryki po stronie klienta dla przebiegu testu obciążeniowego.

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

Wyświetlanie wyników testu obciążeniowego

Gdy uruchamiasz test obciążeniowy z potoku CI/CD, możesz wyświetlić wyniki podsumowania bezpośrednio w dzienniku wyjściowym potoku CI/CD. Jeśli wyniki testu zostały opublikowane jako artefakt potokowy, możesz również pobrać plik CSV do dalszego raportowania.

Czyszczenie zasobów

Jeśli nie planujesz korzystać z żadnych utworzonych zasobów, usuń je, aby nie ponosić żadnych dodatkowych opłat.

Azure Pipelines

1. Usuń zmiany usługi Azure Pipelines:

   1. Zaloguj się do organizacji usługi Azure DevOps (https://dev.azure.com/<your-organization>) i wybierz projekt.

      Zastąp zastępczy tekst <your-organization> identyfikatorem projektu.

   2. Jeśli utworzono nowy potok":

      1. Wybierz pozycję Potoki, a następnie wybierz potok.

      2. Wybierz wielokropek, a następnie wybierz Usuń.

         

      3. Wprowadź nazwę potoku, a następnie wybierz pozycję Usuń , aby usunąć potok.

   3. Jeśli zmodyfikowano istniejącą definicję przepływu pracy, cofnij modyfikacje uruchamiania testu obciążeniowego i zapisz przepływ pracy.

2. Usuń połączenie z usługą:

   1. Wybierz Ustawienia projektu>Połączenia z usługą, a następnie wybierz swoje połączenie z usługą.
   2. Wybierz Edytuj>Usuń, aby usunąć połączenie z usługą.

GitHub Actions

1. Usuń zmiany funkcji GitHub Actions:

   1. W usłudze GitHub przejdź do repozytorium.
   2. Jeśli utworzono nową definicję przepływu pracy, usuń plik YAML przepływu pracy w folderze .github/workflows .
   3. Jeśli zmodyfikowano istniejącą definicję przepływu pracy, cofnij modyfikacje uruchamiania testu obciążeniowego i zapisz przepływ pracy.

2. Usuń jednostkę usługi:

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

Inne

1. Cofnij zmiany w przepływie pracy CI.

2. Usuń jednostkę usługi:

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

Następne kroki

Przejdź do następnego artykułu, aby dowiedzieć się, jak identyfikować regresje wydajności, definiując kryteria testu niepowodzenia i porównując przebiegi testów.

• Samouczek: automatyzowanie testów regresji
• Definiowanie kryteriów niepowodzenia testu
• Wyświetlanie trendów wydajności w czasie