重溫《單元測試的藝術》，總結常用知識點

1. 前言#

關於單元測試的定義和好處可以借用Stephen Cleary的一段話來概括：

單元測試是現代開發的基礎。對專案進行單元測試的好處非常容易理解：單元測試降低了 Bug 數量，縮短了上市時間，防止過度耦合的設計。這些都是很好的優勢，但它還有更多與開發人員更直接相關的優點。在我編寫單元測試時，我會對程式碼更有信心。在已測試的程式碼中更易於新增功能或修復 Bug，因為在程式碼發生更改時，單元測試起著安全網的作用。

前幾個月重溫了單元測試的藝術。畢竟是14年的書內容有點舊，於是試著結合書中的內容和一些新的知識點寫進這篇文章，希望對自己及各位讀者有幫助。

TDD是另一個話題，這裡就不涉及了。

2. 選擇單元測試框架#

《單元測試的藝術》書中推薦NUnit，VS2019中新建單元測試專案只有MSTest V2、NUnit和xUnit三種。微軟自己的專案也不一定會使用MSTest，例如CoreFX就在用xUnit。

不過我更喜歡MSTest V2，因為從舊的MSTest升級過來幾乎沒有學習成本，也不用向上司解釋為什麼要換框架。MSTest已經是個開源專案，WindowsCommunityToolkit就在用MSTest。

3. 怎麼給單元測試命名#

萬事起頭難，最難的就是命名。OnResolveShouldAddSearchDirectoryListOnANeedToBasis

《單元測試的藝術》書中推薦了一組測試命名的規則。

• 專案建立一個名為[ProjectUnderTest].UnitTests的測試專案。

• 類對應被測試專案中的一個淚，建立一個名為[Classname]Tests的類。

• 工作單元對每個工作單元（一個方法，或者幾個方法組成的一個邏輯組，或者及各類），建立一個如下命名的測試方法：[UnitOfWorkName]_[ScenarioUnderTest]_[ExpectedBehavior]。

測試方法名稱的三個部分：

1. UnitOfWorkName，被測試的方法、一組方法或者一組類。
2. Scenario，測試進行的假設條件。
3. ExpectedBehavior，在測試場景指定的條件下，你對被測試方法行為的語氣。

從一個簡單的類開始解釋這個命名規則：

public class LogAnalyzer
{
    public bool IsValidLogFileName(string fileName)
    {
        if (fileName.EndsWith(".SLF") == false)
            return false;

        return true;
    }
}

為這個函式建立對應的單元測試，假設我們傳入錯誤的檔名，預期返回False，則測試方法命名為IsValidLogFileName_BadExtension_ReturnFalse。不需要在函式名中加入“Test”，這種命名本身已暗示自己是個測試方法。

namespace LogAn.UnitTests
{
    [TestClass()]
    public class LogAnalyzerTests
    {
        [TestMethod()]
        public void IsValidLogFileName_BadExtension_ReturnsFalse()
        {
            Assert.Fail();
        }
    }
}

4. 單元測試的組成#

單元測試通常包含三個行為：

1. 準備(Arrange)隊形，建立物件，進行必要的設定；
2. 操作(Act)物件；
3. 斷言(Assert)某件事情是預期的。

以IsValidLogFileName_BadExtension_ReturnFalse為例：

[TestMethod()]
public void IsValidLogFileName_BadExtension_ReturnsFalse()
{
    var analyzer = new LogAnalyzer();//Arrange
    var result = analyzer.IsValidLogFileName("filewithbadextension.foo");//Act
    Assert.IsFalse(result);//Assert
}

5. 一些MSTest常用的功能#

5.1 引數化測試#

要覆蓋多個測試用例可以使用DataRow實現引數化測試（MSTest V1沒有這個Attribute），並且可以為每一個測試用例命名，執行測試後可以看到測試用例的名稱：

[TestMethod()]
[DataRow("filewithbadextension.foo")]
[DataRow("somefile.exe")]
public void IsValidLogFileName_BadExtension_ReturnsFalse(string fileName)
{
    var analyzer = new LogAnalyzer();
    var result = analyzer.IsValidLogFileName(fileName);
    Assert.IsFalse(result);
}

[TestMethod()]
[DataRow("filewithbadextension.SLF", DisplayName = "A valid fileName")]
[DataRow("somefile.SLF",DisplayName = "An other valid fileName")]
public void IsValidLogFileName_GoodExtension_ReturnsTrue(string fileName)
{
    var analyzer = new LogAnalyzer();
    var result = analyzer.IsValidLogFileName(fileName);
    Assert.IsTrue(result);
}

5.2 捕獲預期的異常#

在以前很流行使用ExpectedExceptionAttribute檢查異常，程式碼如下：

[TestMethod()]
[ExpectedException(typeof(ArgumentNullException))]
public void IsValidLogFileName_EmptyFileName_Throws()
{
    var analyzer = new LogAnalyzer();
    analyzer.IsValidLogFileName(null);
}

這個方法有一些問題：

1. 沒有Assert語句。
2. 如果測試程式碼很多，使用者將搞不清楚到底哪行丟擲了異常。

更好的做法是使用Assert.ThrowsException(Action, String, Object[])：

[TestMethod()]
public void IsValidLogFileName_EmptyFileName_Throws()
{
    var analyzer = new LogAnalyzer();
    Assert.ThrowsException<ArgumentNullException>(()=>analyzer.IsValidLogFileName(null));
}

5.3 Initialize和Cleanup#

進行單元測試時，很重要的一點是保證之前測試的遺留資料或者例項得到銷燬，新測試的狀態是重建的，就好像之前沒有測試執行過一樣。
MSTest提供了一組Attribute用於初始化及釋放資源。

[AssemblyInitialize()]
public static void AssemblyInit(TestContext context)
{
    Debug.WriteLine("AssemblyInit " + context.TestName);
}

[ClassInitialize()]
public static void ClassInit(TestContext context)
{
    Debug.WriteLine("ClassInit " + context.TestName);
}

[TestInitialize()]
public void Initialize()
{
    Debug.WriteLine("TestMethodInit");
}

[TestCleanup()]
public void Cleanup()
{
    Debug.WriteLine("TestMethodCleanup");
}

[ClassCleanup()]
public static void ClassCleanup()
{
    Debug.WriteLine("ClassCleanup");
}

[AssemblyCleanup()]
public static void AssemblyCleanup()
{
    Debug.WriteLine("AssemblyCleanup");
}

輸出結果如下：

AssemblyInit IsValidLogFileName_EmptyFileName_Throws
ClassInit IsValidLogFileName_EmptyFileName_Throws
TestMethodInit
TestMethodCleanup
TestMethodInit
TestMethodCleanup
TestMethodInit
TestMethodCleanup
TestMethodInit
TestMethodCleanup
TestMethodInit
TestMethodCleanup
ClassCleanup
AssemblyCleanup

6. Stub（存根）和Mock（模擬物件）#

外部依賴項常常是不寫單元測試的藉口，如檔案系統、網路服務甚至系統時間，開發者往往說沒法控制而逃避寫單元測試。這種情況可以使用stub或mock破除依賴。

6.1 Stub(存根)#

一個存根(stub)是對系統中存在的一個依賴項(又或者協作者)的可控制的替代物。通過使用存根，你在測試程式碼無需直接處理這個依賴項。

如果前面的LogAnalyzer改成如下形式：

public bool IsValidLogFileName(string fileName)
{
    //讀取配置檔案，由配置檔案判斷是否支援這個副檔名
}

一旦測試依賴了檔案系統，你進行的就是整合測試，帶來了所有整合測試相關的問題————執行速度慢，需要配置等等。這種情況下可以使用一個stub代替檔案系統的依賴。

public class LogAnalyzer
{
    private IExtensionManager _manager;

    public LogAnalyzer(IExtensionManager manager) //定義測試程式碼可以呼叫的建構函式
    {
        _manager = manager;
    }

    public bool IsValidLogFileName(string fileName)
    {
        return _manager.IsValid(fileName);
    }
}


public interface IExtensionManager
{
    bool IsValid(string fileName);
}

internal class FakeExtensionManager : IExtensionManager //定義一個最簡單的stub
{
    public bool WillBeValid { get; set; } = false;

    public bool IsValid(string fileName)
    {
        return WillBeValid;
    }
}

[TestMethod()]
public void IsValidLogFileName_NameSupportedExtension_ReturnsTrue()
{
    var myFakeManager = new FakeExtensionManager { WillBeValid = true }; //準備一個返回true的stub
    var analyzer = new LogAnalyzer(myFakeManager); //傳入stub
    var result = analyzer.IsValidLogFileName("short.ext");
    Assert.IsTrue(result);
}

注入stub的方式由很多，《單元測試的藝術》中有詳細的介紹，這裡略過。

6.2 Mock（模擬物件）#

模擬物件(Mock)是系統中的偽物件，它可以驗證被測試物件是否按照預期的方式呼叫了這個偽物件，因此導致單元測試通過或者失敗。通常每個測試最多有一個模擬物件。

這次LogAnalyer需要和一個外部的Web服務互動，每次LogAnalyer遇到一個過短的檔名，這個Web服務就會收到一個錯誤訊息。遺憾的是，你要測試的這個Wen服務還沒有完全實現，就算實現了，使用這個Web服務會導致測試時間過長。因此這裡需要一個Mock，這個Mock只包括需要呼叫的Web服務方法，然後LogAnalyzer呼叫這個介面寫錯誤日誌。

public interface IWebService
{
    void LogError(string message);
}

public class LogAnalyzer
{
    private IWebService _service;

    public LogAnalyzer(IWebService service) //定義測試程式碼可以呼叫的建構函式
    {
        _service= service;
    }

    public void Analyze(string fileName)
    {
        if (fileName.Length < 9)
            _service.LogError("Filename too short:" + fileName); //在產品程式碼中寫錯誤日誌
    }
}

使用mock物件測試LogAnalyzer，注意是對mock物件進行斷言，而非LogAnalyer類，因為測試的是LogAnalyer和Web服務之間的互動:

public class FakeWebService : IWebService //定義一個最簡單的mock
{
    public string LastError { get; private set; }

    public void LogError(string message)
    {
        LastError = message;
    }
}


[TestMethod()]
public void Analyze_TooShrtFileName_CallsWebService()
{
    var mockService = new FakeWebService();
    var analyzer = new LogAnalyzer(mockService);
    var tooShortFileName = "abc.ext";
    analyzer.Analyze(tooShortFileName);
    StringAssert.Contains(mockService.LastError, tooShortFileName); //對模擬物件進行斷言
}

6.3 Stub（存根）和Mock（模擬物件）和Fake(偽物件)#

Fake(偽物件)是通用的術語，可以描述一個stub或mock，，因為stub和mock看想去都很像真實物件。一個偽物件究竟是stub還是mock取決於它在當前測試中的使用方式：如果這個偽物件用來檢驗一個互動(對其進行斷言)，它就是mock，否則就是stub。

如果一個測試只測試一件事情，測試中應該最多隻有一個mock，所有其它的偽物件都是stub。如果一個測試有多個mock，這說明你在測試多件事情，會導致測試過於複雜或脆弱。

前面定義的Stub和Mock都使用了Fake-字首，因為在類中避免使用"mock"和"stub"，那麼這個類的物件就可以具有兩種行為方式，以後再不同的測試中重用。

7. 隔離框架#

手工編寫偽物件有很多問題，最明顯的問題就是產生大量的編碼和維護工作。使用隔離框架是一個更優雅的方案，它可以在執行時動建立和配置偽物件。

.NET的隔離框架有很多，《單元測試的藝術》書中以NSubstitute(簡稱NSub)為例介紹了隔離框架的基本用法(看起來最近nuget下載量比moq更多)。

這一節介紹一些NSub的基本操作，更多的內容詳見官網。

7.1 建立偽物件#

假設我們有一個介面：

public interface ICalculator
{
    int Add(int a, int b);
    string Mode { get; set; }
    event Action PoweringUp;
}

NSub用下面的程式碼建立一個偽物件：

_calculator = Substitute.For<ICalculator>();

NSub能自動生成偽物件，這個偽造的ICalculator物件例項時動態生成的，實現了ICalculator介面，但沒有實現它的任何方法。從模擬物件建立到測試方式結束，對這個模擬物件的所有呼叫都會自動記錄，儲存供後來使用。

7.2 模擬值#

使用Returns模擬函式值並斷言：

_calculator.Add(1, 2).Returns(3);
Assert.AreEqual(_calculator.Add(1, 2), 3);

模擬屬性值並斷言：

_calculator.Mode.Returns("DEC");
Assert.AreEqual(_calculator.Mode, "DEC");

_calculator.Mode = "HEX";
Assert.AreEqual(_calculator.Mode, "HEX");

也可以模擬一組值並逐個斷言：

_calculator.Mode.Returns("HEX", "DEC", "BIN");
Assert.AreEqual(_calculator.Mode, "HEX");
Assert.AreEqual(_calculator.Mode, "DEC");
Assert.AreEqual(_calculator.Mode, "BIN");

7.3 測試互動#

使用Received斷言接收到呼叫，以及DidNotReceive斷言沒接收到呼叫：

_calculator.Add(1, 2);
_calculator.Received().Add(1, 2);
_calculator.DidNotReceive().Add(5, 7);

7.4 引數匹配器#

Arg類成為引數匹配器，用於控制引數處理：

_calculator.Add(10, -5);
_calculator.Received().Add(10, Arg.Any<int>()); //斷言第二個引數時int型別
_calculator.Received().Add(10, Arg.Is<int>(x => x < 0)); //斷言第二個引數小於5

使用引數匹配器並傳入一個function到Returns可以更好地控制返回值：

_calculator.Add(Arg.Any<int>(), Arg.Any<int>())
           .Returns(x => (int)x[0] + (int)x[1]);
Assert.AreEqual(_calculator.Add(5, 10), 15);

7.5 使用When模擬異常#

_calculator.When(x => x.Add(Arg.Is<int>(i => i < 0), Arg.Any<int>()))
    .Do(context => throw new ArgumentException("invalid"));

Assert.ThrowsException<ArgumentException>(() => _calculator.Add(-5, 0));

這裡When後面的Lambda指示當第一個引數小於0，然後用Do丟擲一個異常。

7.6 測試事件#

var eventWasRaised = false;
_calculator.PoweringUp += () => eventWasRaised = true;

_calculator.PoweringUp += Raise.Event<Action>();
Assert.IsTrue(eventWasRaised);

NSub使用Raise觸發事件。

8. 其它#

8.1 區分單元測試和整合測試#

任何測試，如果它執行速度不快，結果不穩定，或者要用到被測試單元的一個或多個真實依賴物，我就認為它是整合測試。

整合測試是對一個工作單元進行的測試，這個測試對被測試的工作單元沒有完全的控制，並使用該單元的一個或多個真實依賴物，例如事件、網路、資料庫、執行緒或隨機數產生器等。

整合測試和單元測試的專案應該分開。一般來說，複雜的測試都是整合測試，由於整合測試很慢，可以考慮使用建立一個只包含單元測試的解決方案，這樣才可以頻繁頻繁地執行測試，實行TDD。

8.2 如何測試私有方法#

私有方法通常比較難測試，不過你可以這麼想：私有方法不會無緣無故地存在，最終在某個地方有公共方法會呼叫這個私有方法。看到一個私有方法的時候，你應該找到使用這個方法的公共用例並對這個公共用例進行測試。

如果一個私有方法真的值得進行測試，那麼它也許應該設為公共的，靜態的。有幾種方式處理私有方法：

1. 使方法成為公共方法。如果它真的那麼重要，那把它設為公共的並不一定是壞事。使它變成正式的公共契約可以防止它被任意破壞。

2. 把方法提取到新類。

3. 使方法成為靜態方法。

4. 使方法成為內部方法並使用InternalsVisibleTo。

8.3 用程式碼審查確保程式碼覆蓋率#

程式碼覆蓋率100%說明什麼呢？如果沒有做程式碼審查，這個覆蓋率不能說明什麼。也許這些測試連斷言都沒有，只是為了達到更高的覆蓋率所寫的程式碼。如果你做了程式碼審查和測試審查，確保測試優秀而且覆蓋了所有程式碼，那麼你就擁有了一個安全網，可以避免愚蠢的錯誤，同時團隊也獲得了分享的知識，從持續的學習中獲益。

9. 結語#

雖然《單元測試的藝術》是一本有點舊的書，但我是不是還是會拿出來重溫並推薦給別人，畢竟.NET專門講單元測試的書不多。如果有其它單元測試方面的優秀書籍請推薦給我。

另外，微軟的單元測試基礎也是個很不錯的文件。

10. 參考#

單元測試 - Visual Studio Microsoft Docs

Microsoft.VisualStudio.TestTools.UnitTesting Namespace Microsoft Docs

NSubstitute A friendly substitute for .NET mocking libraries