方法: 単体テストを作成して実行する

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

単体テストを実行することにより、開発者およびテスト担当者は、C#、Visual Basic、.NET、および C++ のプロジェクトでクラスのメソッドに論理エラーがないかをすばやく確認できます。単体テストは、1 回作成するだけでよく、バグが追加されていないことを確認するために、ソースコードが変更されるたびに実行できます。

このトピックでは、Microsoft Visual Studio 2010 の単体テストツールを使用して、既存のコードから単体テストのスケルトンを自動的に生成する方法、検証を追加してそのスケルトンを設定する方法、テストカテゴリを作成する方法、テストリストを作成する方法、テストを実行する方法、およびコードカバレッジの結果を確認する方法について説明します。

単体テスト部分の詳細については、「単体テストの構造」を参照してください。

単体テストの例

この例は、「チュートリアル : 単体テストの作成と実行」に基づいています。

以下に、[単体テストの作成] ダイアログボックスの図を示します。このダイアログボックスは、メソッドが含まれているコードファイルを右クリックし、[単体テストの作成] をクリックすると表示されます。このダイアログボックスの [型] の一覧で選択したすべてのメソッドについて、単体テストが生成されます。

次の図は、この例では Credit メソッドおよび Debit メソッドについて単体テストが生成されることを示しています。

[単体テストの作成] ダイアログボックス

単体テストを生成すると、コードファイルが作成され、変更内容がソリューションエクスプローラーに表示されます。

次の図は、単体テストの作成結果を示しています。

アート状態に必要なタイトル所有者

[単体テストの作成] ダイアログボックスで選択したメソッドごとに、個別の単体テストが作成されます。この例では、Credit メソッドおよび Debit メソッドの単体テストが生成されています。
生成された各単体テストには、空の変数と、プレースホルダーの Assert ステートメントが設定されています。既定のプレースホルダーの Assert ステートメントは、通常、Assert.Inconclusive ステートメントです。
テストを意味のあるものにするために、変数を初期化し、このプレースホルダーを適切な Assert ステートメントに置き換える必要があります。この例では、Credit の単体テストは生成時の状態のままにしていますが、Debit テストメソッドの変数を初期化し、Assert ステートメントを置き換えています。
単体テストを初めて生成したときに、テストプロジェクトがソリューション内に作成されます。
テストするクラスごとに、個別の単体テストファイルがテストプロジェクト内に作成されます。この例では、テストするメソッドの両方が同じクラスに属しています。したがって、作成される単体テストファイルは BankAccountTest.cs の 1 つだけです。
テストを実行すると、テストの実行結果が [テスト結果] ウィンドウに表示されます。

単体テストを作成する

単体テストの作成には、2 つのフェーズがあります。

最初のフェーズでは、テストするコード内のメソッドごとに、スケルトン形式のテストメソッドが格納された単体テストファイルを生成します。スケルトンの各テストメソッドは、空の変数と、プレースホルダーの Assert ステートメントが設定された状態で生成されます。

2 番目のフェーズでは、変数を初期化し、プレースホルダーの Assert ステートメントを適切なステートメントに置き換えます。

単体テストのスケルトンを生成する

[単体テストの生成] ダイアログボックスを使用して、テストするコード内の任意またはすべてのメソッドについて単体テストを生成します。

注意

通常は private、internal、friend などの属性でマークされたメソッドにはそのメソッドのクラスの外部からアクセスできませんが、Microsoft Visual Studio 2010 のツールを使用すると、単体テストがこれらのメソッドにアクセスできるようになります。このしくみの詳細については、「プライベートメソッド、内部メソッド、およびフレンドメソッドの単体テスト」を参照してください。

単体テストのスケルトンを生成するには

Visual Studio コードエディター ウィンドウで、テストするコードを開きます。
(ASP.NET サービスの場合) ASP.NET Web サービスをテストする場合は、.aspx ページがプロジェクトに含まれていることを確認します。 .aspx ページのないプロジェクトで Web サービスの単体テストを作成すると、テストを実行したときにエラーが発生します。詳細については、「ASP.NET Web サービスの単体テスト」を参照してください。
テストする名前空間、クラス、またはメソッドを右クリックし、[単体テストの作成] をクリックします。
[単体テストの生成] ダイアログボックスで、単体テストファイルに追加するすべてのメソッドのチェックボックスをオンにします。
(省略可能) [設定] をクリックし、作成する単体テストの既定の設定を変更します。以下は Visual Studio の設定であり、設定を再度変更するまでは、作成するすべての単体テストに適用されます。
- [名前付けの設定]: 単体テストの生成時のテストファイル、テストクラス、およびテストメソッドの命名方法をカスタマイズするためのオプションです。
- [既定ですべての結果不確定のテスト結果をマークする]: 各テストメソッドでプレースホルダーの Assert として Assert.Inconclusive() ステートメントを使用するには、このチェックボックスをオンにします。プレースホルダーの Assert を除去するには、このチェックボックスをオフにします。
- [ドキュメントコメントを有効にする]: 各テストメソッドにプレースホルダーコメントを用意するには、このチェックボックスをオンにします。プレースホルダーコメントを除去するには、このチェックボックスをオフにします。
- [InternalsVisibleTo 属性を有効にする]: Friend または Internal でマークされたメソッドがパブリックメソッドと同じように扱われるようにするには、このチェックボックスをオンにします (推奨)。プライベートアクセサーを使用してこれらのメソッドをテストするには、このチェックボックスをオフにします。プライベートアクセサーの詳細については、「プライベートメソッド、内部メソッド、およびフレンドメソッドの単体テスト」を参照してください。
(省略可能) ソースコードがないアセンブリ内のメソッドのテストを追加するには、[アセンブリの追加] をクリックします。詳細については、「方法: ソースコードなしで単体テストを作成する」を参照してください。
[出力プロジェクト] ボックスで、次のいずれかの操作を実行します。
- 新しいテストプロジェクトを作成するには、新しいプロジェクトの言語を選択し、[OK] をクリックします。 [新しいテストプロジェクト] ダイアログボックスが表示されます。プロジェクトの名前を入力するか、既定の名前を受け入れ、[作成] をクリックします。
- [単体テストの作成] ダイアログボックスで選択したメソッドを既存のテストプロジェクトの単体テストファイルに追加するには、ドロップダウンリストでそのプロジェクトをクリックし、[OK] をクリックします。

単体テストに検証を追加する

単体テストファイルの各テストメソッドは、空の変数と、プレースホルダーの Assert ステートメントが設定された状態で生成されます。このようなテストを実行することはできますが、実際のデータがないため、メソッドの動作が予想どおりであるかどうかを確認することはできません。テストを意味のあるものにするために、変数を初期化して、プレースホルダーの Assert ステートメントをそのメソッドに適したものに置き換える必要があります。多くの場合、Assert.AreEqual ステートメントが使用されます。

単体テストに検証を追加するには

単体テストファイルを開き、変数を初期化する単体テストを探します。
単体テストで変数代入を探します。

新しく生成されたテストでは、変数代入が "TODO" ステートメントによってマークされており、代入をカスタマイズするよう示されています。たとえば、編集する必要のある一般的な代入の例を次に示します。

string target.owner = null; // TODO: Initialize to an appropriate value
適切な値を各変数に代入します。適切な変数の代入の例については、「チュートリアル : 単体テストの作成と実行」の「単体テストを実行およびカスタマイズする」を参照してください。

注意

データドリブン単体テストを作成することにより、さまざまな値セットを使用して単体テストを実行できます。データドリブン単体テストは、データソース内の各行に対して繰り返し実行が行われる単体テストです。詳細については、「方法: データドリブン単体テストを作成する」を参照してください。
単体テストの Assert ステートメントを探し、編集します。使用できる Assert ステートメントの詳細については、「Assert クラスの使用」を参照してください。
(省略可能) Microsoft.VisualStudio.TestTools.UnitTesting 名前空間の [TestInitialize()] メソッドおよび [TestCleanup()] メソッドを使用して、単体テストのセットアップコードとクリーンアップコードを追加します。単体テストの作成時に、単体テストファイルに "追加のテスト属性" セクションが追加されます。このセクションを展開すると、コメントアウトされたメソッドが表示されます。これらのメソッドを使用して、初期化およびクリーンアップを含めることができます。

(省略可能) テストカテゴリを作成する

テストカテゴリを使用して自動テストを分類することにより、自動テストを管理できます。詳細については、「テストカテゴリの定義によるテストのグループ化」を参照してください。

注意

テストリストよりも、テストカテゴリを使用することをお勧めします。テストカテゴリを使用すると、テストリストを保守する必要なしに、割り当てられたカテゴリに基づいてテストのグループを実行できます。

新しいテストカテゴリを作成するには

[テストビュー] ウィンドウを開きます。
テストを選択します。
プロパティペインで、[テストカテゴリ] をクリックし、右端の列にある省略記号 (...) をクリックします。
[テストカテゴリ] ウィンドウの [新しいカテゴリの追加] ボックスに、新しいテストカテゴリの名前を入力します。
[追加] をクリックしてから [OK] をクリックします。

新しいテストカテゴリがテストに割り当てられ、プロパティを通じて他のテストに使用できるようになります。

(省略可能) テストリストを作成する

テストリストを使用すると、単体テストを論理グループにまとめることができます。単体テストをテストリストに追加することの主な利点は、複数の単体テストファイルからテストを実行できること、ビルドの一部としてテストを実行できること、およびテストリストを使用してチェックインポリシーを適用できることです。テストリストの詳細については、「テストリストの定義によるテストのグループ化」を参照してください。

注意

テストリストを作成するには

[テスト] メニューの [新しいテストリストの作成] をクリックします。
[新しいテストリストの作成] ダイアログボックスで、リストの名前を入力し、説明を追加します。次に、テストリストの配置場所を選択し、[OK] をクリックします。
[テストリストエディター] ウィンドウで [読み込まれたすべてのテスト] をクリックして、使用可能なすべてテストを表示します。
追加する各単体テストを、メインウィンドウからテストリストにドラッグします。

単体テストを実行する

単体テストの作成後は、いつでも単体テストを実行できます。ここでは単体テストを実行するための手順の 1 つを示しますが、ショートカットキーまたはコマンドラインを使用するなどの別の方法の詳細については、「方法: Microsoft Visual Studio から自動テストを実行する」を参照してください。

単体テストを実行するには

[テスト] メニューの [ウィンドウ] をポイントし、[テストビュー] をクリックします。
(省略可能) コードカバレッジ情報を収集する場合は、次の操作を行います。
1. [テスト] メニューの [テストの設定の編集] をポイントし、現在のテストの実行のテスト設定をクリックします。
2. [テストの設定] ダイアログボックスの [データと診断] をクリックします。
3. [ロール] で、テストの実行に使用するロールを選択します。
4. [コードカバレッジ] チェックボックスをオンにして、[構成] をクリックします。
5. コードカバレッジ情報を収集する各アイテムのチェックボックスをオンにします。
6. [コードカバレッジの詳細] ダイアログボックスで、[OK] をクリックします。
7. [テストの設定] ダイアログボックスで、[適用] をクリックし、[閉じる] をクリックします。
[テストビュー] ウィンドウで、1 つまたは複数のテストを選択します。複数のテストを選択するには、Ctrl キーを押しながら各テストをクリックします。
[テストビュー] ウィンドウのツールバーで、[選択範囲の実行] をクリックします。テストが実行され、[テスト結果] ウィンドウが開きます。
(省略可能) テストの詳細を確認するには、[テスト結果] ウィンドウでそのテストを右クリックしてから、[テスト結果の詳細の表示] をクリックします。
(省略可能) 単体テストファイル内でエラーのある領域を特定するには、詳細ウィンドウの [エラーのスタックトレース] で、該当するエラーのリンクをクリックします。

テスト結果の詳細については、「テスト結果の確認」を参照してください。

(省略可能) コードカバレッジデータを表示する

コードカバレッジ情報の収集を選択した場合は、[コードカバレッジ] ウィンドウを開いて、テスト対象のコード内のすべてのメソッドのうち、単体テストで網羅されていたメソッドの割合を確認できます。実行済みのテストのコードカバレッジを確認する方法、およびコードカバレッジ結果を管理する方法の詳細については、「コードカバレッジデータの概要」を参照してください。

単体テストのコードカバレッジを表示するには

[テスト結果] ウィンドウで、ツールバーの [コードカバレッジ結果の表示] をクリックします。ボタンを表示するためにウィンドウを拡大することが必要になる場合があります。
[コードカバレッジの結果] ウィンドウが開きます。

このウィンドウには、メソッドがテストされた範囲が示されます。