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

• Azure DevOps 組織とプロジェクト。 Azure DevOps 組織がない場合は、無料で作成できます。 Azure Pipelines で作業を開始するときに支援が必要な場合は、「最初のパイプラインの作成」を参照してください。

• GitHub アカウント。 GitHub アカウントがない場合は、無料で作成できます。
• ロード テスト入力ファイルを格納し、GitHub Actions ワークフローを作成するための GitHub リポジトリ。 リポジトリを作成するには、新しいリポジトリの作成に関するページをご覧ください。

• CI パイプラインを作成または変更するためのアクセス許可。
• ロード テストの入力ファイルを保存するためのソース コード リポジトリ。

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

Azure Pipelines で、Azure DevOps プロジェクトにサービス接続を作成して、Azure サブスクリプション内のリソースにアクセスします。 サービス接続を作成すると、Azure DevOps によって Microsoft Entra サービス プリンシパル オブジェクトが作成されます。

1. Azure DevOps 組織 (https://dev.azure.com/<your-organization>) にサインインし、プロジェクトを選択します。

   <your-organization> テキスト プレースホルダーをプロジェクト識別子に置き換えます。

2. [プロジェクトの設定]>[サービス接続]>[+ New service connection] (+ 新しいサービス接続) の順に選択します。

3. [新しいサービス接続] ウィンドウで、[Azure Resource Manager] を選択して、[次へ] を選択します。

4. [サービス プリンシパル (自動)] 認証方法を選択し、[次へ] を選択します。

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

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

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

   

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

7. Azure portal で、[表示名] の値をコピーします。

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

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

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

1. Azure portal の Azure Load Testing リソースに移動します。

2. [アクセス制御 (IAM)]>[追加]>[ロールの割り当ての追加] の順に選択します。

3. [ロール] タブのジョブ関数ロールの一覧で [ロード テスト共同作成者] を選択します。

   

4. [メンバー] タブで [メンバーの選択] を選択し、前にコピーした表示名を使用してサービス プリンシパルを検索します。

5. サービス プリンシパルを選択し、[選択] を選択します。

6. [確認と 割り当て] タブで、[確認と割り当て] を選択して ロールの割り当てを追加します。

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

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

次に、Azure Load Testing リソースを使用したロード テストを作成して実行するためのアクセス許可をサービス プリンシパルに付与します。

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

Azure サブスクリプションでサービス プリンシパルを作成し、ロード テスト共同作成者ロールを割り当てて、GitHub Actions ワークフローから Azure ロード テスト リソースにアクセスしてロード テストを実行できるようにします。

1. サービス プリンシパルを作成して 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 ログイン アクションを使用する方法を確認してください。

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

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

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

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

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

1. GitHub でリポジトリを参照します。

2. [設定]>[シークレットと変数]>[アクション] の順に選択します。

3. [New repository secret] (新しいリポジトリ シークレット) を選択し、シークレット情報を入力して、[シークレットの追加] を選択して新しいシークレットを作成します。

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

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

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

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

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

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

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

2. clientId、clientSecret、tenantId の値をコピーし、CI ツール内にシークレットとして安全に保存します。

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

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

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

1. Azure DevOps Marketplace で Azure Load Testing タスク拡張機能を開き、[Get it free] (無料で入手) を選択します。

2. Azure DevOps 組織を選択し、[インストール] を選択して拡張機能をインストールします。

   選択した Azure DevOps 組織の管理者特権がない場合は、[要求] を選択して、管理者に拡張機能のインストールを依頼します。

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

Azure Pipelines ワークフローを更新して、Azure ロード テスト リソースのロード テストを実行します。

1. Azure DevOps 組織 (https://dev.azure.com/<your-organization>) にサインインし、プロジェクトを選択します。

2. 左側のナビゲーションで [パイプライン] を選択し、パイプラインを選択して、[編集] を選択し、ワークフロー定義を編集します。

   または、[パイプラインの作成] を選択して、Azure Pipelines で新しいパイプラインを作成します。

3. 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 プロパティを使用して、パラメーターまたはシークレットをロード テストに渡すことができます。

4. publish タスクを使用して、テスト結果を成果物として Azure Pipelines ワークフローの実行で発行します。

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

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

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

1. GitHub でリポジトリを参照します。

2. GitHub Actions ワークフローを編集するか、GitHub リポジトリに新しいワークフローを作成します。

3. actions/checkout アクションを使用し、ロード テスト入力ファイルを使用してリポジトリをチェックアウトします。

       - name: Checkout
         uses: actions/checkout@v3
   

4. azure/login アクションを使用し、格納されている資格情報を使用して、Azure で認証します。

   ワークフロー定義に次の YAML コンテンツを貼り付けます。

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

5. 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 プロパティを使用して、パラメーターまたはシークレットをロード テストに渡すことができます。

6. actions/upload-artifact アクションを使用して、テスト結果を成果物として GitHub Actionsワークフローの実行で発行します。

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

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

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

   前に保存した clientId、clientSecret、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. ロード テスト構成 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>
   

3. ロード テストを実行します。

   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. ロード テスト実行のクライアント側メトリックを取得して表示します。

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

1. Azure Pipelines の変更を削除します。

   1. Azure DevOps 組織 (https://dev.azure.com/<your-organization>) にサインインし、プロジェクトを選択します。

      <your-organization> テキスト プレースホルダーをプロジェクト識別子に置き換えます。

   2. 新しいパイプラインを作成した場合:

      1. [パイプライン] を選択し、使用するパイプラインを選択します。

      2. 省略記号を選択し、[削除] を選択します。

         

      3. パイプライン名を入力し、[削除] を選択してパイプラインを削除します。

   3. 既存のワークフロー定義を変更した場合は、ロード テストを実行するための変更を元に戻し、ワークフローを保存します。

2. サービス接続を削除します。

   1. [プロジェクト設定]>[サービス接続] の順に選択し、サービス接続を選択します。
   2. [編集]>[削除] の順に選択して、サービス接続を削除します。

1. GitHub Actions の変更を削除します。

   1. GitHub でリポジトリを参照します。
   2. 新しいワークフロー定義を作成した場合は、.github/workflows フォルダー内のワークフロー YAML ファイルを 削除します。
   3. 既存のワークフロー定義を変更した場合は、ロード テストを実行するための変更を元に戻し、ワークフローを保存します。

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

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

1. CI ワークフロー内の変更を元に戻します。

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

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