測試 C++ DLL

發行項
10/22/2023

本主題提供一種方式，說明如何使用適用於 C++ 的 Microsoft 單元測試架構，來為通用 Windows 平台 (UWP) app 的 C++ DLL 建立單元測試。 RooterLib DLL 會藉由實作計算某數值的平方根估計數函式，示範微積分中極限理論的模糊記憶。接著可將這個 DLL 包含在 UWP 應用程式中，以向使用者顯示可利用數學完成的有趣運算。

本主題示範如何使用單元測試做為開發工作的第一步。採用這種方式時，您會先撰寫測試方法，用來驗證要測試之系統中的特定行為，然後撰寫通過測試的程式碼。依照下列程序的順序進行變更，您就可以反轉策略，先撰寫要測試的程式碼，再撰寫單元測試。

本主題還會建立單一 Visual Studio 方案，以及用於單元測試和要測試之 DLL 的個別專案。您也可以直接在 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"。從結果清單中，選擇 [單元測試應用程式 (通用 Windows - 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);
};

註解說明 ifdef 區塊的對象，除了 dll 開發人員，也包括所有參考其專案中 DLL 的人。您可以使用 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 函式

將 RooterLib 加入 RooterLibTests 專案。
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);
    }
};
```
提示

建議您不要變更已通過的測試。相反地，請加入新的測試，更新程式碼，使測試通過，然後再加入另一個測試，依此類推。

當您的使用者變更他們的需求時，請停用已不再正確的測試。以相同的累加方式，撰寫新的測試，一次使一個測試生效。
在 [測試總管] 中，選擇 [全部執行]。
測試失敗。

提示

確認每個測試在您撰寫之後立即失敗。這樣有助於避免撰寫永遠不會失敗的測試這種易犯的錯誤。

透過測試強化程式碼，讓新的測試都成功。將下列內容加入至 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;
}

建置方案，然後在 [測試總管] 中選擇 [全部執行]。

這兩個測試都通過。

提示

開發程式碼時，一次加入一個測試。確定所有測試在每次反覆之後都通過。

對失敗的測試進行偵錯

將另一個測試加入至 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;

選擇 [全部執行] 測試重構的方法，並確定並未導入迴歸。

提示

一組穩定而良好的單元測試，可確認您並未在變更程式碼時引入錯誤。

將重構作業與其他變更分開。