方法: カスタム診断データアダプターを作成する

[アーティクル]
08/09/2011

診断データアダプターを作成するには、Microsoft Visual Studio 2010 を使用してクラスライブラリを作成し、Microsoft Visual Studio 2010 Premium に用意されている診断データアダプターの API をクラスライブラリに追加します。テストの実行中に発生したイベントを処理するときに、フレームワークによって提供される DataCollectionSink に対し、ストリームまたはファイルとして情報を送信します。 DataCollectionSink に送信したストリームまたはファイルは、テスト完了時点でテスト結果に対する添付ファイルとして保存されます。テスト結果からバグを作成すると、またはテストランナーを使用すると、ファイルはバグにもリンクされます。

テストを実行するマシン、またはテスト対象のアプリケーションを実行するために使用している環境の一部を構成するマシンに影響を与える診断データアダプターを作成できます。たとえば、テストを実行するテストマシンでのファイルの収集や、アプリケーションに対して Web サーバーロールで実行されているマシンでのファイルの収集などが挙げられます。

診断データアダプターには表示名を設定できます。表示名は、テストマネージャーまたは Microsoft Visual Studio 2010 を使用してテストの設定を作成するときに表示されます。テストの設定を使用すると、テストの実行時に、使用している環境下で、どのマシンロールが特定の診断データアダプターを実行するかを定義できます。診断データアダプターは、テストの設定を作成するときに構成することもできます。たとえば、Web サーバーからカスタムログを収集する診断データアダプターを作成できます。テストの設定を作成するとき、この Web サーバーの役割を実行しているマシン上でこの診断データアダプターを実行するように選択できます。また、作成された最新の 3 つのログだけを収集するようにテストの設定の構成を変更できます。テストの設定の詳細については、「コンピューターの設定およびテストの設定を使用した診断情報の収集」を参照してください。

イベントは、テストでイベントが発生した時点で診断データアダプターがタスクを実行できるように、テストの実行時に発生します。

重要

これらのイベントは、特に複数のマシンでテストを実行する場合に、異なるスレッドで発生する可能性があります。そのため、スレッドに関する問題が発生する可能性を認識し、カスタムアダプターの内部データが誤って破損しないようにする必要があります。診断データアダプターがスレッドセーフであることを確認してください。

診断データアダプターを作成するときに使用できる主なイベントを次に示します。診断データアダプターのイベントの完全な一覧については、DataCollectionEvents 抽象クラスを参照してください。

イベント	説明
SessionStart	テストの実行を開始します。
SessionEnd	テストの実行を終了します。
TestCaseStart	テストの実行で各テストを開始します。
TestCaseEnd	テストの実行で各テストを終了します。
TestStepStart	テストで各テストステップを開始します。
TestStepEnd	テストで各テストステップを終了します。

注意

手動テストが完了すると、これ以降、データ収集イベントは診断データアダプターに送信されません。テストを再実行すると、テストケース識別子が新しくなります。ユーザーがテスト中にテストをリセットするか (TestCaseReset イベントが発生します)、またはテストステップを変更すると、これ以降、データ収集イベントは診断データアダプターに送信されません。ただし、テストケース識別子は変更されません。テストケースがリセットされているかどうかを確認するには、診断データアダプターでテストケース識別子を追跡する必要があります。

テストの設定を作成するときに構成した情報に基づいてデータファイルを収集する診断データアダプターを作成するには、次の手順に従って操作します。

カスタムの構成エディターを含む、診断データアダプタープロジェクトのサンプル全体については、「診断データアダプター作成用のサンプルプロジェクト」を参照してください。

診断データアダプターの作成とインストール

診断データアダプターを作成してインストールするには

新しいクラスライブラリを作成します。
1. [ファイル] メニューの [新規作成] をクリックし、[新しいプロジェクト] をポイントします。
2. [プロジェクトの種類] で使用する言語をクリックします。
3. [Visual Studio にインストールされたテンプレート] で [クラスライブラリ] をクリックします。
4. 診断データアダプターの名前を入力します。
5. [OK] をクリックします。
アセンブリ Microsoft.VisualStudio.QualityTools.ExecutionCommon を追加します。
1. ソリューションエクスプローラーで、[参照] を右クリックし、[参照の追加] をクリックします。
2. [.NET] をクリックし、Microsoft.VisualStudio.QualityTools.ExecutionCommon.dll を見つけます。
3. [OK] をクリックします。
アセンブリ Microsoft.VisualStudio.QualityTools.Common を追加します。
1. ソリューションエクスプローラーで、[参照] を右クリックし、[参照の追加] をクリックします。
2. [/.NET] をクリックし、Microsoft.VisualStudio.QualityTools.Common.dll を見つけます。
3. [OK] をクリックします。

クラスファイルに次の using ステートメントを追加します。

using Microsoft.VisualStudio.TestTools.Common;
using Microsoft.VisualStudio.TestTools.Execution;
using System.Linq;
using System.Text;
using System.Xml;
using System;

診断データアダプター用のクラスに DataCollectorTypeUriAttribute を追加して、診断データアダプターとして識別します。このとき、Company、Product、および Version を診断データアダプターに応じた情報に置き換えます。
```
[DataCollectorTypeUri("datacollector://Company/Product/Version")]
```
クラスに DataCollectorFriendlyNameAttribute 属性を追加して、パラメーターを診断データアダプターに応じた情報に置き換えます。
```
[DataCollectorFriendlyName("Collect Log Files", false)]
```
テストの設定アクティビティに表示名が表示されます。

注意

また、DataCollectorConfigurationEditorAttribute を追加して、このデータアダプターのカスタム構成エディターの Type を指定し、必要に応じて、エディターに使用するヘルプファイルを指定できます。

また、DataCollectorEnabledByDefaultAttribute を適用し、常に有効にすべきであることを指定できます。
診断データアダプターのクラスは、次のように、DataCollector クラスから継承する必要があります。
```
public class MyDiagnosticDataAdapter : DataCollector
```

次のように、ローカル変数を追加します。

private DataCollectionEvents dataEvents;
private DataCollectionLogger dataLogger;
private DataCollectionSink dataSink;
private XmlElement configurationSettings;

Initialize メソッドと Dispose メソッドを追加します。 Initialize メソッドでは、次のように、データシンクおよびテストの設定の構成データを初期化し、使用するイベントハンドラーを登録します。

public override void Initialize(
    XmlElement configurationElement, 
    DataCollectionEvents events, 
    DataCollectionSink sink, 
    DataCollectionLogger logger, 
    DataCollectionEnvironmentContext environmentContext)
{
       dataEvents = events;  // The test events
       dataLogger = logger;  // The error and warning log
       dataSink = sink;      // Saves collected data
       // Configuration from the test settings
       configurationSettings = configurationElement;

       // Register common events for the data collector
       // Not all of the events are used in this class
    dataEvents.SessionStart += 
        new EventHandler<SessionStartEventArgs>(OnSessionStart);
    dataEvents.SessionEnd += 
        new EventHandler<SessionEndEventArgs>(OnSessionEnd);
    dataEvents.TestCaseStart += 
        new EventHandler<TestCaseStartEventArgs>(OnTestCaseStart);
    dataEvents.TestCaseEnd += 
        new EventHandler<TestCaseEndEventArgs>(OnTestCaseEnd);
}

public override void Dispose(bool disposing)
{
    if (disposing)
    {
        // Unregister the registered events
        dataEvents.SessionStart -= 
            new EventHandler<SessionStartEventArgs>(OnSessionStart);
        dataEvents.SessionEnd -= 
            new EventHandler<SessionEndEventArgs>(OnSessionEnd);
        dataEvents.TestCaseStart -= 
            new EventHandler<TestCaseStartEventArgs>(OnTestCaseStart);
        dataEvents.TestCaseEnd -= 
            new EventHandler<TestCaseEndEventArgs>(OnTestCaseEnd);
    }
}

次のようなイベントハンドラーコードとプライベートメソッドを使用して、テスト中に生成されるログファイルを収集します。

public void OnTestCaseEnd(sender, TestCaseEndEventArgs e)
{
    // Get any files to be collected that are
    // configured in your test settings
    List<string> files = getFilesToCollect();

    // For each of the files, send the file to the data sink
    // which will attach it to the test results or to a bug
    foreach (string file in files)
    {
        dataSink.SendFileAsync(e.Context, file, false);
    }
}

// A private method that returns the file names
private List<string> getFilesToCollect()
{
    // Get a namespace manager with our namespace
    XmlNamespaceManager nsmgr =
        new XmlNamespaceManager(
            configurationSettings.OwnerDocument.NameTable);
    nsmgr.AddNamespace("ns", 
        "http://MyCompany/schemas/MyDataCollector/1.0");

    // Find all of the "File" elements under our configuration
    XmlNodeList files =
        configurationSettings.SelectNodes(
            "//ns:MyDataCollector/ns:File");

    // Build the list of files to collect from the 
    // "FullPath" attributes of the "File" nodes.
    List<string> result = new List<string>();
    foreach (XmlNode fileNode in files)
    {
        XmlAttribute pathAttribute = 
            fileNode.Attributes["FullPath"];
        if (pathAttribute != null &&
            !String.IsNullOrEmpty(pathAttribute.Value))
        {
            result.Add(pathAttribute.Value);
        }
    }

    return result;
}

これらのファイルは、テスト結果に添付されます。これらのテスト結果からバグを作成する場合、またはテストランナーを使用する場合、ファイルはバグにも添付されます。

独自のエディターを使用してデータを収集し、テストの設定に使用する場合は、「方法: 診断データアダプター用のデータのカスタムエディターを作成する」を参照してください。

テストが終了したときに、ユーザーによるテストの設定の構成に基づいてログファイルを収集するには、App.config ファイルを作成し、ソリューションに追加する必要があります。このファイルは次の形式で作成し、識別するために診断データアダプターの URI が含まれる必要があります。 "Company/ProductName/Version" を実際の値に置き換えてください。

注意

診断データアダプターの情報を構成する必要がない場合は、構成ファイルを作成する必要はありません。
```
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="DataCollectorConfiguration" 
      type="Microsoft.VisualStudio.TestTools.Execution.DataCollectorConfigurationSection, 
      Microsoft.VisualStudio.QualityTools.ExecutionCommon, 
      Version=4.0.0.0, Culture=neutral, 
      PublicKeyToken=b03f5f7f11d50a3a" />
  </configSections>
  <DataCollectorConfiguration 
    xmlns="https://microsoft.com/schemas/VisualStudio/TeamTest/2010">
    <DefaultConfiguration>
      
        <File FullPath="C:\temp\logfile1.txt"/>
        <File FullPath="C:\temp\logfile2.txt"/>
    </DefaultConfiguration>
  </DataCollectorConfiguration>
</configuration> 
```
注意

既定の構成要素には必要なデータを含めることができます。テストの設定で診断データアダプターを構成しなかった場合は、実行時に既定のデータが診断データアダプターに渡されます。 <DefaultConfigurations> セクションに追加する XML は、宣言されたスキーマの一部となる可能性が少ないため、生成される XML エラーを無視できます。

その他の構成ファイルの例については、インストールディレクトリ内の Program Files\Microsoft Visual Studio 10.0\Common7\IDE\PrivateAssemblies\DataCollectors を参照してください。

テストの実行時に環境を使用するようにテストの設定を構成する方法の詳細については、「手動テストのテスト設定の作成」または「テスト計画の一部としての自動テストのテスト設定の作成」を参照してください。

構成ファイルのインストールの詳細については、「方法: カスタム診断データアダプターをインストールする」を参照してください。
ソリューションをビルドして、診断データアダプターのアセンブリを作成します。
カスタムエディターをインストールする方法については、「方法: カスタム診断データアダプターをインストールする」を参照してください。
テストの実行時に環境を使用するようにテストの設定を構成する方法の詳細については、「手動テストのテスト設定の作成」または「テスト計画の一部としての自動テストのテスト設定の作成」を参照してください。
診断データアダプターを選択するには、まず既存のテストの設定を選択するか、Microsoft テストマネージャーまたは Microsoft Visual Studio 2010 から新しく作成します。アダプターは、テストの設定の [データと診断] タブに、クラスに割り当てた表示名と共に表示されます。
Microsoft テストマネージャーからテストを実行する場合は、テストを実行する前にこれらのテストの設定をテスト計画に割り当てるか、[オプションを指定して実行] コマンドを使用して、テストの設定の割り当ておよびオーバーライドを行います。テストの設定の詳細については、「コンピューターの設定およびテストの設定を使用した診断情報の収集」を参照してください。

Microsoft Visual Studio 2010 からテストを実行する場合は、これらのテストの設定をアクティブとして設定する必要があります。テストの設定の詳細については、「Visual Studio から自動テストを実行するためのテストの設定の作成」を参照してください。
この診断データアダプターを選択したテストの設定を使用して、テストを実行します。

指定したデータファイルがテスト結果に関連付けられます。