ストアアプリの Visual C# コードの単体テスト

[アーティクル]
06/05/2015

このトピックでは、Visual Studio Express 2012 for Windows 8 および Microsoft 単体テストフレームワークを使用して、Windows ストアアプリの Visual C# クラスの単体テストを作成する方法の 1 つについて説明します。 Rooter クラスは、指定した数値の平方根の概数を計算する関数を実装することによって、微積分の限界理論の不明瞭なメモリを示します。 Maths アプリケーションではこの関数を使用して、数学で実行できる楽しいことをユーザーに示すことができます。

このトピックでは、開発の第一歩として単体テストを使用する方法を示します。この方法ではまず、テスト対象のシステムの特定の動作を検証するテストメソッドを作成し、テストに合格するコードを記述します。後述する手順の順序を変更することにより、この方法を逆にして、テストするコードを最初に記述し、単体テストを作成することができます。

このトピックでは、テストする単体テストと DLL に 1 つの Visual Studio ソリューションと個別のプロジェクトも作成します。また、DLL プロジェクトに単体テストを直接含めることも、単体テストと DLL ごとに個別のソリューションを作成することもできます。

注意

Visual Studio Ultimate、VS Premium、および VS Professional には、単体テストの追加機能が備わっています。

VS Ultimate、VS Premium、および VS Professional では、Microsoft テストエクスプローラーのアドオンアダプターを作成したサードパーティおよびオープンソースの単体テストフレームワークを使用できます。また、テストのコードカバレッジ情報を分析して表示することもできます。
VS Ultimate および VS Premium では、ビルドの後に毎回テストを実行できます。
VS Ultimate には Microsoft Fakes も含まれています。これは、システムおよびサードパーティの機能をテストコードに置き換えることにより、自分のコードにテストの重点を置くことができる、マネージコードの分離フレームワークです。

詳細については、MSDN ライブラリの「Verifying Code by Using Unit Tests」を参照してください。

このトピックの内容

ソリューションと単体テストプロジェクトを作成する

テストエクスプローラーでテストの実行を確認します。

Maths プロジェクトに Rooter クラスを追加します。

アプリケーションプロジェクトにテストプロジェクトを結合する

テストを繰り返し増やして、成功させる

失敗したテストをデバッグする

コードをリファクタリングする

ソリューションと単体テストプロジェクトを作成する

[ファイル] メニューの [新規作成] をポイントし、[新しいプロジェクト] をクリックします。
[新しいプロジェクト] ダイアログボックスで [インストール済み]、[Visual C#] の順に展開し、[Windows ストア] をクリックします。プロジェクトテンプレートの一覧の [新しいアプリケーション] をクリックします。
プロジェクトに「Maths」という名前を付け、[ソリューションのディレクトリを作成] チェックボックスがオンになっていることを確認します。
ソリューションエクスプローラーでソリューション名をクリックし、ショートカットメニューの [追加] をクリックし、[新しい項目] をクリックします。
[新しいプロジェクト] ダイアログボックスで [インストール済み]、[Visual C#] の順に展開し、[Windows ストア] をクリックします。プロジェクトテンプレートの一覧の [単体テストライブラリ (Windows ストアアプリ)] をクリックします。
Visual Studio エディターで UnitTest1.cs を開きます。
```
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.VisualStudio.TestPlatform.UnitTestFramework;
using Maths;

namespace RooterTests
{
    [TestClass]
    public class UnitTest1

        [TestMethod]
        public void TestMethod1()
        {

        }
```
次の点に注意してください。
1. 各テストは [TestMethod] を使用して定義されます。テストメソッドは void を返す必要があり、パラメーターをとることはできません。
2. テストメソッドは [TestClass] の属性で装飾されたクラスに配置する必要があります。
  
  テストの実行時に、各テストクラスのインスタンスが作成されます。テストメソッドは、不特定の順序で呼び出されます。
3. 各モジュール、クラス、またはメソッドの前後に呼び出される特殊なメソッドを定義できます。詳細については、MSDN ライブラリの「単体テストでの Microsoft.VisualStudio.TestTools.UnitTesting のメンバーの使用」を参照してください。

テストエクスプローラーでテストの実行を確認します。

UnitTest1.cs ファイルの TestMethod1 のテストコードを挿入します。
```
[TestMethod]
public void TestMethod1()
{
    Assert.AreEqual(0, 0);
}
```
Assert クラスは、テストメソッドの結果を検証するために使用できる複数の静的メソッドを提供します。
[テスト] メニューの [実行] をポイントし、[すべて実行] をクリックします。

テストプロジェクトがビルドされ、実行されます。テストエクスプローラーのウィンドウが表示され、テストが [成功したテスト] に表示されます。ウィンドウの下部の [概要] ウィンドウに、選択したテストに関する詳細情報が表示されます。

Maths プロジェクトに Rooter クラスを追加します。

ソリューションエクスプローラーでプロジェクト名の [Maths] を選択します。ショートカットメニューの [追加] をポイントし、[クラス] をクリックします。
クラスファイルに Rooter.cs という名前を付けます。
Rooter クラスの Rooter.cs ファイルに次のコードを追加します。
```
    public Rooter()
    {
    }

    // estimate the square root of a number
    public double SquareRoot(double x)
    {
        return 0.0;
    }
```
Rooter クラスは、コンストラクターと SqareRoot エスティメーターのメソッドを宣言します。
SqareRoot メソッドは、テスト設定の基本的な構造をテストするための必要最小限の実装にすぎません。

アプリケーションプロジェクトにテストプロジェクトを結合する

RooterTests プロジェクトに Maths アプリケーションへの参照を追加します。
1. ソリューションエクスプローラーで、RooterTests プロジェクトを選択し、ショートカットメニューの [参照の追加] をクリックします。
2. [参照の追加 - RooterTests] ダイアログボックスの [ソリューション] を展開し、[プロジェクト] をクリックします。次に [Maths] 項目を選択します。
使用するステートメントを UnitTest1.cs ファイルに追加します。
1. UnitTest1.cs を開きます。
2. using Microsoft.VisualStudio.TestPlatform.UnitTestFramework; 行の下に次のコードを追加します。
```
using Maths;
```

Rooter 関数を使用するテストを追加します。 UnitTest1.cpp に次のコードを追加します。

    [TestMethod]
    public void BasicTest()
    {
        Maths.Rooter rooter = new Rooter();
        double expected = 0.0;
        double actual = rooter.SquareRoot(expected * expected);
        double tolerance = .001;
        Assert.AreEqual(expected, actual, tolerance);
    }

ソリューションをビルドします。

新しいテストがテストエクスプローラーの [テストを実行しない] ノードに表示されます。
テストエクスプローラーで [すべて実行] をクリックします。

テストとコードプロジェクトを設定し、コードプロジェクトの関数を実行するテストを実行できることを確認しました。これで、実際のテストおよびコードの記述を開始できます。

テストを繰り返し増やして、成功させる

新しいテストを追加します。
```
    [TestMethod]
    public void RangeTest()
    {
        Rooter rooter = new Rooter();
        for (double v = 1e-6; v < 1e6; v = v * 3.2)
        {
            double expected = v;
            double actual = rooter.SquareRoot(v*v);
            double tolerance = ToleranceHelper(expected);
            Assert.AreEqual(expected, actual, tolerance);
        }
    }
```
ヒント

成功したテストは、変更しないことをお勧めします。代わりに、新しいテストを追加し、テストが成功するようにコードを更新して、さらに別のテストを追加していきます。

ユーザーが要件を変更したら、不適切になったテストを無効にします。新しいテストを作成し、同じように増やしながら、1 つずつ機能させます。
テストエクスプローラーで [すべて実行] をクリックします。
テストが失敗します。

ヒント

そのテストを作成した直後に、各テストが失敗することを検証します。これで、失敗することがないテストを作成するという簡単な誤りを回避できます。

新しいテストが成功するように、テスト対象のコードを増やします。 Rooter.cs の SqareRoot 関数を次のように変更します。

    public double SquareRoot(double x)
    {
        double estimate = x;
        double diff = x;
        while (diff > estimate / 1000)
        {
            double previousEstimate = estimate;
            estimate = estimate - (estimate * estimate - x) / (2 * estimate);
            diff = Math.Abs(previousEstimate - estimate);
        }
        return estimate;
    }

ソリューションをビルドし、テストエクスプローラーで [すべて実行] をクリックします。

3 つのテストはすべて成功しました。

ヒント

テストを 1 つずつ追加して、コードを開発します。テストを繰り返すたびに、すべてのテストが成功することを確認します。

失敗したテストをデバッグする

別のテストを UnitTest1.cs に追加します。

    // Verify that negative inputs throw an exception.
    [TestMethod]
    public void NegativeRangeTest()
    {
        string message;
        Rooter rooter = new Rooter();
        for (double v = -0.1; v > -3.0; v = v - 0.5)
        {
            try
            {
                // Should raise an exception:
                double actual = rooter.SquareRoot(v);

                message = String.Format("No exception for input {0}", v);
                Assert.Fail(message);
            }
            catch (ArgumentOutOfRangeException ex)
            {
                continue; // Correct exception.
            }
            catch (Exception e)
            {
                message = String.Format("Incorrect exception for {0}", v);
                Assert.Fail(message);
            }
        }
    }

テストエクスプローラーで [すべて実行] をクリックします。

テストが失敗します。テストエクスプローラーでテスト名を選択します。アサーションエラーが強調表示されます。エラーメッセージは、テストエクスプローラーの詳細ペインに表示されます。
テストが失敗した理由を確認するには、関数をステップ実行します。
1. SquareRoot 関数の先頭にブレークポイントを設定します。
2. 失敗したテストのショートカットメニューの [選択したテストのデバッグ] をクリックします。
  
  ブレークポイントで実行が停止したら、コードをステップ実行します。
3. 例外をキャッチするには、Rooter メソッドにコードを追加します。
```
    public double SquareRoot(double x)
    {
        if (x < 0.0)
        {
            throw new ArgumentOutOfRangeException();
    }
```
1. テストエクスプローラーで [すべて実行] をクリックして、修正されたメソッドをテストし、回帰が生じていないことを確認します。

これで、すべてのテストが合格しました。

すべてのテストの成功

コードをリファクタリングする

SquareRoot 関数の計算全体を簡略化します。

結果の実装を変更する

// old code
//result = result - (result*result - v)/(2*result);
// new code
result = (result + v/result) / 2.0;

[すべて実行] をクリックして、リファクタリングされたメソッドをテストし、回帰が生じていないことを確認します。

ヒント

安定した一連の適切な単体テストを実行することで、コードを変更したときにバグが生じていないことを確信できます。

テストコードをリファクタリングして、重複したコードを削除します。

RangeTest メソッドでは、Assert メソッドで使用される許容変数の分母をハードコーディングします。同じ許容値計算を使用するテストを追加する場合、ハードコーディングされた値を複数の場所で使用すると、エラーの原因となる可能性があります。

代わりに、Unit1Test クラスにプライベートメソッドを追加して、許容値を計算し、そのメソッドを呼び出します。

    private double ToleranceHelper(double expected)
    {
        return expected / 1000;
    }

    ...

    [TestMethod]
    public void RangeTest()
    {
        ...
        // old code
        // double tolerance = expected/1000;
        // new code
        double tolerance = ToleranceHelper(expected);
        Assert.AreEqual(expected, actual, tolerance);
    }
    ...

[すべて実行] をクリックして、リファクタリングされたメソッドをテストし、エラーが生じていないことを確認します。

注意

テストクラスにヘルパーメソッドを追加する場合に、メソッドに [TestMethod] 属性を追加しないでください。テストエクスプローラーでは、実行するメソッドが登録されません。

次の方法で共有

ストアアプリの Visual C# コードの単体テスト

このトピックの内容

ソリューションと単体テストプロジェクトを作成する

テストエクスプローラーでテストの実行を確認します。

Maths プロジェクトに Rooter クラスを追加します。

アプリケーションプロジェクトにテストプロジェクトを結合する

テストを繰り返し増やして、成功させる

失敗したテストをデバッグする

コードをリファクタリングする

その他のリソース

次の方法で共有

ストア アプリの Visual C# コードの単体テスト

このトピックの内容

ソリューションと単体テスト プロジェクトを作成する

テスト エクスプローラーでテストの実行を確認します。

Maths プロジェクトに Rooter クラスを追加します。

アプリケーション プロジェクトにテスト プロジェクトを結合する

テストを繰り返し増やして、成功させる

失敗したテストをデバッグする

コードをリファクタリングする

その他のリソース

ストアアプリの Visual C# コードの単体テスト

ソリューションと単体テストプロジェクトを作成する

テストエクスプローラーでテストの実行を確認します。

アプリケーションプロジェクトにテストプロジェクトを結合する