診断データアダプター作成用のサンプルプロジェクト

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

"MyDiagnosticDataAdapter" は、テストを実行したときに、テスト結果にログファイルを添付できる簡単な診断データアダプターです。

診断データコレクターまたは構成エディターがインストールされているコンピューターの管理アクセス許可が必要です。

使用例

このサンプルは、次のタスクを実行する方法を示します。

属性を適用し、Microsoft テストマネージャーがクラスを診断データアダプターとして検出できるようにする。
属性を適用し、Microsoft テストマネージャーがユーザーコントロールクラスをエディターとして検出し、診断データアダプター用の構成を変更して使用できるようにする。
既定の構成データにアクセスする。
特定の診断データ収集イベントに登録する。
ログファイルを DataCollectionSink に送信して添付する。

// My Data Collector Class
using Microsoft.VisualStudio.TestTools.Common;
using Microsoft.VisualStudio.TestTools.Execution;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Xml;
using System;

namespace MyCompany.MyDiagnosticDataAdapters
{
    // Provide a URI and friendly name for your diagnostic data adapter
    [DataCollectorTypeUri("datacollector://MyCompany/MyDataCollector/1.0")]
    [DataCollectorFriendlyName("Collect Log Files sample", false)]
    // Designate your chosen configuration editor
    [DataCollectorConfigurationEditor(
        "configurationeditor://MyCompany/MyDataConfigEditor/1.0")]
    public class MyDataCollector : DataCollector
    {
        private DataCollectionEvents dataEvents;
        private DataCollectionLogger dataLogger;
        private DataCollectionSink dataSink;
        private XmlElement configurationSettings;

        // Required method called by the testing framework
        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);
            dataEvents.DataRequest +=
                new EventHandler<DataRequestEventArgs>(OnDataRequest);
        }

        protected override void Dispose(bool disposing)
        {
            if (disposing)
            {
                dataEvents.SessionStart -=
                    new EventHandler<SessionStartEventArgs>(OnSessionStart);
                dataEvents.SessionEnd -=
                    new EventHandler<SessionEndEventArgs>(OnSessionEnd);
                dataEvents.TestCaseStart -=
                    new EventHandler<TestCaseStartEventArgs>(OnTestCaseStart);
                dataEvents.TestCaseEnd -=
                    new EventHandler<TestCaseEndEventArgs>(OnTestCaseEnd);
                dataEvents.DataRequest -=
                    new EventHandler<DataRequestEventArgs>(OnDataRequest);
            }
        }

        #region Event Handlers
        public void OnSessionStart(object sender, SessionStartEventArgs e)
        {
            // TODO: Provide implementation
        }

        public void OnSessionEnd(object sender, SessionEndEventArgs e)
        {
            // TODO: Provide implementation
        }

        public void OnTestCaseStart(object sender, TestCaseEventArgs e)
        {
            // TODO: Provide implementation
        }

        public void OnTestCaseEnd(object 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);
            }
        }

        public void OnDataRequest(object sender, DataRequestEventArgs e)
        {
            // TODO: Provide implementation
            // Most likely this occurs because a bug is being filed
        }
        #endregion

        // A private method to collect the configured file names
        private List<string> getFilesToCollect()
        {
            // Seetup 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;
        }
    }
}

これは、診断データアダプター用のサンプルの構成エディターです。ユーザーコントロールをプロジェクトに追加し、"ログファイル名:" というラベルと "FileTextBox" という名前のテキストボックスを持つ非常にシンプルなフォームを作成します。

using Microsoft.VisualStudio.TestTools.Common;
using Microsoft.VisualStudio.TestTools.Execution;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Xml;
using System;

namespace MyCompany.DiagnosticDataAdapters.ConfigurationEditors
{
    [DataCollectorConfigurationEditorTypeUri(
        "configurationeditor://MyCompany/MyConfigEditor/1.0")]
    public partial class MyDataConfigEditor :
        UserControl, IDataCollectorConfigurationEditor
    {
        private DataCollectorSettings collectorSettings;

        // Create a private property for the service provider
        private IServiceProvider ServiceProvider { get; set; }

        // Constructor
        public MyConfigurationEditor()
        {
            InitializeComponent();
        }

        // Required method called by the testing framework
        public void Initialize(
            IServiceProvider svcProvider,
            DataCollectorSettings settings)
        {
            ServiceProvider = svcProvider;
            collectorSettings = settings;

            // Display the file name as listed in the settings file.
            // If the configuration has not been updated before, this
            // data will be provided by the default configuration
            // section from <nameofcollector>.dll.config:
            // <DefaultConfiguration>
            //   <MyCollectorName 
            //       xmlns="http://MyCompany/schemas/ProductName/Version");
            //     <File FullPath="C:\temp\logfile1.txt" />
            //   </MyCollectorName>
            // </DefaultConfiguration>
            this.SuspendLayout();
            this.FileTextBox.Text = GetText(collectorSettings.Configuration);
            this.ResumeLayout();
        }

        // Can be used to verify data before saving it
        public bool VerifyData()
        {
            // Not currently verifying data
            return true;
        }

        // Reset to default value from XML configuration
        // using a custom method
        public void ResetToAgentDefaults()
        {
            this.FileTextBox.Text = 
                getText(collectorSettings.DefaultConfiguration);
        }

        // Saves data changed in the editor to the test configuration
        // settings. Does not change the default value.
        public DataCollectorSettings SaveData()
        {
            collectorSettings.Configuration.InnerXml =
                String.Format(
                    @"<MyCollectorName
      http://MyCompany/schemas/MyDataCollector/1.0"">
  <File FullPath=""{0}"" />
</MyCollectorName>",
                    FileTextBox.Text);
            return collectorSettings;
        }

        // Reads the configuration settings
        private string getText(XmlElement element)
        {
            // Setup namespace manager with our namespace
            XmlNamespaceManager nsmgr =
                new XmlNamespaceManager(
                    element.OwnerDocument.NameTable);

            // Find all the "File" elements under our configuration
            XmlNodeList files = element.SelectNodes("//ns:MyDataCollector/ns:File", nsmgr);
            
            string result = String.Empty;
            if (files.Count > 0)
            {
                XmlAttribute pathAttribute = files[0].Attributes["FullPath"];
                if (pathAttribute != null &&
                    !String.IsNullOrEmpty(pathAttribute.Value))
                {
                    result = pathAttribute.Value;
                }
            }

            return result;
        }
    }
}

次に、診断データコレクターの構成エディター用のサンプル構成ファイルを示します。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section 
      name="DataCollectorConfiguration"
      type="Microsoft.VisualStudio.QualityTools.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">
    <DataCollector 
        typeUri="datacollector://MyCompany/MyDataCollector/1.0">
      <DefaultConfiguraton>
        <!-- Your default config settings-->
        <File FullPath="c:\temp\logfile1.txt" />
      </DefaultConfiguration>
    </DataCollector>
  </DataCollectorConfiguration>
</configuration>

コードのコンパイル

この診断アダプター用のコードプロジェクトを作成するには

"MyDataCollector" という名前の新しいクラスライブラリプロジェクトを作成します。
ソリューションエクスプローラーで、プロジェクトを右クリックし、[プロパティ] をクリックします。追加するフォルダーを選択するために、[参照パス] をクリックし、省略記号 (...) をクリックします。

[参照パスの選択] ダイアログボックスが表示されます。
インストールディレクトリに基づき、パス Program Files\Microsoft Visual Studio 10.0\Common7\IDE\PrivateAssemblies を選択します。 [OK] をクリックします。
フォルダーを参照パスに追加するために、[フォルダーの追加] をクリックします。

フォルダーが、参照パスの一覧に表示されます。
[すべてを保存] アイコンをクリックして参照パスを保存します。
アセンブリ Microsoft.VisualStudio.QualityTools.ExecutionCommon を追加します。
1. ソリューションエクスプローラーで、[参照設定] を右クリックし、[参照の追加] をクリックします。
2. [参照] をクリックし、Microsoft.VisualStudio.QualityTools.ExecutionCommon.dll を見つけます。
  
  このアセンブリは Program Files\Microsoft Visual Studio 10.0\Common7\IDE\PrivateAssemblies にあります。
3. [OK] をクリックします。
アセンブリ Microsoft.VisualStudio.QualityTools.Common を追加します。
1. ソリューションエクスプローラーで、[参照] を右クリックし、[参照の追加] をクリックします。
2. [参照] をクリックし、Microsoft.VisualStudio.QualityTools.Common.dll を見つけます。
  
  このアセンブリは Program Files\Microsoft Visual Studio 10.0\Common7\IDE\PrivateAssemblies にあります。
3. [OK] をクリックします。
このドキュメントで既に示した診断データアダプタークラスをクラスライブラリのクラスにコピーします。このクラスを保存します。
ユーザーコントロールをプロジェクトに追加するために、ソリューションエクスプローラーの MyDataCollector プロジェクトを右クリックし、[追加] をポイントします。次に、[ユーザーコントロール] をクリックします。 [追加] をクリックします。
ツールボックスを使用して、ラベルをユーザーコントロールに追加し、Text プロパティを "ファイル名:" に変更します。
ツールボックスを使用して、テキストボックスをユーザーコントロールに追加し、名前を "textBoxFileName" に変更します。
ソリューションエクスプローラーでユーザーコントロールを右クリックし、[コードの表示] をクリックします。このユーザーコントロールクラスを、このドキュメントで既に示したユーザーコントロールクラスに置き換えます。このクラスを保存します。

注意

既定では、ユーザーコントロールに UserControl1 という名前が付けられます。ユーザーコントロールクラスのコードでユーザーコントロールの名前が使用されていることを確認してください。
構成ファイルを作成するために、ソリューションエクスプローラーでソリューションを右クリックし、[追加] をポイントします。次に、[新しい項目] をクリックします。 [アプリケーション構成ファイル] をクリックして選択し、[追加] をクリックします。これにより、App.config という名前のファイルがソリューションに追加されます。
前に提供されたサンプルから XML ファイルに XML をコピーします。ファイルを保存します。
ソリューションをビルドし、ビルドしたアセンブリと App.config ファイルを Program Files\Microsoft Visual Studio 10.0\Common7\IDE\PrivateAssemblies\DataCollectors ディレクトリにコピーします。
このカスタム診断データアダプターを使用するテストの設定を作成します。テストの設定を構成し、存在しているファイルを収集します。

Microsoft テストマネージャーからテストを実行する場合は、テストを実行する前にこれらのテストの設定をテスト計画に割り当てるか、[オプションを指定して実行] コマンドを使用して、テストの設定の割り当ておよびオーバーライドを行います。テストの設定の詳細については、「コンピューターの設定およびテストの設定を使用した診断情報の収集」を参照してください。
この診断データアダプターを選択したテストの設定を使用して、テストを実行します。

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

参照

概念

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

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

方法: カスタム診断データアダプターをインストールする

診断データアダプターを作成してカスタムデータを収集する、またはテストコンピューターに影響を与える

次の方法で共有

診断データアダプター作成用のサンプルプロジェクト

使用例

コードのコンパイル

この診断アダプター用のコードプロジェクトを作成するには

参照

概念

その他のリソース

次の方法で共有

診断データ アダプター作成用のサンプル プロジェクト

使用例

コードのコンパイル

この診断アダプター用のコード プロジェクトを作成するには

参照

概念

その他のリソース

診断データアダプター作成用のサンプルプロジェクト

この診断アダプター用のコードプロジェクトを作成するには