チュートリアル:カスタムテスト条件を使用してストアドプロシージャの結果を検証する

[アーティクル]
06/02/2023

機能の拡張に関するこのチュートリアルでは、テスト条件を作成し、SQL Server の単体テストを作成して機能を検証します。これには、テスト条件のクラスライブラリプロジェクトの作成およびクラスライブラリプロジェクトの署名とインストールが含まれます。更新するテスト条件が既にある場合は、「Visual Studio 2010 のカスタムテスト条件を、以前のリリースから SQL Server Data Tools にアップグレードする方法」をご覧ください。

このチュートリアルでは、次の作業について説明します。

テスト条件を作成する方法。
アセンブリに厳密な名前で署名する方法。
必要な参照をプロジェクトに追加する方法。
テスト条件をビルドする方法。
新しいテスト条件をインストールする方法。
新しいテスト条件をテストする方法。

このチュートリアルを最後まで行うには、Visual Studio 2010 または Visual Studio 2012 と最新バージョンの SQL Server Data Tools が必要です。詳しくは、「SQL Server Data Tools のインストール」をご覧ください。

カスタムのテスト条件を作成する

まず、クラスライブラリを作成します。

[ファイル] メニューの [新規作成] をクリックし、 [プロジェクト] をクリックします。
[新しいプロジェクト] ダイアログボックスの [プロジェクトの種類] で、[Visual C#] をクリックします。
[テンプレート] で、 [クラスライブラリ] をクリックします。
[名前] テキストボックスに「ColumnCountCondition」と入力して、 [OK] をクリックします。

次に、プロジェクトに署名します。

[プロジェクト] メニューの [ColumnCountCondition のプロパティ] をクリックします。
[署名] タブの [アセンブリの署名] チェックボックスをオンにします。
[厳密な名前のキーファイルを選択してください] で、[<新規作成...>] をクリックします。

[厳密な名前キーの作成] ダイアログボックスが表示されます。
[キーファイル] ボックスに「SampleKey」と入力します。
パスワードを入力および確認し、 [OK] をクリックします。ソリューションをビルドすると、キーファイルを使用してアセンブリに署名されます。
[ファイル] メニューの [すべてを保存] をクリックします。
[ビルド] メニューの [ソリューションのビルド] をクリックします。

次に、必要な参照をプロジェクトに追加します。

ソリューションエクスプローラーで、ColumnCountCondition プロジェクトを選択します。
[プロジェクト] メニューの [参照の追加] をクリックし、 [参照の追加] ダイアログボックスを表示します。
[.NET] タブを選択します。
[コンポーネント名] 列で、System.ComponentModel.Composition コンポーネントを探して選択します。コンポーネントを選択した後、 [OK] をクリックします。
必要なアセンブリ参照を追加します。プロジェクトノードを右クリックし、 [参照の追加] をクリックします。 [参照] をクリックし、C:\Program Files (x86)\Microsoft SQL Server\110\DAC\Binフォルダーに移動します。 Microsoft.Data.Tools.Schema.Sql.dll を選択し、[追加] をクリックして、[OK] をクリックします。
[プロジェクト] メニューの [プロジェクトのアンロード] をクリックします。
ソリューションエクスプローラーでプロジェクトを右クリックして、[<プロジェクト名>.csproj の編集] をクリックします。

Microsoft.CSharp.targets をインポートした後、次の Import ステートメントを追加します。

<Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v10.0\SSDT\Microsoft.Data.Tools.Schema.Sql.UnitTesting.targets" Condition="'$(VisualStudioVersion)' == ''" />  

<Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\SSDT\Microsoft.Data.Tools.Schema.Sql.UnitTesting.targets" Condition="'$(VisualStudioVersion)' != ''" />

ファイルを保存して閉じます。 ソリューションエクスプローラーでプロジェクトを右クリックして、 [プロジェクトの再読み込み] をクリックします。

ソリューションエクスプローラーで、プロジェクトの [参照設定] ノードの下に必要な参照が表示されます。

ResultSetColumnCountCondition クラスを作成する

Class1 の名前を ResultSetColumnCountCondition に変更し、testcondition から派生するようにします。 ResultSetColumnCountCondition クラスは、ResultSet に返される列数を検証する簡単なテスト条件です。この条件は、ストアドプロシージャのコントラクトに誤りがないことを確認するために使用できます。

ソリューションエクスプローラーで、Class1.cs を右クリックし、 [名前の変更] をクリックして「ResultSetColumnCountCondition.cs」と入力します。
[はい] をクリックして、Class1 へのすべての参照名の変更を確定します。

ResultSetColumnCountCondition.cs ファイルを開き、次の using ステートメントをファイルに追加します。

using System;  
using System.ComponentModel;  
using System.Data;  
using System.Data.Common;  
using Microsoft.Data.Tools.Schema.Sql.UnitTesting;  
using Microsoft.Data.Tools.Schema.Sql.UnitTesting.Conditions;  

namespace ColumnCountCondition {  
    public class ResultSetColumnCountCondition

testcondition からクラスを派生します。

public class ResultSetColumnCountCondition : TestCondition

ExportTestConditionAttribute を追加します。 UnitTesting.Conditions.ExportTestConditionAttribute について詳しくは、「SQL Server 単体テストデザイナーのテスト条件を作成する方法」をご覧ください。
```
[ExportTestCondition("ResultSet Column Count", typeof(ResultSetColumnCountCondition))]  
    public class ResultSetColumnCountCondition : TestCondition  
```

メンバー変数とコンストラクターを作成します。

        private int _resultSet;  
        private int _count;  
        private int _batch;  

        public ResultSetColumnCountCondition() {  
            _resultSet = 1;  
            _count = 0;  
            _batch = 1;  
        }

Assert メソッドをオーバーライドします。このメソッドは、IDbConnection (データベースへの接続を表します) と SqlExecutionResult を引数として受け取ります。このメソッドは、エラー処理に DataSchemaException を使います。

       //method you need to override  
        //to perform the condition verification  
        public override void Assert(DbConnection validationConnection, SqlExecutionResult[] results)  
        {  
            //call base for parameter validation  
            base.Assert(validationConnection, results);  

            //verify batch exists  
            if (results.Length < _batch)  
                throw new DataException(String.Format("Batch {0} does not exist", _batch));  

            SqlExecutionResult result = results[_batch - 1];  

            //verify resultset exists  
            if (result.DataSet.Tables.Count < ResultSet)  
                throw new DataException(String.Format("ResultSet {0} does not exist", ResultSet));  

            DataTable table = result.DataSet.Tables[ResultSet - 1];  

            //actual condition verification  
            //verify resultset column count matches expected  
            if (table.Columns.Count != Count)  
                throw new DataException(String.Format(  
                    "ResultSet {0}: {1} columns did not match the {2} columns expected",  
                    ResultSet, table.Columns.Count, Count));  
        }  

Add the following method, which overrides the ToString method:  
C#  
        //this method is called to provide the string shown in the  
        //test conditions panel grid describing what the condition tests  
        public override string ToString()  
        {  
            return String.Format(  
                "Condition fails if ResultSet {0} does not contain {1} columns",  
                ResultSet, Count);  
        }

CategoryAttribute、DisplayNameAttribute、DescriptionAttribute の各属性を使って、次のテスト条件プロパティを追加します。

        //below are the test condition properties  
        //that are exposed to the user in the property browser  
        #region Properties  

        //property specifying the resultset for which  
        //you want to check the column count  
        [Category("Test Condition")]  
        [DisplayName("ResultSet")]  
        [Description("ResultSet Number")]  
        public int ResultSet  
        {  
            get { return _resultSet; }  

            set  
            {  
                //basic validation  
                if (value < 1)  
                    throw new ArgumentException("ResultSet cannot be less than 1");  

                _resultSet = value;  
            }  
        }  

        //property specifying  
        //expected column count  
        [Category("Test Condition")]  
        [DisplayName("Count")]  
        [Description("Column Count")]  
        public int Count  
        {  
            get { return _count; }  

            set  
            {  
                //basic validation  
                if (value < 0)  
                    throw new ArgumentException("Count cannot be less than 0");  

                _count = value;  
            }  
        }  
         #endregion

最終のコードリストを以下に示します。

using System;  
using System.ComponentModel;  
using System.Data;  
using System.Data.Common;  
using Microsoft.Data.Tools.Schema.Sql.UnitTesting;  
using Microsoft.Data.Tools.Schema.Sql.UnitTesting.Conditions;  
  
namespace ColumnCountCondition  
{  
  
    [ExportTestCondition("ResultSet Column Count", typeof(ResultSetColumnCountCondition))]  
    public class ResultSetColumnCountCondition : TestCondition  
    {  
        private int _resultSet;  
        private int _count;  
        private int _batch;  
  
        public ResultSetColumnCountCondition()  
        {  
            _resultSet = 1;  
            _count = 0;  
            _batch = 1;  
        }  
  
        //method you need to override  
        //to perform the condition verification  
        public override void Assert(DbConnection validationConnection, SqlExecutionResult[] results)  
        {  
            //call base for parameter validation  
            base.Assert(validationConnection, results);  
  
            //verify batch exists  
            if (results.Length < _batch)  
                throw new DataException(String.Format("Batch {0} does not exist", _batch));  
  
            SqlExecutionResult result = results[_batch - 1];  
  
            //verify resultset exists  
            if (result.DataSet.Tables.Count < ResultSet)  
                throw new DataException(String.Format("ResultSet {0} does not exist", ResultSet));  
  
            DataTable table = result.DataSet.Tables[ResultSet - 1];  
  
            //actual condition verification  
            //verify resultset column count matches expected  
            if (table.Columns.Count != Count)  
                throw new DataException(String.Format(  
                    "ResultSet {0}: {1} columns did not match the {2} columns expected",  
                    ResultSet, table.Columns.Count, Count));  
        }  
  
        //this method is called to provide the string shown in the  
        //test conditions panel grid describing what the condition tests  
        public override string ToString()  
        {  
            return String.Format(  
                "Condition fails if ResultSet {0} does not contain {1} columns",  
                ResultSet, Count);  
        }  
  
        //below are the test condition properties  
        //that are exposed to the user in the property browser  
        #region Properties  
  
        //property specifying the resultset for which  
        //you want to check the column count  
        [Category("Test Condition")]  
        [DisplayName("ResultSet")]  
        [Description("ResultSet Number")]  
        public int ResultSet  
        {  
            get { return _resultSet; }  
  
            set  
            {  
                //basic validation  
                if (value < 1)  
                    throw new ArgumentException("ResultSet cannot be less than 1");  
  
                _resultSet = value;  
            }  
        }  
  
        //property specifying  
        //expected column count  
        [Category("Test Condition")]  
        [DisplayName("Count")]  
        [Description("Column Count")]  
        public int Count  
        {  
            get { return _count; }  
  
            set  
            {  
                //basic validation  
                if (value < 0)  
                    throw new ArgumentException("Count cannot be less than 0");  
  
                _count = value;  
            }  
        }  
  
        #endregion  
    }  
}

次に、プロジェクトをビルドします。

プロジェクトをコンパイルしてテスト条件をインストールする

[ビルド] メニューの [ソリューションのビルド] をクリックします。

次に、アセンブリ情報を Extensions ディレクトリにコピーします。 Visual Studio が起動すると、%Program Files%\Microsoft Visual Studio <Version>\Common7\IDE\Extensions\Microsoft\SQLDB\TestConditions ディレクトリとサブディレクトリ内のすべての機能拡張を識別し、使用できる状態にします。

ColumnCountCondition.dll アセンブリファイルを、出力ディレクトリから %Program Files%\Microsoft Visual Studio <Version>\Common7\IDE\Extensions\Microsoft\SQLDB\TestConditions ディレクトリにコピーします。

既定では、コンパイル済みの .dll ファイルのパスは YourSolutionPath\YourProjectPath\bin\Debug または YourSolutionPath\YourProjectPath\bin\Release です。

次に、Visual Studio の新しいセッションを開始して、データベースプロジェクトを作成します。新しい Visual Studio セッションを開始してデータベースプロジェクトを作成するには:

Visual Studio の 2 つ目のセッションを開始します。
[ファイル] メニューの [新規作成] をクリックし、 [プロジェクト] をクリックします。
[新しいプロジェクト] ダイアログボックスのインストール済みテンプレートの一覧で、 [SQL Server] ノードを選択します。
詳細ウィンドウで、 [SQL Server データベースプロジェクト] をクリックします。
[名前] テキストボックスに「SampleConditionDB」と入力して、 [OK] をクリックします。

次に、単体テストを作成します。新しいテストクラス内に SQL Server の単体テストを作成するには:

[テスト] メニューの [新しいテスト] をクリックし、 [新しいテストの追加] ダイアログボックスを表示します。

また、ソリューションエクスプローラーでテストプロジェクトを右クリックし、 [追加] をポイントして、 [新しいテスト] をクリックすることもできます。
テンプレートの一覧で、 [SQL Server 単体テスト] をクリックします。
[テスト名] に「SampleUnitTest」と入力します。
[テストプロジェクトに追加] で、[新しい Visual C# テストプロジェクトの作成] をクリックします。続いて、 [OK] をクリックして [新しいテストプロジェクト] ダイアログボックスを表示します。
プロジェクト名に「SampleUnitTest」と入力します。
[キャンセル] をクリックして、データベース接続を使用するテストプロジェクトを構成せずに単体テストを作成します。 SQL Server 単体テストデザイナーに、空白のテストが表示されます。テストプロジェクトに Visual C# のソースコードファイルが追加されます。

データベース接続が関連付けられたデータベース単体テストの作成および構成の詳細については、「空の SQL Server の単体テストを作成する方法」を参照してください。
[作成するにはここをクリックしてください] をクリックし、単体テストの作成を完了します。 SQL Server プロジェクトに新しいテスト条件が表示されます。

Note

既存の単体テストプロジェクトでカスタムのテスト条件を使用するには、1 つ以上の新しい SQL Server の単体テストクラスを作成する必要があります。テスト条件アセンブリへの必要な参照は、テストクラスの作成時にテストプロジェクトに追加されます。

新しいテスト条件を表示するには、次の手順を実行します。

SQL Server 単体テストデザイナーで、 [テスト条件] の [名前] 列にある inconclusiveCondition1 テストをクリックします。
[テスト条件を削除します] ツールバーボタンをクリックして、inconclusiveCondition1 テストを削除します。
[テスト条件] ボックスをクリックし、 [ResultSet 列数] を選択します。
[テスト条件を追加します] ツールバーボタンをクリックして、カスタムのテスト条件を追加します。
[プロパティ] ウィンドウで、Count プロパティ、Enabled プロパティ、および ResultSet プロパティを構成します。

詳細については、「SQL Server の単体テストにテスト条件を追加する方法」を参照してください。

参照

SQL Server の単体テストのカスタムテスト条件

次の方法で共有

チュートリアル:カスタムテスト条件を使用してストアドプロシージャの結果を検証する

カスタムのテスト条件を作成する

ResultSetColumnCountCondition クラスを作成する

プロジェクトをコンパイルしてテスト条件をインストールする

参照

フィードバック

その他のリソース

次の方法で共有

チュートリアル:カスタム テスト条件を使用してストアド プロシージャの結果を検証する

カスタムのテスト条件を作成する

ResultSetColumnCountCondition クラスを作成する

プロジェクトをコンパイルしてテスト条件をインストールする

参照

フィードバック

その他のリソース

チュートリアル:カスタムテスト条件を使用してストアドプロシージャの結果を検証する