Visual Studio で C++ 用の Microsoft 単体テスト フレームワークを使用する

  • [アーティクル]

C++ ワークロードによるデスクトップ開発には、既定では Microsoft 単体テスト フレームワークが含まれます。

単体テストを別のプロジェクトに記述するには

通常、独自のプロジェクト内のコードもテストするコードと同じソリューションでテストします。 新しいテスト プロジェクトをセットアップして構成するには、C/C++ 用の単体テストの作成に関するページを参照してください。

同じプロジェクトで単体テストを記述するには

DLL でエクスポートされない関数をテストするときなど、場合によっては、テストするプログラムと同じプロジェクトでテストを作成することが必要になります。 同じプロジェクトで単体テストを作成するには:

  1. 単体テストに必要なヘッダーおよびライブラリ ファイルが含まれるように、プロジェクトのプロパティを変更します。

    1. ソリューション エクスプローラーで、テスト対象プロジェクトのショートカット メニューの [プロパティ] をクリックします。 プロジェクトのプロパティ ウィンドウが開きます。

    2. [プロパティ ページ] ダイアログ ボックスで、[構成プロパティ]>[VC++ ディレクトリ] の順に選択します。

    3. 次の行の下向きの矢印をクリックし、[<編集>] を選択します。 次のパスを追加します。

      Directory プロパティ
      インクルード ディレクトリ $(VCInstallDir)Auxiliary\VS\UnitTest\include
      ライブラリ ディレクトリ $(VCInstallDir)Auxiliary\VS\UnitTest\lib

  2. C++ 単体テスト ファイルを追加します。

    1. ソリューション エクスプローラーでプロジェクト ノードを右クリックし、[追加]>[新しい項目] を選択します。

    2. [新しい項目の追加] ダイアログで [C++ ファイル (.cpp)] を選択し、適切な名前を指定して、[追加] を選択します。

テストをオブジェクトまたはライブラリ ファイルにリンクするには

テストする関数がテスト対象のコードでエクスポートされない場合は、出力された .obj ファイルまたは .lib ファイルをテスト プロジェクトの依存関係に追加できます。 単体テストに必要なヘッダーおよびライブラリまたはオブジェクト ファイルが含まれるように、テストプロジェクトのプロパティを変更します。

  1. ソリューション エクスプローラーで、テスト プロジェクトのショートカット メニューの [プロパティ] をクリックします。 プロジェクトのプロパティ ウィンドウが開きます。

  2. [構成プロパティ]>[リンカー]>[入力] ページを選択し、[追加の依存ファイル] を選択します。

    [編集] をクリックし、.obj ファイルまたは .lib ファイルの名前を追加します。 完全パス名は使用しないでください。

  3. [構成プロパティ]>[リンカー]>[全般] ページを選択し、[追加のライブラリ ディレクトリ] を選択します。

    [編集] をクリックし、.obj ファイルまたは .lib ファイルのディレクトリ パスを追加します。 一般的にパスは、テスト対象プロジェクトのビルド フォルダー内になります。

  4. [構成プロパティ]>[VC++ ディレクトリ] ページを選択し、[インクルード ディレクトリ]を選択します。

    [編集] をクリックし、テスト対象プロジェクトのヘッダー ディレクトリを追加します。

テストを作成

テスト クラスを含む .cpp ファイルには、"CppUnitTest.h" に加えて、using namespace Microsoft::VisualStudio::CppUnitTestFramework 用の using ステートメントが必要です。 テスト プロジェクトは既に構成されています。 これには、名前空間の定義と、開始するための TEST_METHOD を含んだ TEST_CLASS も記述されています。 名前空間の名前と、クラスとメソッドのマクロ内のかっこで囲んだ名前を変更することができます。

テスト モジュール、クラス、およびメソッドを初期化するため、およびテストの完了後にリソースをクリーンアップするための特殊なマクロが、テスト フレームワークにより定義されます。 これらのマクロは、クラスまたはメソッドに最初にアクセスする前に実行されるコードと、最後のテストを実行した後に実行されるコードを生成します。 詳細については、初期化とクリーンアップに関するページを参照してください。

Assert クラスに静的メソッドを使用して、テスト条件を定義します。 Logger クラスを使用して、[出力ウィンドウ] にメッセージを書き込みます。 テスト メソッドに属性を追加する

テストの実行

  1. [テスト] メニューで、[Windows]、[テスト エクスプローラー] の順に選択します。

  2. ウィンドウに一部のテストしか表示されない場合は、次の方法でテスト プロジェクトをビルドします。ソリューション エクスプローラーで、該当するノードを右クリックし、[ビルド] または [リビルド] を選択します。

  3. テスト エクスプローラーで、[すべて実行] を選択するか、または実行する特定のテストを選択します。 ブレークポイントを有効にした場合のデバッグ モードでのテストの実行など他のオプションについては、テストを右クリックします。

  4. [出力ウィンドウ] で、ドロップダウンから [テスト] を選択し、Logger クラスによって書き出されたメッセージを表示します。

    C++ Output Window showing test messages

グループ化を有効にするための特徴を定義する

テスト エクスプローラーでテストを分類してグループ化するための特徴をテスト メソッドに対して定義できます。 特徴を定義するには、 TEST_METHOD_ATTRIBUTE マクロを使用します。 たとえば、特徴 TEST_MY_TRAITを定義するには、次のように記述します。

#define TEST_MY_TRAIT(traitValue) TEST_METHOD_ATTRIBUTE(L"MyTrait", traitValue)

定義された特徴を単体テストで使用するには、次のように記述します。

BEGIN_TEST_METHOD_ATTRIBUTE(Method1)
    TEST_OWNER(L"OwnerName")
    TEST_PRIORITY(1)
    TEST_MY_TRAIT(L"thisTraitValue")
END_TEST_METHOD_ATTRIBUTE()

TEST_METHOD(Method1)
{
    Logger::WriteMessage("In Method1");
    Assert::AreEqual(0, 0);
}

C++ の特徴の属性マクロ

次の定義済みの特徴は、CppUnitTest.h にあります。 詳細については、「C++ API リファレンス用の Microsoft 単体テスト フレームワーク」を参照してください。

マクロ 説明
TEST_METHOD_ATTRIBUTE(attributeName, attributeValue) TEST_METHOD_ATTRIBUTE マクロを使用して、特徴を定義します。
TEST_OWNER(ownerAlias) 定義済みの所有者の特徴を使用して、テスト メソッドの所有者を指定します。
TEST_PRIORITY(priority) 定義済みの優先度の特徴を使用して、テスト メソッドに相対的な優先度を割り当てます。

関連するコンテンツ