方法: Web パフォーマンステストエディターのカスタム HTTP ボディエディターを作成する

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

発行: 2016年7月

カスタムコンテンツエディターを作成して、Web サービス要求 (たとえば、SOAP、REST、asmx、wcf、RIA、その他の種類の Web サービス要求など) の文字列ボディのコンテンツまたはバイナリボディのコンテンツを編集できます。

必要条件

Visual Studio Enterprise

次の種類のエディターを実装できます。

文字列コンテンツエディターを使用してこの実装は、IStringHttpBodyEditorPluginインターフェイスです。
バイナリコンテンツエディターを使用してこの実装は、IBinaryHttpBodyEditorPluginインターフェイスです。

これらのインターフェイスは、Microsoft.VisualStudio.TestTools.WebTesting 名前空間に含まれます。

Windows コントロールライブラリプロジェクトの作成

Windows コントロールライブラリプロジェクトを使用して、ユーザーコントロールを作成します。

Visual Studio の [ファイル] メニューで、[新規作成]、[プロジェクト] の順にクリックします。

[新しいプロジェクト] ダイアログボックスが表示されます。
[インストールされたテンプレート] で、使用するプログラミングに応じて [Visual Basic] または [Visual C#] をクリックし、[Windows] を選択します。

注意

このサンプルでは、Visual C# を使用しています。
テンプレートの一覧で、[Windows フォームコントロールライブラリ] を選択します。
[名前] ボックスに「MessageEditors」などの名前を入力し、[OK] をクリックします。

注意

このサンプルでは、MessageEditors を使用しています。

プロジェクトが新しいソリューションに追加され、UserControl1.cs という名前の UserControl がデザイナーに表示されます。
ツールボックスの [コモンコントロール] カテゴリで、RichTextBox を UserControl1 のサーフェイスにドラッグします。
RichTextBox コントロールの右上隅にあるアクションタググリフ () をクリックして、[親コンテナーにドッキングする] を選択します。
ソリューションエクスプローラーで、Windows フォームライブラリプロジェクトを右クリックし、[プロパティ] をクリックします。
[プロパティ] の [アプリケーション] タブをクリックします。
[対象とする Framework] ボックスの一覧で、[.NET Framework 4] を選択します。
[ターゲットフレームワークの変更] ダイアログボックスが表示されます。
[はい] をクリックします。
ソリューションエクスプローラーで、[参照設定] ノードを右クリックし、[参照の追加] をクリックします。
[参照の追加] ダイアログボックスが表示されます。
[.NET] タブをクリックします。スクロールダウンし、[Microsoft.VisualStudio.QualityTools.WebTestFramework] を選択して、[OK] をクリックします。
ソリューションエクスプローラーでビューデザイナーがまだ開いていない場合は、UserControl1.cs を右クリックし、[デザイナーの表示] をクリックします。
デザインサーフェイスを右クリックし、[コードの表示] をクリックします。
(省略可能) クラスとコンストラクターの名前を、UserControl1 からわかりやすい名前 (MessageEditorControl など) に変更します。

注意

このサンプルでは、MessageEditorControl を使用しています。
```
namespace MessageEditors
{
    public partial class MessageEditorControl : UserControl
    {
        public MessageEditorControl()
        {
            InitializeComponent();
        }
    }
}
```

次のプロパティを追加して、RichTextBox1 のテキストを取得および設定できるようにします。 IStringHttpBodyEditorPlugin インターフェイスでは EditString を使用し、IBinaryHttpBodyEditorPlugin では EditByteArray を使用します。

        public String EditString
        {
            get
            {
                return this.richTextBox1.Text;
            }
            set
            {
                this.richTextBox1.Text = value;
            }
        }

public byte[] EditByteArray
        {
            get
            {
                return System.Convert.FromBase64String(richTextBox1.Text);
            }
            set
            {
                richTextBox1.Text = System.Convert.ToBase64String(value, 0, value.Length);
            }
        }

Windows コントロールライブラリプロジェクトへのクラスの追加

プロジェクトにクラスを追加します。このクラスは IStringHttpBodyEditorPlugin インターフェイスと IBinaryHttpBodyEditorPlugin インターフェイスの実装に使用されます。

この手順でのコードの概要

前の手順で作成した MessageEditorControl UserControl は、messageEditorControl としてインスタンス化されます。

private MessageEditorControl messageEditorControl

messageEditorControl インスタンスは、CreateEditor メソッドによって作成されたプラグインダイアログ内でホストされます。また、messageEditorControl の RichTextBox には、IHttpBody のコンテンツが設定されます。ただし、SupportsContentType が true を返さない場合、プラグインの作成を行うことはできません。このエディターの場合、SupportsContentType の true に "xml" が含まれているときは、ContentType は IHttpBody を返します。

文字列ボディの編集が完了し、ユーザーがプラグインダイアログボックスで [OK] をクリックすると、Web テストパフォーマンスエディターでは GetNewValue が呼び出されて、編集済みのテキストが文字列として取得され、要求の文字列ボディが更新されます。

クラスを作成して IStringHttpBodyEditorPlugin インターフェイスコードを実装するには

ソリューションエクスプローラーで、Windows フォームコントロールライブラリプロジェクトを右クリックし、[新しい項目の追加] をクリックします。
[新しい項目の追加] ダイアログボックスが表示されます。
[クラス] を選択します。
[名前] ボックスに、クラスのわかりやすい名前 (MessageEditorPlugins など) を入力します。
[追加] をクリックします。

Class1 がプロジェクトに追加され、コードエディターに表示されます。
コードエディターで、次の using ステートメントを追加します。
```
using Microsoft.VisualStudio.TestTools.WebTesting;
```

IStringHttpBodyEditorPlugin インターフェイスから XmlMessageEditor クラスをインスタンス化し、必要なメソッドを実装するために、次のコードを記述またはコピーします。

/// <summary>
/// Editor for generic text based hierarchical messages such as XML and JSON.
/// </summary>
public class XmlMessageEditor : IStringHttpBodyEditorPlugin
{
    public XmlMessageEditor()
    {
    }

    /// <summary>
    /// Determine if this plugin supports the content type.
    /// </summary>
    /// <param name="contentType">The content type to test.</param>
    /// <returns>Returns true if the plugin supports the specified content type.</returns>
    public bool SupportsContentType(string contentType)
    {
        return contentType.ToLower().Contains("xml");
    }

    /// <summary>
    /// Create a UserControl to edit the specified bytes.  
    /// This control will be hosted in the
    /// plugin dialog which provides OK and Cancel buttons.
    /// </summary>
    /// <param name="contentType">The content type of the BinaryHttpBody.</param>
    /// <param name="initialValue">The bytes to edit.  The bytes are the payload of a BinaryHttpBody.</param>
    /// <returns>A UserControl capable of displaying and editing the byte array value of the specified content type.</returns>
    public object CreateEditor(string contentType, string initialValue)
    {
        messageEditorControl = new MessageEditorControl();
        messageEditorControl.EditString = initialValue;
        return this.messageEditorControl;
    }

    /// <summary>
    /// Gets the edited bytes after the OK button is clicked on the plugin dialog.
    /// </summary>
    public string GetNewValue()
    {
        return messageEditorControl.EditString;
    }

    private MessageEditorControl messageEditorControl;
}

クラスへの IBinaryHttpBodyEditorPlugin の追加

IBinaryHttpBodyEditorPlugin インターフェイスを実装します。

この手順でのコードの概要

IBinaryHttpBodyEditorPlugin インターフェイスのコードの実装は、前の手順で説明した IStringHttpBodyEditorPlugin の場合と似ています。ただし、バイナリバージョンではバイト配列を使用して、文字列の代わりにバイナリデータを処理します。

最初の手順で作成された MessageEditorControl UserControl は、messageEditorControl としてインスタンス化されます。

private MessageEditorControl messageEditorControl

messageEditorControl インスタンスは、CreateEditor メソッドによって作成されたプラグインダイアログ内でホストされます。また、messageEditorControl の RichTextBox には、IHttpBody のコンテンツが設定されます。ただし、SupportsContentType が true を返さない場合、プラグインの作成を行うことはできません。このエディターの場合、SupportsContentType の true に "msbin1" が含まれているときは、ContentType は IHttpBody を返します。

文字列ボディの編集が完了し、ユーザーがプラグインのダイアログボックスで [OK] をクリックすると、Web テストパフォーマンスエディターで GetNewValue が呼び出されて、編集済みのテキストが文字列として取得され、要求の BinaryHttpBody.Data が更新されます。

クラスに IBinaryHttpBodyEditorPlugin を追加するには

前の手順で追加された XmlMessageEditor クラスで次のコードを記述またはコピーして、IBinaryHttpBodyEditorPlugin インターフェイスから Msbin1MessageEditor クラスをインスタンス化し、必要なメソッドを実装します。

/// <summary>
    /// Editor for MSBin1 content type (WCF messages)
    /// </summary>
    public class Msbin1MessageEditor : IBinaryHttpBodyEditorPlugin
    {
        /// <summary>
        /// 
        /// </summary>
        public Msbin1MessageEditor()
        {
        }

        /// <summary>
        /// Determine if this plugin supports a content type.
        /// </summary>
        /// <param name="contentType">The content type to test.</param>
        /// <returns>Returns true if the plugin supports the specified content type.</returns>
        public bool SupportsContentType(string contentType)
        {
            return contentType.ToLower().Contains("msbin1");
        }

        /// <summary>
        /// Create a UserControl to edit the specified bytes.  This control will be hosted in the
        /// plugin dialog which provides OK and Cancel buttons.
        /// </summary>
        /// <param name="contentType">The content type of the BinaryHttpBody.</param>
        /// <param name="initialValue">The bytes to edit.  The bytes are the payload of a BinaryHttpBody.</param>
        /// <returns>A UserControl capable of displaying and editing the byte array value of the specified content type.</returns>
        public object CreateEditor(string contentType, byte[] initialValue)
        {
            messageEditorControl = new MessageEditorControl();
            messageEditorControl.EditByteArray = initialValue;
            return messageEditorControl;
        }

        /// <summary>
        /// Gets the edited bytes after the OK button is clicked on the plugin dialog.
        /// </summary>
        public byte[] GetNewValue()
        {
            return messageEditorControl.EditByteArray;
        }

        private MessageEditorControl messageEditorControl;
        private object originalMessage;
    }

プラグインのビルドおよび配置

IStringHttpBodyEditorPlugin および IBinaryHttpBodyEditorPlugin について生成される dll をビルドおよび配置するには

[ビルド] メニューの [<Windows フォームコントロールライブラリプロジェクト名> のビルド] をクリックします。
Visual Studio のすべてのインスタンスを閉じます。

注意

これにより、.dll ファイルがコピーしようとする前にロックされていないことを確認します。
プロジェクトの bin\debug フォルダーの生成された .dll ファイル (MessageEditors.dll など) を %ProgramFiles%\Microsoft Visual Studio 12.0\Common7\IDE\PrivateAssemblies\WebTestPlugins にコピーします。
Visual Studio を開きます。

.dll が Visual Studio に登録されるようになりました。

Web パフォーマンステストによるプラグインの検証

プラグインをテストするには

テストプロジェクトを作成します。
Web パフォーマンステストを作成し、ブラウザーで Web サービスへの URL を入力します。例: http://dev.virtualearth. net/webservices/v1/metadata/searchservice/dev.virtualearth. net.webservices.v1.search.wsdl。
記録が終了したら、Web パフォーマンステストエディターで Web サービスの要求を展開し、[文字列ボディ] または [バイナリボディ] を選択します。
[プロパティ] ウィンドウで、[文字列ボディ] または [バイナリボディ] を選択し、省略記号 (...) をクリックします。

[HTTP ボディデータの編集] ダイアログボックスが表示されます。
ここでデータを編集できます。[OK] をクリックします。これにより、該当する GetNewValue メソッドを起動して、IHttpBody のコンテンツを更新できます。

コードのコンパイル

Windows コントロールライブラリプロジェクトの対象のフレームワークが .NET Framework 4.5 であることを確認します。既定では、Windows コントロールライブラリプロジェクトは .NET Framework 4.5 クライアントフレームワークを対象としますが、その場合 Microsoft.VisualStudio.QualityTools.WebTestFramework 参照を含むことは許可されません。

詳細については、「[アプリケーション] ページ (プロジェクトデザイナー) (C#)」を参照してください。

参照

IStringHttpBodyEditorPlugin
CreateEditor
SupportsContentType
GetNewValue
IBinaryHttpBodyEditorPlugin
CreateEditor
SupportsContentType
GetNewValue
IHttpBody
ContentType
UserControl
RichTextBox
ロードテスト用のカスタムコードおよびカスタムプラグインの作成
 方法 : 要求レベルのプラグインを作成する
 Web パフォーマンステストのカスタム抽出規則のコーディング
 Web パフォーマンステストのカスタム検証規則のコーディング
 方法 : ロードテストプラグインを作成する
 [廃版] 方法: コード化された Web パフォーマンステストを作成する
 方法: Web パフォーマンステスト結果ビューアー用に Visual Studio アドインを作成する

次の方法で共有

方法: Web パフォーマンステストエディターのカスタム HTTP ボディエディターを作成する

Windows コントロールライブラリプロジェクトの作成

Windows コントロールライブラリプロジェクトを使用して、ユーザーコントロールを作成します。

Windows コントロールライブラリプロジェクトへのクラスの追加

クラスを作成して IStringHttpBodyEditorPlugin インターフェイスコードを実装するには

クラスへの IBinaryHttpBodyEditorPlugin の追加

クラスに IBinaryHttpBodyEditorPlugin を追加するには

プラグインのビルドおよび配置

IStringHttpBodyEditorPlugin および IBinaryHttpBodyEditorPlugin について生成される dll をビルドおよび配置するには

Web パフォーマンステストによるプラグインの検証

プラグインをテストするには

コードのコンパイル

参照

その他のリソース

次の方法で共有

方法: Web パフォーマンス テスト エディターのカスタム HTTP ボディ エディターを作成する

Windows コントロール ライブラリ プロジェクトの作成

Windows コントロール ライブラリ プロジェクトを使用して、ユーザー コントロールを作成します。

Windows コントロール ライブラリ プロジェクトへのクラスの追加

クラスを作成して IStringHttpBodyEditorPlugin インターフェイス コードを実装するには

クラスへの IBinaryHttpBodyEditorPlugin の追加

クラスに IBinaryHttpBodyEditorPlugin を追加するには

プラグインのビルドおよび配置

IStringHttpBodyEditorPlugin および IBinaryHttpBodyEditorPlugin について生成される dll をビルドおよび配置するには

Web パフォーマンス テストによるプラグインの検証

プラグインをテストするには

コードのコンパイル

参照

その他のリソース

方法: Web パフォーマンステストエディターのカスタム HTTP ボディエディターを作成する

Windows コントロールライブラリプロジェクトの作成

Windows コントロールライブラリプロジェクトを使用して、ユーザーコントロールを作成します。

Windows コントロールライブラリプロジェクトへのクラスの追加

クラスを作成して IStringHttpBodyEditorPlugin インターフェイスコードを実装するには

Web パフォーマンステストによるプラグインの検証