幾年前我寫(xiě)過(guò)這個(gè)，但不太詳細(xì)。這是同一想法的更精致的版本。

簡(jiǎn)介

單元測(cè)試對(duì)開(kāi)發(fā)人員來(lái)說(shuō)既是福也是禍。它們?cè)试S快速測(cè)試功能、可讀的使用示例、快速實(shí)驗(yàn)所涉及組件的場(chǎng)景。但它們也可能變得混亂，需要在每次代碼更改時(shí)進(jìn)行維護(hù)和更新，并且如果懶惰地完成，則無(wú)法隱藏錯(cuò)誤而不是揭示錯(cuò)誤。

我認(rèn)為單元測(cè)試如此困難的原因是它與測(cè)試相關(guān)，而不是代碼編寫(xiě)，而且單元測(cè)試的編寫(xiě)方式與我們編寫(xiě)的大多數(shù)其他代碼相反。

在這篇文章中，我將為您提供一種編寫(xiě)單元測(cè)試的簡(jiǎn)單模式，該模式將增強(qiáng)所有好處，同時(shí)消除與正常代碼的大部分認(rèn)知失調(diào)。單元測(cè)試將保持可讀性和靈活性，同時(shí)減少重復(fù)代碼并且不添加額外的依賴項(xiàng)。

如何進(jìn)行單元測(cè)試

但首先，讓我們定義一個(gè)好的單元測(cè)試套件。

要正確測(cè)試一個(gè)類，必須以某種方式編寫(xiě)它。在這篇文章中，我們將介紹使用構(gòu)造函數(shù)注入進(jìn)行依賴項(xiàng)的類，這是我推薦的進(jìn)行依賴項(xiàng)注入的方法。

然后，為了測(cè)試它，我們需要：

• 涵蓋積極的場(chǎng)景 - 當(dāng)類執(zhí)行其應(yīng)該執(zhí)行的操作時(shí)，使用設(shè)置和輸入?yún)?shù)的各種組合來(lái)覆蓋整個(gè)功能
• 涵蓋負(fù)面場(chǎng)景 - 當(dāng)設(shè)置或輸入?yún)?shù)錯(cuò)誤時(shí)，類以正確的方式失敗
• 模擬所有外部依賴
• 將所有測(cè)試設(shè)置、操作和斷言保留在同一個(gè)測(cè)試中（通常稱為 Arrange-Act-Assert 結(jié)構(gòu)）

但這說(shuō)起來(lái)容易做起來(lái)難，因?yàn)樗€意味著：

• 為每個(gè)測(cè)試設(shè)置相同的依賴項(xiàng)，從而復(fù)制和粘貼大量代碼
• 設(shè)置非常相似的場(chǎng)景，兩次測(cè)試之間僅進(jìn)行一次更改，再次重復(fù)大量代碼
• 什么都不概括和封裝，這是開(kāi)發(fā)人員通常在所有代碼中所做的事情
• 為很少的正例寫(xiě)了很多負(fù)例，感覺(jué)就像測(cè)試代碼比功能代碼多
• 必須為測(cè)試類的每次更改更新所有這些測(cè)試

誰(shuí)喜歡這個(gè)？

解決方案

解決方案是使用構(gòu)建器軟件模式在 Arrange-Act-Assert 結(jié)構(gòu)中創(chuàng)建流暢、靈活且可讀的測(cè)試，同時(shí)將設(shè)置代碼封裝在一個(gè)類中，以補(bǔ)充特定服務(wù)的單元測(cè)試套件。我稱之為 MockManager 模式。

讓我們從一個(gè)簡(jiǎn)單的例子開(kāi)始：

// the tested class
public class Calculator
{
    private readonly ITokenParser tokenParser;
    private readonly IMathOperationFactory operationFactory;
    private readonly ICache cache;
    private readonly ILogger logger;

    public Calculator(
        ITokenParser tokenParser,
        IMathOperationFactory operationFactory,
        ICache cache,
        ILogger logger)
    {
        this.tokenParser = tokenParser;
        this.operationFactory = operationFactory;
        this.cache = cache;
        this.logger = logger;
    }

    public int Calculate(string input)
    {
        var result = cache.Get(input);
        if (result.HasValue)
        {
            logger.LogInformation("from cache");
            return result.Value;
        }
        var tokens = tokenParser.Parse(input);
        IOperation operation = null;
        foreach(var token in tokens)
        {
            if (operation is null)
            {
                operation = operationFactory.GetOperation(token.OperationType);
                continue;
            }
            if (result is null)
            {
                result = token.Value;
                continue;
            }
            else
            {
                if (result is null)
                {
                    throw new InvalidOperationException("Could not calculate result");
                }
                result = operation.Execute(result.Value, token.Value);
                operation = null;
            }
        }
        cache.Set(input, result.Value);
        logger.LogInformation("from operation");
        return result.Value;
    }
}

這是一個(gè)計(jì)算器，按照傳統(tǒng)。它接收一個(gè)字符串并返回一個(gè)整數(shù)值。它還緩存特定輸入的結(jié)果，并記錄一些內(nèi)容。實(shí)際操作由 IMathOperationFactory 抽象，輸入字符串由 ITokenParser 轉(zhuǎn)換為標(biāo)記。別擔(dān)心，這不是一個(gè)真正的課程，只是一個(gè)例子。讓我們看一個(gè)“傳統(tǒng)”測(cè)試：

[TestMethod]
public void Calculate_AdditionWorks()
{
    // Arrange
    var tokenParserMock = new Mock<ITokenParser>();
    tokenParserMock
        .Setup(m => m.Parse(It.IsAny<string>()))
        .Returns(
            new List<CalculatorToken> {
                CalculatorToken.Addition, CalculatorToken.From(1), CalculatorToken.From(1)
            }
        );

    var mathOperationFactoryMock = new Mock<IMathOperationFactory>();

    var operationMock = new Mock<IOperation>();
    operationMock
        .Setup(m => m.Execute(1, 1))
        .Returns(2);

    mathOperationFactoryMock
        .Setup(m => m.GetOperation(OperationType.Add))
        .Returns(operationMock.Object);

    var cacheMock = new Mock<ICache>();
    var loggerMock = new Mock<ILogger>();

    var service = new Calculator(
        tokenParserMock.Object,
        mathOperationFactoryMock.Object,
        cacheMock.Object,
        loggerMock.Object);

    // Act
    service.Calculate("");

    //Assert
    mathOperationFactoryMock
        .Verify(m => m.GetOperation(OperationType.Add), Times.Once);
    operationMock
        .Verify(m => m.Execute(1, 1), Times.Once);
}

讓我們稍微打開(kāi)一下它。例如，即使我們實(shí)際上并不關(guān)心記錄器或緩存，我們也必須為每個(gè)構(gòu)造函數(shù)依賴項(xiàng)聲明一個(gè)模擬。在操作工廠的情況下，我們還必須設(shè)置一個(gè)返回另一個(gè)模擬的模擬方法。

在這個(gè)特定的測(cè)試中，我們主要編寫(xiě)了設(shè)置、一行 Act 和兩行 Assert。此外，如果我們想測(cè)試緩存在類中的工作原理，我們必須復(fù)制粘貼整個(gè)內(nèi)容，然后更改我們?cè)O(shè)置緩存模擬的方式。

還有一些負(fù)面測(cè)試需要考慮。我見(jiàn)過(guò)許多負(fù)面測(cè)試做了類似的事情：“設(shè)置應(yīng)該失敗的內(nèi)容。測(cè)試它失敗”，這引入了很多問(wèn)題，主要是因?yàn)樗赡軙?huì)因完全不同的原因而失敗，并且大多數(shù)時(shí)候這些測(cè)試遵循類的內(nèi)部實(shí)現(xiàn)而不是其要求。正確的陰性測(cè)試實(shí)際上是完全陽(yáng)性的測(cè)試，只有一個(gè)錯(cuò)誤的條件。為了簡(jiǎn)單起見(jiàn)，這里的情況并非如此。

所以，言歸正傳，這里是相同的測(cè)試，但使用了 MockManager：

[TestMethod]
public void Calculate_AdditionWorks_MockManager()
{
    // Arrange
    var mockManager = new CalculatorMockManager()
        .WithParsedTokens(new List<CalculatorToken> {
            CalculatorToken.Addition, CalculatorToken.From(1), CalculatorToken.From(1)
        })
        .WithOperation(OperationType.Add, 1, 1, 2);

    var service = mockManager.GetService();

    // Act
    service.Calculate("");

    //Assert
    mockManager
        .VerifyOperationExecute(OperationType.Add, 1, 1, Times.Once);
}

拆包，沒(méi)有提到緩存或記錄器，因?yàn)槲覀儾恍枰谀抢镞M(jìn)行任何設(shè)置。一切都已打包且可讀。復(fù)制粘貼此內(nèi)容并更改一些參數(shù)或某些行不再難看。 Arrange 中執(zhí)行了三種方法，一種在 Act 中執(zhí)行，一種在 Assert 中執(zhí)行。僅抽象了實(shí)質(zhì)的模擬細(xì)節(jié)：這里沒(méi)有提及 Moq 框架。事實(shí)上，無(wú)論決定使用哪種模擬框架，此測(cè)試看起來(lái)都是一樣的。

讓我們看一下 MockManager 類?，F(xiàn)在這會(huì)顯得很復(fù)雜，但請(qǐng)記住，我們只編寫(xiě)一次并多次使用它。該類的整體復(fù)雜性是為了使單元測(cè)試易于人類閱讀，易于理解、更新和維護(hù)。

public class CalculatorMockManager
{
    private readonly Dictionary<OperationType,Mock<IOperation>> operationMocks = new();

    public Mock<ITokenParser> TokenParserMock { get; } = new();
    public Mock<IMathOperationFactory> MathOperationFactoryMock { get; } = new();
    public Mock<ICache> CacheMock { get; } = new();
    public Mock<ILogger> LoggerMock { get; } = new();

    public CalculatorMockManager WithParsedTokens(List<CalculatorToken> tokens)
    {
        TokenParserMock
            .Setup(m => m.Parse(It.IsAny<string>()))
            .Returns(
                new List<CalculatorToken> {
                    CalculatorToken.Addition, CalculatorToken.From(1), CalculatorToken.From(1)
                }
            );
        return this;
    }

    public CalculatorMockManager WithOperation(OperationType operationType, int v1, int v2, int result)
    {
        var operationMock = new Mock<IOperation>();
        operationMock
            .Setup(m => m.Execute(v1, v2))
            .Returns(result);

        MathOperationFactoryMock
            .Setup(m => m.GetOperation(operationType))
            .Returns(operationMock.Object);

        operationMocks[operationType] = operationMock;

        return this;
    }

    public Calculator GetService()
    {
        return new Calculator(
                TokenParserMock.Object,
                MathOperationFactoryMock.Object,
                CacheMock.Object,
                LoggerMock.Object
            );
    }

    public CalculatorMockManager VerifyOperationExecute(OperationType operationType, int v1, int v2, Func<Times> times)
    {
        MathOperationFactoryMock
            .Verify(m => m.GetOperation(operationType), Times.AtLeastOnce);
        var operationMock = operationMocks[operationType];
        operationMock
            .Verify(m => m.Execute(v1, v2), times);
        return this;
    }
}

測(cè)試類所需的所有模擬都被聲明為公共屬性，允許對(duì)單元測(cè)試進(jìn)行任何自定義。有一個(gè) GetService 方法，它將始終返回被測(cè)試類的實(shí)例，并且所有依賴項(xiàng)都完全模擬。然后還有 With* 方法，它們自動(dòng)設(shè)置各種場(chǎng)景并始終返回模擬管理器，以便可以鏈接它們。您還可以使用特定的斷言方法，盡管在大多數(shù)情況下您會(huì)將一些輸出與預(yù)期值進(jìn)行比較，因此這些只是為了抽象出 Moq 框架的Verify 方法。

結(jié)論

此模式現(xiàn)在使測(cè)試編寫(xiě)與代碼編寫(xiě)保持一致：

• 抽象出任何上下文中你不關(guān)心的事物
• 一次編寫(xiě)，多次使用
• 人類可讀的自記錄代碼
• 低圈復(fù)雜度的小方法
• 直觀的代碼編寫(xiě)

現(xiàn)在編寫(xiě)單元測(cè)試既簡(jiǎn)單又一致：

1. 實(shí)例化您要測(cè)試的類的模擬管理器（或根據(jù)上述步驟編寫(xiě)一個(gè)）
2. 為測(cè)試編寫(xiě)特定場(chǎng)景（自動(dòng)完成現(xiàn)有已涵蓋的場(chǎng)景步驟）
3. 使用測(cè)試參數(shù)執(zhí)行你想要測(cè)試的方法
4. 檢查一切是否符合預(yù)期

抽象并不止于模擬框架。相同的模式可以應(yīng)用于每種編程語(yǔ)言！對(duì)于 TypeScript 或 JavaScript 或其他東西來(lái)說(shuō)，模擬管理器構(gòu)造將非常不同，但單元測(cè)試看起來(lái)幾乎是一樣的。

希望這有幫助！

以上是單元測(cè)試中的 MockManager - 用于模擬的構(gòu)建器模式的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！