C++ DLL をテストする

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

このトピックでは、C++ 用の Microsoft テストフレームワークを使用して、ユニバーサル Windows プラットフォーム (UWP) アプリ用の C++ DLL の単体テストを作成する 1 つの方法について説明します。 RooterLib DLL は、指定した数値の平方根の概数を計算する関数を実装することによって、微積分の限界理論の不明瞭なメモリを示します。この DLL を、ユーザーが数学で実行できる楽しい作業を提示する UWP アプリに組み込むことができます。

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

このトピックでは、テストする単体テストと DLL に 1 つの Visual Studio ソリューションと個別のプロジェクトも作成します。また、DLL プロジェクトに単体テストを直接含めることも、単体テストと DLL ごとに個別のソリューションを作成することもできます。使用できる構造体のヒントについては、「テストエクスプローラーを使用した既存の C++ アプリケーションの単体テスト」をご覧ください。

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

まず、新しいテストプロジェクトを作成します。 [ファイル] メニューで、 [新規]>[プロジェクト]をクリックします。 [新しいプロジェクトの作成] ダイアログで検索ボックスに "test" と入力し、[言語] を C++ に設定します。プロジェクトテンプレートの一覧の [単体テストアプリ (ユニバーサル Windows)] を選択します。

Create a new UWP test project

[新しいプロジェクト] ダイアログで [インストール済み]>[Visual C++] の順に展開し、[Windows ユニバーサル] を選びます。プロジェクトテンプレートの一覧の [単体テストアプリ (ユニバーサル Windows)] を選択します。
プロジェクトに RooterLibTests という名前を付けます。場所を指定します。ソリューションに RooterLib という名前を付けます。[ソリューションのディレクトリを作成] チェックボックスがオンになっていることを確認します。
新しいプロジェクトで、unittest1.cpp を開きます。

以下の点に注意してください。
- 各テストは TEST_METHOD(YourTestName){...} を使用して定義されます。
  
  従来の関数の署名を記述する必要はありません。署名は、マクロ TEST_METHOD によって作成されます。マクロは、void を返すインスタンス関数を生成します。また、テストメソッドに関する情報を返す静的関数も生成します。この情報により、テストエクスプローラーはメソッドを見つけます。
- テストメソッドは、 TEST_CLASS(YourClassName){...}を使用してクラスにグループ化されます。
  
  テストが実行されると、各テストクラスのインスタンスが作成されます。テストメソッドが呼び出される順序は決まっていません。各モジュール、クラス、またはメソッドの前後に呼び出される特殊なメソッドを定義することができます。詳細については、「Microsoft.VisualStudio.TestTools.CppUnitTestFramework の使用」をご覧ください。

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

幾らかのテストコードを挿入します。
```
TEST_METHOD(TestMethod1)
{
    Assert::AreEqual(1,1);
}
```
Assert クラスは、テストメソッドで結果を確認するために使用するいくつかの静的メソッドを提供することに注意してください。
[テスト] メニューの [実行] をポイントし、[すべて実行] をクリックします。

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

DLL プロジェクトをソリューションに追加する

ソリューションエクスプローラーでソリューション名を選択します。ショートカットメニューの [追加] をポイントし、[新しいプロジェクト] を選択します。 [新しいプロジェクトの追加] ダイアログで、[言語] を C++ に設定し、検索ボックスに "DLL" と入力します。結果の一覧から、[単体テストアプリ (ユニバーサルウィンドウ - C++/CX)] を選択します。

Create the RooterLib project

[新しいプロジェクトの追加] ダイアログボックスの [DLL (UWP アプリ)] を選択します。

RooterLib.h ファイルに次のコードを追加します。

// The following ifdef block is the standard way of creating macros which make exporting
// from a DLL simpler. All files within this DLL are compiled with the ROOTERLIB_EXPORTS
// symbol defined on the command line. This symbol should not be defined on any project
// that uses this DLL. This way any other project whose source files include this file see
// ROOTERLIB_API functions as being imported from a DLL, whereas this DLL sees symbols
// defined with this macro as being exported.
#ifdef ROOTERLIB_EXPORTS
#define ROOTERLIB_API  __declspec(dllexport)
#else
#define ROOTERLIB_API __declspec(dllimport)
#endif //ROOTERLIB_EXPORTS

class ROOTERLIB_API CRooterLib {
public:
    CRooterLib(void);
    double SquareRoot(double v);
};

コメントは、dll の開発者だけでなく、プロジェクトで DLL を参照するユーザーにも ifdef ブロックについて説明しています。 DLL のプロジェクトプロパティを使用して、コマンドラインに ROOTERLIB_EXPORTS シンボルを追加できます。

CRooterLib クラスは、コンストラクターと SqareRoot エスティメーターのメソッドを宣言します。

コマンドラインに ROOTERLIB_EXPORTS のシンボルを追加します。
1. ソリューションエクスプローラーで RooterLib プロジェクトを選択し、ショートカットメニューの [プロパティ] を選択します。
2. RooterLib の [プロパティページ] ダイアログボックスで [構成プロパティ]、[C++] の順に展開し、[プリプロセッサ] を選択します。
3. [プリプロセッサの定義] ボックスの一覧の [<編集...>] を選択し、[プリプロセッサの定義] ダイアログボックスに ROOTERLIB_EXPORTS を追加します。

宣言された関数の最小限の実装を追加します。 RooterLib.cpp を開き、次のコードを追加します。

// constructor
CRooterLib::CRooterLib()
{
}

// Find the square root of a number.
double CRooterLib::SquareRoot(double v)
{
    return 0.0;
}

dll 関数をテストコードに表示する

RooterLibTests プロジェクトに RooterLib を追加します。
1. ソリューションエクスプローラーで RooterLibTests プロジェクトを選択し、ショートカットメニューで [追加]>[参照] を選択します。
2. [参照の追加] ダイアログボックスで、[プロジェクト] を選択します。次に [RouterLib] 項目を選択します。
unittest1.cpp に RooterLib のヘッダーファイルをインクルードします。
1. unittest1.cpp を開きます。
2. #include "CppUnitTest.h" 行の下に次のコードを追加します。
```
#include "..\RooterLib\RooterLib.h"
```

インポートした関数を使用するテストを追加します。 unittest1.cpp に次のコードを追加します。

TEST_METHOD(BasicTest)
{
    CRooterLib rooter;
    Assert::AreEqual(
        // Expected value:
        0.0,
        // Actual value:
        rooter.SquareRoot(0.0),
        // Tolerance:
        0.01,
        // Message:
        L"Basic test failed",
        // Line number - used if there is no PDB file:
        LINE_INFO());
}

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

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

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

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

新しいテストを追加します。
```
TEST_METHOD(RangeTest)
{
    CRooterLib rooter;
    for (double v = 1e-6; v < 1e6; v = v * 3.2)
    {
        double expected = v;
        double actual = rooter.SquareRoot(v*v);
        double tolerance = expected/1000;
        Assert::AreEqual(expected, actual, tolerance);
    }
};
```
ヒント

合格したテスト内容を変更しないことをお勧めします。代わりに、新しいテストを追加し、テストが合格するようにコードを更新してから別のテストを追加する、という過程を繰り返します。

ユーザーが要件を変更したら、正しくなくなったテストを無効にします。新しいテストを作成し、一度に 1 つずつ、同じ増分方式で処理するようにします。
テストエクスプローラーで [すべて実行] をクリックします。
テストが失敗します。

ヒント

各テストが記述した後すぐに失敗することを確認します。これは、絶対に失敗しないテストを記述するという簡単なミスを避けることに役立ちます。

新しいテストが成功するように、テスト対象のコードを増やします。 RooterLib.cpp に次のコードを追加します。

#include <math.h>
...
// Find the square root of a number.
double CRooterLib::SquareRoot(double v)
{
    double result = v;
    double diff = v;
    while (diff > result/1000)
    {
        double oldResult = result;
        result = result - (result*result - v)/(2*result);
        diff = abs (oldResult - result);
    }
    return result;
}

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

両方のテストが合格します。

ヒント

一度に 1 つのテストを追加してコードを開発します。各反復処理の後にすべてのテストが合格することを確認します。

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

unittest1.cpp に別のテストを追加します。

// Verify that negative inputs throw an exception.
 TEST_METHOD(NegativeRangeTest)
 {
   wchar_t message[200];
   CRooterLib rooter;
   for (double v = -0.1; v > -3.0; v = v - 0.5)
   {
     try
     {
       // Should raise an exception:
       double result = rooter.SquareRoot(v);

       swprintf_s(message, L"No exception for input %g", v);
       Assert::Fail(message, LINE_INFO());
     }
     catch (std::out_of_range ex)
     {
       continue; // Correct exception.
     }
     catch (...)
     {
       swprintf_s(message, L"Incorrect exception for %g", v);
       Assert::Fail(message, LINE_INFO());
     }
   }
};

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

テストが失敗します。 テストエクスプローラーでテスト名を選択します。失敗したアサーションが強調表示されます。エラーメッセージは、テストエクスプローラーの [詳細] ウィンドウに表示されます。
テストが失敗した理由を表示するには、関数をステップ実行します。
1. SquareRoot 関数の先頭にブレークポイントを設定します。
2. 失敗したテストのショートカットメニューで [選択したテストのデバッグ]をクリックします。
  
  実行がブレークポイントで停止したら、コードをステップ実行します。
3. 例外をキャッチするには、RooterLib.cpp にコードを追加します。
```
#include <stdexcept>
...
double CRooterLib::SquareRoot(double v)
{
    //Validate the input parameter:
    if (v < 0.0)
    {
      throw std::out_of_range("Can't do square roots of negatives");
    }
...
```
4. テストエクスプローラーで [すべて実行] をクリックして、修正されたメソッドをテストし、回帰が生じていないことを確認します。
今回は、すべてのテストに合格します。

テストを変更せずにコードをリファクタリングする

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

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

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

ヒント

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

常に他の変更とは別にリファクタリングしてください。

C++ DLL をテストする

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

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

DLL プロジェクトをソリューションに追加する

dll 関数をテストコードに表示する

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

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

テストを変更せずにコードをリファクタリングする

フィードバック

フィードバック

その他のリソース

C++ DLL をテストする

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

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

DLL プロジェクトをソリューションに追加する

dll 関数をテスト コードに表示する

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

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

テストを変更せずにコードをリファクタリングする

フィードバック

フィードバック

その他のリソース

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

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

dll 関数をテストコードに表示する