ロードテストを実行するために CI/CD ワークフローを手動で構成する

[アーティクル]
12/15/2023

CI/CD パイプラインを作成することで、Azure Load Testing でロードテストを自動化できます。この記事では、Azure Load Testing で既存のテストを呼び出すように GitHub Actions、Azure Pipelines、またはその他の CI ツールを手動で構成する方法について説明します。ロードテストを自動化し、負荷条件下でアプリケーションのパフォーマンスと安定性を継続的に検証します。

次の手順で CI/CD パイプラインに既存のロードテストを追加します。

CI ツールが Azure ロードテストリソースに接続できるようにサービス認証を構成します。
JMeter テストスクリプトやロードテスト YAML 構成など、ロードテスト入力ファイルをリポジトリに追加します。
AZURE Load Testing を呼び出すように CI/CD パイプライン定義を更新します。

前提条件

アクティブなサブスクリプションが含まれる 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> テキストプレースホルダーをプロジェクト識別子に置き換えます。
[プロジェクトの設定]>[サービス接続]>[+ New service connection] (+ 新しいサービス接続) の順に選択します。
[新しいサービス接続] ウィンドウで、[Azure Resource Manager] を選択して、[次へ] を選択します。
[サービスプリンシパル (自動)] 認証方法を選択し、[次へ] を選択します。

サービス接続の詳細を入力し、[保存] を選択してサービス接続を作成します。

フィールド	値
スコープのレベル	[サブスクリプション]。
サブスクリプション	ロードテストリソースをホストする Azure サブスクリプションを選択します。
リソースグループ	ロードテストリソースが含まれるリソースグループを選択します。
サービス接続名	サービス接続の一意の名前を入力します。
すべてのパイプラインへのアクセス許可を与える	オン。

サービス接続の一覧から、前に作成した接続を選択し、[サービスプリンシパルの管理] を選択します。

Azure portal が別のブラウザータブで開き、サービスプリンシパルの詳細が表示されます。
Azure portal で、[表示名] の値をコピーします。

次の手順でこの値を使用して、ロードテストを実行するためのアクセス許可をサービスプリンシパルに付与します。

Azure Load Testing へのアクセスを許可する

Azure Load Testing では、Azure RBAC を使用して、ロードテストリソースで特定のアクティビティを実行するためのアクセス許可を付与します。 CI/CD パイプラインからロードテストを実行するには、ロードテスト共同作成者ロールをサービスプリンシパルに付与します。

Azure portal の Azure Load Testing リソースに移動します。
[アクセス制御 (IAM)]>[追加]>[ロールの割り当ての追加] の順に選択します。
[ロール] タブのジョブ関数ロールの一覧で [ロードテスト共同作成者] を選びます。
[メンバー] タブで [メンバーの選択] を選択し、前にコピーした表示名を使用してサービスプリンシパルを検索します。
サービスプリンシパルを選択し、[選択] を選択します。
[確認と割り当て] タブで、[確認と割り当て] を選択してロールの割り当てを追加します。

Azure Pipelines ワークフロー定義でサービス接続を使用して、Azure ロードテストリソースにアクセスできるようになりました。

GitHub Actions ワークフローから Azure Load Testing リソースにアクセスするには、最初に Microsoft Entra サービスプリンシパルを作成します。このサービスプリンシパルは、Microsoft Entra の GitHub Actions ワークフローを表します。

次に、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 オブジェクトです。 GitHub Actions ワークフローでは、この情報を使用して Azure で認証します。

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 の非推奨の警告が表示されることがあります。代わりに、Azure で GitHub を認証するために OpenID Connect (OIDC) ベースの認証を使用できます。 OpenID Connect で Azure ログインアクションを使用する方法を確認してください。

出力の JSON オブジェクトをクリップボードにコピーします。

次の手順では、サービスプリンシパル情報を GitHub Actions シークレットとして格納します。

Azure 資格情報を GitHub Actions シークレットに格納する

GitHub Actions シークレットを作成して、サービスプリンシパル情報を安全に格納します。ワークフロー定義でこのシークレットを使用して接続し、Azure で認証して、Azure ロードテストリソースにアクセスします。

Note

OpenID Connect を使用して Azure で認証する場合は、Azure ログインアクションでサービスプリンシパルオブジェクトを渡す必要はありません。 OpenID Connect で Azure ログインアクションを使用する方法を確認してください。

GitHub Actions ワークフローを作成するには

GitHub でリポジトリを参照します。
[設定>Secrets & variables>Actions] を選択します。
[New repository secret] (新しいリポジトリシークレット) を選択し、シークレット情報を入力して、[シークレットの追加] を選択して新しいシークレットを作成します。

フィールド値

名前 AZURE_CREDENTIALS

シークレット 先ほどコピーしたサービスプリンシパル作成コマンドの JSON 出力を貼り付けます。

フィールド	値
名前	AZURE_CREDENTIALS
シークレット	先ほどコピーしたサービスプリンシパル作成コマンドの JSON 出力を貼り付けます。

格納されている資格情報を使用して、GitHub Actions ワークフローから Azure サブスクリプションとロードテストリソースにアクセスできるようになりました。

別の CI/CD ツールを使用している場合は、Azure CLI を使用して Azure リソースを操作します。ロードテストリソースへの CI ツールアクセスを承認するには、次の手順を実行します。

Microsoft Entra サービスプリンシパルを作成して Azure サブスクリプションに接続し、Azure ロードテストリソースにアクセスします。
ロードテスト共同作成者ロールを割り当てることで、ロードテストを作成して実行するためのアクセス許可をサービスプリンシパルに付与します。
AZURE 資格情報を CI ツールに安全に格納します。

CI ツールのサービス承認を構成するには、次の手順を実行します。

サービスプリンシパルを作成し、ロードテスト共同作成者ロールを割り当てます。

プレースホルダーと<load-testing-resource-name>テキストプレースホルダーを<resource-group-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/"    
}

値、clientSecret値をclientIdtenantIdコピーし、CI ツールにシークレットとして安全に格納します。

これらの値を使用して、Azure CLI az login コマンドを使用して Azure サブスクリプションにサインインします。

リポジトリにロードテストファイルを追加する

CI/CD ワークフローで Azure Load Testing を使用してロードテストを実行するには、ソース管理リポジトリにすべてのロードテスト入力ファイルを追加する必要があります。

既存のロードテストがない場合は、次のファイルをソースコードリポジトリに追加します。

ロードテスト構成 YAML ファイル。ロードテスト構成 YAML ファイルを作成する方法について説明します。
テスト計画ファイル。 JMeter ベースのテストの場合は、JMeter テストスクリプト (JMX ファイル) を追加します。 URL ベースのテストの場合は、要求 JSON ファイルを追加します。
JMeter ユーザープロパティファイル。
テスト計画で使用する入力データファイル。たとえば、CSV データファイルなどです。

既存のロードテストがある場合は、構成設定とすべての入力ファイルを Azure portal から直接ダウンロードできます。次の手順を実行して、Azure portal の既存のロードテスト用の入力ファイルをダウンロードします。

Azure portal の Azure Load Testing リソースに移動します。
左側のペインで、[テスト] を選択してロードテストのリストを表示し、対象のテストを選択します。
使っているテストの実行の横にある省略記号 ( ... ) を選び、 [Download input file] (入力ファイルのダウンロード) を選びます。

ブラウザーは、ロードテスト入力ファイルを含む zip 形式のフォルダーをダウンロードします。
任意の zip ツールを使用して、入力ファイルを抽出します。

このフォルダーには次のファイルが格納されています。
- config.yaml: ロードテストの YAML 構成ファイル。このファイルは、CI/CD ワークフロー定義で参照します。
- .jmx: JMeter テストスクリプト
- ロードテストの実行に必要な CSV ファイルやユーザープロパティファイルなどの追加の入力ファイル。
抽出されたすべての入力ファイルをソース管理リポジトリにコミットします。

CI/CD パイプラインを構成するソースコードリポジトリを使用します。

CI/CD ワークフロー定義を更新する

Azure Load Testing では、ロードテストを実行するための GitHub Actions と Azure Pipelines の両方がサポートされています。

Azure DevOps 用の Azure Load Testing 拡張機能をインストールする

ロードテストを作成して実行するために、Azure Pipelines ワークフロー定義では Azure DevOps Marketplace の Azure Load Testing タスク拡張機能が使用されます。

Azure DevOps Marketplace で Azure Load Testing タスク拡張機能を開き、[Get it free] (無料で入手) を選択します。
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 ワークフローを更新する

Azure ロードテストリソースのロードテストを実行するために Azure Pipelines ワークフローを更新します。

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
```

Azure CLI を使用して、Azure ロードテストリソースのロードテストを実行するように CI ワークフローを更新します。 CI ツールの詳細を使用して、CI ワークフローに次のコマンドを追加します。

サービスプリンシパルを使用して Azure サブスクリプションにサインインします。

以前に格納した clientId値、 clientSecret、および 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-group>および<load-test-config-yaml>テキストプレースホルダーを<load-testing-resource>、ロードテストリソースの名前、リソースグループ名、および以前にリポジトリに追加したロードテスト構成 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. 新しいワークフロー定義を作成した場合は、.github/workflows フォルダー内のワークフロー YAML ファイルを削除します。
3. 既存のワークフロー定義を変更した場合は、ロードテストを実行するための変更を元に戻し、ワークフローを保存します。

サービスプリンシパルを削除します。

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

次の手順

次の記事に進み、テストの失敗条件を定義し、テストの実行を比較することで、パフォーマンスの低下を特定する方法を参照してください。

ロードテストを実行するために CI/CD ワークフローを手動で構成する

前提条件

サービス認証を構成する

Azure Pipelines でサービス接続を作成する

Azure Load Testing へのアクセスを許可する

サービスプリンシパルの作成

Azure 資格情報を GitHub Actions シークレットに格納する

リポジトリにロードテストファイルを追加する

CI/CD ワークフロー定義を更新する

Azure DevOps 用の Azure Load Testing 拡張機能をインストールする

Azure Pipelines ワークフローを更新する

GitHub Actions ワークフローを更新する

ロードテストの結果の表示

リソースをクリーンアップする

次の手順

フィードバック

フィードバック

その他のリソース

ロード テストを実行するために CI/CD ワークフローを手動で構成する

前提条件

サービス認証を構成する

Azure Pipelines でサービス接続を作成する

Azure Load Testing へのアクセスを許可する

リポジトリにロード テスト ファイルを追加する

CI/CD ワークフロー定義を更新する

Azure DevOps 用の Azure Load Testing 拡張機能をインストールする

Azure Pipelines ワークフローを更新する

ロード テストの結果の表示

リソースをクリーンアップする

次の手順

フィードバック

フィードバック

その他のリソース

ロードテストを実行するために CI/CD ワークフローを手動で構成する

リポジトリにロードテストファイルを追加する

ロードテストの結果の表示