Вручную настройте рабочий процесс CI/CD для выполнения нагрузочных тестов

Статья
12/15/2023

Вы можете автоматизировать нагрузочный тест в Azure Load Testing, создав конвейер CI/CD. Из этой статьи вы узнаете, как вручную настроить GitHub Actions, Azure Pipelines или другие средства CI для вызова существующего теста в Azure Load Testing. Автоматизируйте нагрузочный тест для непрерывной проверки производительности и стабильности приложения под нагрузкой.

Чтобы добавить существующий нагрузочный тест в конвейер CI/CD:

Настройте проверку подлинности службы, чтобы разрешить средству CI подключаться к ресурсу нагрузочного тестирования Azure.
Добавьте входные файлы нагрузочного теста в репозиторий, например скрипт теста JMeter и конфигурацию YAML нагрузочного теста.
Обновите определение конвейера CI/CD, чтобы вызвать нагрузочное тестирование Azure.

Необходимые компоненты

Учетная запись Azure с активной подпиской. Создайте учетную запись бесплатно .
Тест нагрузочного тестирования Azure. Создайте нагрузочный тест на основе URL-адреса или используйте существующий скрипт JMeter для создания нагрузочного теста.

Организация и проект Azure DevOps. Если у вас нет организации Azure DevOps, ее можно создать бесплатно. Если вам нужна помощь по началу работы с Azure Pipelines, см. статью "Создание первого конвейера".

Настройка проверки подлинности службы

Чтобы запустить нагрузочный тест в рабочем процессе CI/CD, необходимо предоставить разрешение рабочему процессу CI/CD для доступа к ресурсу нагрузочного тестирования. Создайте субъект-службу для рабочего процесса CI/CD и назначьте роль участника нагрузочного теста Azure RBAC.

Создание сервисного подключения в Azure Pipelines

В Azure Pipelines вы создадите подключение к службе в проекте Azure DevOps для доступа к ресурсам в подписке Azure. При создании подключения к службе Azure DevOps создает объект субъекта-службы Microsoft Entra.

Войдите в организацию Azure DevOps (https://dev.azure.com/<your-organization>) и выберите проект.

Замените заполнитель текста идентификатором <your-organization> проекта.
Выберите параметры>> службы "Параметры проекта" и "Создать подключение службы".
В области подключения к службе выберите Azure Resource Manager и нажмите кнопку "Далее".
Выберите метод проверки подлинности субъекта-службы (автоматически) и нажмите кнопку "Далее".

Введите сведения о подключении службы и нажмите кнопку "Сохранить ", чтобы создать подключение службы.

Поле	значение
Уровень области	Подписка.
Подписка	Выберите подписку Azure, в которую размещается ресурс нагрузочного тестирования.
Группа ресурсов	Выберите группу ресурсов, содержащую ресурс нагрузочного тестирования.
Имя подключения службы	Введите уникальное имя подключения к службе.
Предоставление разрешения на доступ ко всем конвейерам	Флажок установлен.

В списке подключений к службе выберите созданный ранее элемент и выберите "Управление субъектом-службой".

Портал Azure откроется на отдельной вкладке браузера и отображает сведения о субъекте-службе.
Скопируйте значение отображаемого имени в портал Azure.

Это значение используется на следующем шаге для предоставления разрешений на выполнение нагрузочных тестов субъекту-службе.

Предоставление доступа к нагрузочному тестированию Azure

Azure Load Testing использует Azure RBAC для предоставления разрешений для выполнения определенных действий в ресурсе нагрузочного тестирования. Чтобы запустить нагрузочный тест из конвейера CI/CD, необходимо предоставить роль участника нагрузочного теста субъекту-службе.

В портал Azure перейдите к ресурсу Azure Load Testing.
Выберите элемент управления доступом (IAM)>Добавить>назначение ролей.
На вкладке "Роль" выберите участника нагрузочного теста в списке ролей функции задания.
На вкладке "Участники" выберите " Выбрать участников", а затем используйте отображаемое имя, скопированное ранее для поиска субъекта-службы.
Выберите субъект-службу и нажмите кнопку "Выбрать".
На вкладке "Рецензирование и назначение" нажмите кнопку "Рецензирование" и "Назначить", чтобы добавить назначение роли.

Теперь вы можете использовать подключение к службе в определении рабочего процесса Azure Pipelines для доступа к ресурсу нагрузочного тестирования Azure.

Чтобы получить доступ к ресурсу Azure Load Testing из рабочего процесса GitHub Actions, сначала создайте субъект-службу Microsoft Entra. Этот субъект-служба представляет рабочий процесс GitHub Actions в идентификаторе Microsoft Entra.

Затем вы предоставляете субъекту-службе разрешения на создание и запуск нагрузочного теста с ресурсом Azure Load Testing.

Создание субъекта-службы

Создайте субъект-службу в подписке Azure и назначьте роль участника нагрузочного теста, чтобы рабочий процесс GitHub Actions получил доступ к ресурсу нагрузочного тестирования Azure для выполнения нагрузочных тестов.

Создайте субъект-службу и назначьте 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

Выходные данные — это объект JSON, представляющий субъект-службу. Эти сведения используются для проверки подлинности в Azure в рабочем процессе 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/"    
}

Примечание.

При выполнении --sdk-auth этой команды может появиться предупреждение об удалении. Кроме того, для проверки подлинности GitHub в Azure можно использовать проверку подлинности на основе OpenID Подключение (OIDC). Узнайте, как использовать действие входа Azure с Подключение OpenID.

Скопируйте выходной объект JSON в буфер обмена.

На следующем шаге вы храните сведения о субъекте-службе в виде секрета GitHub Actions.

Хранение учетных данных Azure в секрете GitHub Actions

Создайте секрет GitHub Actions для безопасного хранения сведений субъекта-службы. Этот секрет используется в определении рабочего процесса для подключения к аутентификации с помощью Azure и доступа к ресурсу нагрузочного тестирования Azure.

Примечание.

Если вы используете OpenID Подключение для проверки подлинности в Azure, вам не нужно передавать объект субъекта-службы в действии входа Azure. Узнайте, как использовать действие входа Azure с Подключение OpenID.

Чтобы создать секрет GitHub Actions, выполните следующие действия:

В GitHub перейдите к репозиторию.
Выберите Параметры> Secrets и переменные>Actions.

Выберите "Создать секрет репозитория", введите сведения о секрете и нажмите кнопку "Добавить секрет ", чтобы создать новый секрет.

Поле	Значение
Имя	AZURE_CREDENTIALS
Секрет	Вставьте выходные данные JSON из команды создания субъекта-службы, скопированной ранее.

Теперь вы можете получить доступ к подписке Azure и ресурсу нагрузочного тестирования из рабочего процесса GitHub Actions с помощью сохраненных учетных данных.

Если вы используете другое средство CI/CD, вы используете Azure CLI для взаимодействия с ресурсами Azure. Выполните следующие действия, чтобы авторизовать доступ средства CI к ресурсу нагрузочного тестирования:

Создайте субъект-службу Microsoft Entra, чтобы подключиться к подписке Azure и получить доступ к ресурсу нагрузочного тестирования Azure.
Предоставьте субъекту-службе разрешения на создание и запуск нагрузочного теста, назначив роль участника нагрузочного теста.
Безопасно храните учетные данные Azure в средстве CI.

Выполните следующие действия, чтобы настроить авторизацию службы для средства CI:

Создайте субъект-службу и назначьте роль участника нагрузочного теста:

Замените <resource-group-name> заполнители и <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

Выходные данные — это объект JSON, представляющий субъект-службу.

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

clientIdСкопируйте значения clientSecretи значения и tenantId безопасно сохраните их в виде секретов в средстве CI.

Эти значения используются для входа в подписку Azure с помощью команды Azure CLI az login .

Добавление файлов нагрузочных тестов в репозиторий

Чтобы запустить нагрузочный тест с помощью Azure Load Testing в рабочем процессе CI/CD, необходимо добавить все входные файлы нагрузочного теста в репозиторий системы управления версиями.

Если у вас нет существующего нагрузочного теста, добавьте следующие файлы в репозиторий исходного кода:

Файл YAML конфигурации нагрузочного теста. Узнайте, как создать файл конфигурации нагрузочного теста YAML.
Файл плана тестирования. Для тестов на основе JMeter добавьте скрипт теста JMeter (JMX файл). Для тестов на основе URL-адресов добавьте JSON-файл запросов.
Все файлы свойств пользователя JMeter.
Все входные файлы данных, которые использует план тестирования. Например, CSV-файлы данных.

Если у вас есть нагрузочный тест, можно скачать параметры конфигурации и все входные файлы непосредственно из портал Azure. Выполните следующие действия, чтобы скачать входные файлы для существующего нагрузочного тестирования в портал Azure:

В портал Azure перейдите к ресурсу Azure Load Testing.
На левой панели выберите "Тесты ", чтобы просмотреть список нагрузочных тестов, а затем выберите тест.
Выберите многоточие (...) рядом с тестовый запуск, с которым вы работаете, и нажмите кнопку "Скачать входной файл".

Браузер скачивает архивную папку, содержащую входные файлы нагрузочного теста.
Используйте любое zip-средство для извлечения входных файлов.

Папка содержит следующие файлы:
- config.yaml: файл конфигурации YAML нагрузочного теста. Вы ссылаетесь на этот файл в определении рабочего процесса CI/CD.
- .jmx: скрипт теста JMeter
- Все дополнительные входные файлы, такие как CSV-файлы или файлы свойств пользователя, необходимые для запуска нагрузочного теста.
Зафиксируйте все извлеченные входные файлы в репозиторий системы управления версиями.

Используйте репозиторий исходного кода, в котором настраивается конвейер CI/CD.

Обновление определения рабочего процесса CI/CD

Нагрузочное тестирование Azure поддерживает действия GitHub и Azure Pipelines для выполнения нагрузочных тестов.

Установка расширения Azure Load Testing для Azure DevOps

Чтобы создать и запустить нагрузочный тест, определение рабочего процесса Azure Pipelines использует расширение задачи "Нагрузочное тестирование Azure" из Azure DevOps Marketplace.

Откройте расширение задачи "Нагрузочное тестирование Azure" в Azure DevOps Marketplace и выберите "Получить" бесплатно.
Выберите организацию Azure DevOps и нажмите кнопку "Установить ", чтобы установить расширение.

Если у вас нет прав администратора для выбранной организации Azure DevOps, выберите "Запрос" , чтобы запросить администратора установить расширение.

Обновление рабочего процесса Azure Pipelines

Обновите рабочий процесс Azure Pipelines, чтобы запустить нагрузочный тест для ресурса нагрузочного тестирования Azure.

Войдите в организацию Azure DevOps (https://dev.azure.com/<your-organization>) и выберите проект.
Выберите конвейеры в левой области навигации, выберите конвейер и выберите "Изменить ", чтобы изменить определение рабочего процесса.

Кроме того, выберите "Создать конвейер", чтобы создать новый конвейер в Azure Pipelines.
AzureLoadTest Используйте задачу для запуска нагрузочного теста.

Укажите файл конфигурации нагрузочного теста, экспортируемый ранее в свойстве loadTestConfigFile .

<load-testing-resource> Замените заполнители и <load-testing-resource-group> текстовые заполнители именем ресурса нагрузочного тестирования Azure и группы ресурсов.
```
    - task: AzureLoadTest@1
      inputs:
        azureSubscription: $(serviceConnection)
        loadTestConfigFile: 'config.yaml'
        loadTestResource: <load-testing-resource>
        resourceGroup: <load-testing-resource-group>
```
При необходимости можно передать параметры или секреты в нагрузочный тест с помощью env или secrets свойства.
publish Используйте задачу для публикации результатов теста в качестве артефактов в рабочем процессе Azure Pipelines.
```
    - publish: $(System.DefaultWorkingDirectory)/loadTest
      artifact: loadTestResults
```

Обновление рабочего процесса GitHub Actions

Обновите рабочий процесс GitHub Actions, чтобы запустить нагрузочный тест для ресурса нагрузочного тестирования Azure.

В GitHub перейдите к репозиторию.
Измените рабочий процесс GitHub Actions или создайте новый рабочий процесс в репозитории GitHub.
actions/checkout Используйте действие, чтобы проверка из репозитория с входными файлами нагрузочного теста.
```
    - name: Checkout
      uses: actions/checkout@v3
```
azure/login Используйте действие для проверки подлинности в Azure с помощью сохраненных учетных данных.

Вставьте следующее содержимое YAML в определение рабочего процесса:
```
    - name: Login to Azure
      uses: azure/login@v1
      continue-on-error: false
      with:
        creds: ${{ secrets.AZURE_CREDENTIALS }}
```
azure/load-testing Используйте действие для запуска нагрузочного теста.

Укажите файл конфигурации нагрузочного теста, экспортируемый ранее в свойстве loadTestConfigFile .

<load-testing-resource> Замените заполнители и <load-testing-resource-group> текстовые заполнители именем ресурса нагрузочного тестирования Azure и группы ресурсов.
```
    - name: 'Azure Load Testing'
      uses: azure/load-testing@v1
      with:
        loadTestConfigFile: 'config.yaml'
        loadTestResource: <load-testing-resource>
        resourceGroup: <load-testing-resource-group>
```
При необходимости можно передать параметры или секреты в нагрузочный тест с помощью env или secrets свойства.
actions/upload-artifact Используйте действие для публикации результатов теста в качестве артефактов в рабочем процессе GitHub Actions.
```
    - uses: actions/upload-artifact@v2
      with:
        name: loadTestResults
        path: ${{ github.workspace }}/loadTest
```

Обновите рабочий процесс CI, чтобы запустить нагрузочный тест для ресурса нагрузочного тестирования Azure с помощью Azure CLI. Используйте особенности средства CI, чтобы добавить следующие команды в рабочий процесс CI:

Войдите в подписку Azure с помощью субъекта-службы.

Используйте ранее сохраненные clientIdclientSecretзначения и tenandId значения.
```
az login --service-principal -u $AZURE_CLIENT_ID -p $AZURE_CLIENT_SECRET -t $AZURE_TENANT_ID
az account set -s $AZURE_SUBSCRIPTION_ID
```
Создайте нагрузочный тест с помощью файла конфигурации YAML конфигурации нагрузочного теста.

<load-testing-resource><load-testing-resource-group>Замените заполнители , а <load-test-config-yaml> также текстовые заполнители именем ресурса нагрузочного тестирования, именем группы ресурсов и именем файла конфигурации нагрузочного теста YAML, добавленного в репозиторий ранее.
```
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>
```

Запустите нагрузочный тест.

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"

Извлекает и отображает метрики на стороне клиента для выполнения нагрузочного теста.
```
az load test-run metrics list --load-test-resource <load-testing-resource> --test-run-id $testRunId --metric-namespace LoadTestRunMetrics
```

Просмотр результатов нагрузочного теста

При запуске нагрузочного теста из конвейера CI/CD можно просмотреть сводные результаты непосредственно в журнале выходных данных CI/CD. Если вы опубликовали результаты теста в качестве артефакта конвейера, вы также можете скачать CSV-файл для дальнейшего создания отчетов.

Screenshot that shows the workflow logging information.

Очистка ресурсов

Если вы не планируете использовать какие-либо созданные ресурсы, удалите их, чтобы не нести никаких дополнительных расходов.

Удаление изменений в Azure Pipelines:
1. Войдите в организацию Azure DevOps (https://dev.azure.com/<your-organization>) и выберите проект.
  
  Замените заполнитель текста идентификатором <your-organization> проекта.
2. Если вы создали новый конвейер":
  1. Выберите конвейеры и выберите конвейер.
  2. Выберите многоточие и нажмите кнопку "Удалить".
  3. Введите имя конвейера и нажмите кнопку "Удалить ", чтобы удалить конвейер.
3. Если вы изменили существующее определение рабочего процесса, отмените изменения для запуска нагрузочного теста и сохраните рабочий процесс.
Удалите подключение службы:
1. Выберите подключения службы параметров>проекта и выберите подключение службы.
2. Выберите "Изменить>удаление", чтобы удалить подключение службы.

Удаление изменений GitHub Actions:
1. В GitHub перейдите к репозиторию.
2. Если вы создали новое определение рабочего процесса, удалите файл YAML рабочего процесса в папке .github/workflows .
3. Если вы изменили существующее определение рабочего процесса, отмените изменения для запуска нагрузочного теста и сохраните рабочий процесс.

Удалите субъект-службу:

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

Отмена изменений в рабочем процессе CI.