方法: レコーダープラグインを作成する

[アーティクル]
07/13/2016

発行: 2016年7月

WebTestRecorderPlugin を使用すると、記録された Web パフォーマンステストを変更できます。変更は、[Web パフォーマンステストレコーダー] ツールバーの [停止] をクリックした後、テストが保存されて Web パフォーマンステストエディターで表示される前に行われます。

レコーダープラグインの主な利点は、動的パラメーターに対して独自のカスタム関連付けができるようになることです。組み込みの関連付け機能では、Web パフォーマンステストによる Web 記録の動的パラメーターの検出が、完了時、または Web パフォーマンステストエディターツールバーの [動的パラメーターを Web テストパラメーターに昇格] の使用時に行われます。詳細については、「[廃版] 方法: 動的パラメーターによる Web パフォーマンステスト再生の問題を解決する」を参照してください。しかし、組み込みの検出機能では、常にすべての動的パラメーターが検出できるわけではありません。たとえば、セッション ID は検出されません。通常、このパラメーターは、5 ～ 30 分の間隔で変更される値を取得しています。そのため、関連付けの処理を手動で行う必要があります。詳細については、「[廃版] 方法: 動的パラメーターを Web パフォーマンステストパラメーターに昇格する」を参照してください。

WebTestRecorderPlugin を使用すると、独自のカスタムプラグイン用のコードを記述できます。このプラグインは、テストが保存されて Web パフォーマンステストエディターで表示される前に、さまざまな方法で Web パフォーマンステストの関連付けや変更を行うことができます。そのため、特定の動的変数を多くの記録と関連付けなければならないと判断した場合は、処理を自動化できます。

レコーダープラグインの他の使用方法として、Web パフォーマンステストでの抽出規則と検証規則の追加、コンテキストパラメーターの追加、コメントからトランザクションへの変換などがあります。

次の手順では、レコーダープラグインの基本的なコードの作成、プラグインの配置、およびプラグインの実行の方法について説明します。手順の後のサンプルコードでは、Visual C# を使用してカスタムの動的パラメーター関連付けレコーダープラグインを作成する方法を示します。

必要条件

Visual Studio Enterprise

レコーダープラグインの作成

レコーダープラグインを作成するには

作成するレコーダープラグインの対象となる Web パフォーマンステストの Web パフォーマンスとロードテストのプロジェクトを含むソリューションを開きます。
ソリューションエクスプローラーで、ソリューションを右クリックし、[追加] をポイントして、[新しいプロジェクト] をクリックします。

[新しいプロジェクトの追加] ダイアログボックスが表示されます。
[インストールされているテンプレート] の [Visual C#] を選択します。
テンプレートの一覧で、[クラスライブラリ] を選択します。
[名前] ボックスにレコーダープラグインの名前を入力します。

クラスライブラリがソリューションエクスプローラーに追加され、新しいクラスがコードエディターで開かれます。
ソリューションエクスプローラーの新しいクラスライブラリプロジェクトフォルダーで、[参照設定] フォルダーを右クリックし、[参照の追加] を選択します。

ヒント

新しいクラスライブラリプロジェクトフォルダーの例は、[RecorderPlugins] です。

[参照の追加] ダイアログボックスが表示されます。
[.NET] タブを選択します。
スクロールダウンして、[Microsoft.VisualStudio.QualityTools.WebTestFramework] をクリックし、[OK] をクリックします。

[Microsoft.VisualStudio.QualityTools.WebTestFramework] がソリューションエクスプローラーの [参照設定] フォルダーに追加されます。
レコーダープラグインのコードの記述まず、WebTestRecorderPlugin クラスから派生する新しいパブリッククラスを作成します。
PostWebTestRecording メソッドをオーバーライドします。
```
public class Class1 : WebTestRecorderPlugin
    {
        public override void PostWebTestRecording(object sender, PostWebTestRecordingEventArgs e)
        {
            base.PostWebTestRecording(sender, e);
        }
    }
```
イベント引数によって、作業対象となる 2 つのオブジェクトが与えられます。記録された結果と、記録された Web パフォーマンステストです。これにより、結果を反復処理して特定の値を検索し、Web パフォーマンステスト内の同じ要求に移動して、変更を行うことができるようになります。コンテキストパラメーターや、URL のパラメーター化された部分を追加する場合は、単に Web パフォーマンステストを変更することもできます。

注意

Web パフォーマンステストを変更する場合は、RecordedWebTestModified のように、e.RecordedWebTestModified = true; プロパティを true に設定する必要もあります。
Web 記録を行った後にレコーダープラグインで何を実行するかに応じて、コードを追加します。たとえば、以下のサンプルで示すように、カスタムの関連付けを処理するコードを追加できます。コメントからトランザクションへの変換、Web パフォーマンステストへの検証規則の追加などを行うようなレコーダープラグインを作成することもできます。
[ビルド] メニューの [<クラスライブラリプロジェクト名> のビルド] をクリックします。
次に、Visual Studio に登録するためにレコーダープラグインを配置する必要があります。

レコーダープラグインの配置

レコーダープラグインをコンパイルした後で、生成された DLL を次のうちいずれかの場所に配置する必要があります。

%ProgramFiles%\Microsoft Visual Studio 12.0\Common7\IDE\PrivateAssemblies\WebTestPlugins
%USERPROFILE%\My Documents\Visual Studio <version>\WebTestPlugins

注意

レコーダープラグインを 2 つの場所の一方にコピーした後で、レコーダープラグインを登録するために Visual Studio を再起動する必要があります。

レコーダープラグインの実行

新しい Web パフォーマンステストを作成するときには、[WebTestRecorderPlugins の有効化] ダイアログボックスが表示されます。 [WebTestRecorderPlugins の有効化] ダイアログボックスには、実行できる使用可能なすべてのプラグインが表示されます。

レコーダープラグインを実行するには

新しい Web パフォーマンステストを作成します。詳細については、「Record and run a web performance test」を参照してください。

[WebTestRecorderPlugins の有効化] ダイアログボックスが表示されます。
レコーダープラグインのチェックボックスをオンにし、[OK] をクリックします。

Web パフォーマンステストが記録を完了した後で、新しいレコーダープラグインが実行されます。
警告

プラグインを使用する Web パフォーマンステストまたはロードテストを実行すると、次のようなエラーメッセージが表示されることがあります。

Request failed: Exception in <plug-in> event: Could not load file or assembly '<"Plug-in name".dll file>, Version=<n.n.n.n>, Culture=neutral, PublicKeyToken=null' or one of its dependencies.The system cannot find the file specified.

この問題が発生するのは、いずれかのプラグインのコードを変更して、新しい DLL バージョン (Version=0.0.0.0) を作成したのに、プラグインが元のプラグインバージョンを参照したままになっている場合です。この問題を解決するには、次の手順を実行します。
1. Web パフォーマンスとロードテストのプロジェクトで、参照に関する警告が表示されます。プラグイン DLL への参照を削除し、再度追加します。
2. プラグインをテストまたは該当する場所から削除し、その後、追加し直します。

使用例

このサンプルでは、カスタムの動的パラメーター関連付けを行う、カスタマイズされた Web パフォーマンステストレコーダープラグインを作成する方法を示します。

注意

サンプルコードの完全な一覧は、このトピックの最後にあります。

サンプルコードの確認

ReportSession で最初のページを検索するための、結果の反復処理

コードサンプルのこの部分では、記録された各オブジェクトを反復処理して、応答本体で ReportSession を検索します。

foreach (WebTestResultUnit unit in e.RecordedWebTestResult.Children)
 {
     WebTestResultPage page = unit as WebTestResultPage; 
     if (page != null)
     {
         if (!foundId)
         {
             int indexOfReportSession = page.RequestResult.Response.BodyString.IndexOf("ReportSession");
             if (indexOfReportSession > -1)
             {

抽出規則の追加

応答が見つかったら、抽出規則を追加する必要があります。コードサンプルのこの部分では、ExtractionRuleReference クラスを使用して抽出規則を作成し、抽出規則の追加先となる、Web パフォーマンステスト内の正しい要求を検索します。各結果オブジェクトには、DeclarativeWebTestItemId という名前の新しいプロパティが追加されており、それがコード内で Web パフォーマンステストから正しい要求を取得するために使用されています。

ExtractionRuleReference ruleReference = new ExtractionRuleReference();
ruleReference.Type = typeof(ExtractText);
ruleReference.ContextParameterName = "SessionId";
ruleReference.Properties.Add(new PluginOrRuleProperty("EndsWith", "&ControlID="));
ruleReference.Properties.Add(new PluginOrRuleProperty("HtmlDecode", "True"));
ruleReference.Properties.Add(new PluginOrRuleProperty("IgnoreCase", "True"));
ruleReference.Properties.Add(new PluginOrRuleProperty("Index", "0"));
ruleReference.Properties.Add(new PluginOrRuleProperty("Required", "True"));
ruleReference.Properties.Add(new PluginOrRuleProperty("StartsWith", "ReportSession="));
ruleReference.Properties.Add(new PluginOrRuleProperty("UseRegularExpression", "False"));

WebTestRequest requestInWebTest = e.RecordedWebTest.GetItem(page.DeclarativeWebTestItemId) as WebTestRequest;
if (requestInWebTest != null)
{
    requestInWebTest.ExtractionRuleReferences.Add(ruleReference);
    e.RecordedWebTestModified = true;
}

クエリ文字列パラメーターの置換

ここで、コードサンプルのこの部分で示されているように、名前が ReportSession であるすべてのクエリ文字列パラメーターを見つけて、値を {{SessionId}} に変更します。

WebTestRequest requestInWebTest = e.RecordedWebTest.GetItem(page.DeclarativeWebTestItemId) as WebTestRequest;
if (requestInWebTest != null)
{
    foreach (QueryStringParameter param in requestInWebTest.QueryStringParameters)
    {
         if (param.Name.Equals("ReportSession"))
         {
             param.Value = "{{SessionId}}";
         }
     }
 }

using System.ComponentModel;
using Microsoft.VisualStudio.TestTools.WebTesting;
using Microsoft.VisualStudio.TestTools.WebTesting.Rules;

namespace RecorderPlugin
{
    [DisplayName("Correlate ReportSession")]
    [Description("Adds extraction rule for Report Session and binds this to querystring parameters that use ReportSession")]
    public class CorrelateSessionId : WebTestRecorderPlugin
    {
        public override void PostWebTestRecording(object sender, PostWebTestRecordingEventArgs e)
        {
            //first find the session id
            bool foundId = false;
            foreach (WebTestResultUnit unit in e.RecordedWebTestResult.Children)
            {
                WebTestResultPage page = unit as WebTestResultPage;
                if (page != null)
                {
                    if (!foundId)
                    {
                        int indexOfReportSession = page.RequestResult.Response.BodyString.IndexOf("ReportSession");
                        if (indexOfReportSession > -1)
                        {
                            //add an extraction rule to this request
                            // Get the corresponding request in the Declarative Web performance test
                            ExtractionRuleReference ruleReference = new ExtractionRuleReference();

                            ruleReference.Type = typeof(ExtractText);
                            ruleReference.ContextParameterName = "SessionId";
                            ruleReference.Properties.Add(new PluginOrRuleProperty("EndsWith", "&ControlID="));
                            ruleReference.Properties.Add(new PluginOrRuleProperty("HtmlDecode", "True"));
                            ruleReference.Properties.Add(new PluginOrRuleProperty("IgnoreCase", "True"));
                            ruleReference.Properties.Add(new PluginOrRuleProperty("Index", "0"));
                            ruleReference.Properties.Add(new PluginOrRuleProperty("Required", "True"));
                            ruleReference.Properties.Add(new PluginOrRuleProperty("StartsWith", "ReportSession="));
                            ruleReference.Properties.Add(new PluginOrRuleProperty("UseRegularExpression", "False"));

                            WebTestRequest requestInWebTest = e.RecordedWebTest.GetItem(page.DeclarativeWebTestItemId) as WebTestRequest;
                            if (requestInWebTest != null)
                            {
                                requestInWebTest.ExtractionRuleReferences.Add(ruleReference);
                                e.RecordedWebTestModified = true;
                            }
                            foundId = true;

                        }
                    }
                    else
                    {
                        //now update query string parameters
                        WebTestRequest requestInWebTest = e.RecordedWebTest.GetItem(page.DeclarativeWebTestItemId) as WebTestRequest;
                        if (requestInWebTest != null)
                        {
                            foreach (QueryStringParameter param in requestInWebTest.QueryStringParameters)
                            {
                                if (param.Name.Equals("ReportSession"))
                                {
                                    param.Value = "{{SessionId}}";
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

参照

WebTestRequestPlugin
PostWebTestRecording
ExtractionRuleReference
PostWebTestRecording
ロードテスト用のカスタムコードおよびカスタムプラグインの作成
 [廃版] 方法: コード化された Web パフォーマンステストを作成する
 方法: 既存の Web パフォーマンステストを編集する

次の方法で共有

方法: レコーダープラグインを作成する

レコーダープラグインの作成

レコーダープラグインを作成するには

レコーダープラグインの配置

レコーダープラグインの実行

レコーダープラグインを実行するには

使用例

ReportSession で最初のページを検索するための、結果の反復処理

抽出規則の追加

クエリ文字列パラメーターの置換

参照

その他のリソース

次の方法で共有

方法: レコーダー プラグインを作成する

レコーダー プラグインの作成

レコーダー プラグインを作成するには

レコーダー プラグインの配置

レコーダー プラグインの実行

レコーダー プラグインを実行するには

使用例

ReportSession で最初のページを検索するための、結果の反復処理

抽出規則の追加

クエリ文字列パラメーターの置換

参照

その他のリソース

方法: レコーダープラグインを作成する

レコーダープラグインの作成

レコーダープラグインを作成するには

レコーダープラグインの配置

レコーダープラグインの実行

レコーダープラグインを実行するには