Moq C#（開發者的工作原理）

建立一個新的 C# 項目

請依照以下步驟建立新項目：

1. 開啟Visual Studio ，前往"檔案">"新建">"專案..."。
2. 選擇專案模板，配置設置，然後按一下"建立"。

假設你正在開發一款 ATM（自動櫃員機）軟體，並且需要測試其身份驗證和提款功能。 ATM 依賴兩個介面：IHostBank 和 IHSMModule。 我們想要測試 ATMCashWithdrawal 類，該類代表 ATM 的提款功能。

建立兩個接口，IHostBank 和 IHSMModule，它們代表 ATM 系統的依賴關係。 定義相關方法，例如 AuthenticateAmount 和 ValidatePIN。

// IHostBank.cs
public interface IHostBank
{
    bool AuthenticateAmount(string accountNumber, int amount);
}

// IHSMModule.cs
public interface IHSMModule
{
    bool ValidatePIN(string cardNumber, int pin);
}

// IHostBank.cs
public interface IHostBank
{
    bool AuthenticateAmount(string accountNumber, int amount);
}

// IHSMModule.cs
public interface IHSMModule
{
    bool ValidatePIN(string cardNumber, int pin);
}

建立 ATMCashWithdrawal 類，該類使用上述依賴項來執行 ATM 操作。 在這個類別中，你將實作一個類似 WithdrawAmount 的特定方法。

// ATMCashWithdrawal.cs
public class ATMCashWithdrawal
{
    private readonly IHSMModule hsmModule;
    private readonly IHostBank hostBank;

    public ATMCashWithdrawal(IHSMModule hsmModule, IHostBank hostBank)
    {
        this.hsmModule = hsmModule;
        this.hostBank = hostBank;
    }

    // Withdraw amount after validating PIN and balance
    public bool WithdrawAmount(string cardNumber, int pin, int amount)
    {
        if (!hsmModule.ValidatePIN(cardNumber, pin))
        {
            return false;
        }

        if (!hostBank.AuthenticateAmount(cardNumber, amount))
        {
            return false;
        }

        // Withdraw the specified amount and perform other operations
        return true;
    }
}

// ATMCashWithdrawal.cs
public class ATMCashWithdrawal
{
    private readonly IHSMModule hsmModule;
    private readonly IHostBank hostBank;

    public ATMCashWithdrawal(IHSMModule hsmModule, IHostBank hostBank)
    {
        this.hsmModule = hsmModule;
        this.hostBank = hostBank;
    }

    // Withdraw amount after validating PIN and balance
    public bool WithdrawAmount(string cardNumber, int pin, int amount)
    {
        if (!hsmModule.ValidatePIN(cardNumber, pin))
        {
            return false;
        }

        if (!hostBank.AuthenticateAmount(cardNumber, amount))
        {
            return false;
        }

        // Withdraw the specified amount and perform other operations
        return true;
    }
}

建立單元測試項目

現在，讓我們使用 MOQ 模擬依賴項，為 ATMCashWithdrawal 類別建立單元測試。

在您的解決方案中建立一個新的單元測試項目，並將其命名為 ATMSystem.Tests。

若要將 NUnit 測試專案新增至 Visual Studio 解決方案中，請依照下列步驟操作：

1.右鍵單擊解決方案：在解決方案資源管理器(通常在右側)中，以滑鼠右鍵按一下解決方案名稱。 2.新增 > 新項目：從上下文選單中，選擇"新增"，然後選擇"新建項目..."。 3.建立新項目：在"新增項目"對話方塊中，您可以搜尋"NUnit"以尋找可用的 NUnit 範本。 選擇如下所示的 NUnit 測試項目。

4.配置項目：根據需要配置項目設置，包括項目名稱和位置。 5.按一下"確定"：按一下"建立"或"確定"按鈕，將 NUnit 測試項目新增至您的解決方案。

現在，您的解決方案中有一個獨立的 NUnit 測試項目，您可以在其中編寫和管理單元測試。 您也可以新增對要測試的專案的引用，並開始在該專案中編寫 NUnit 測試案例。

要開始在測試專案中使用 MOQ，您需要將 MOQ NuGet套件新增至您的解決方案。 您可以使用 Visual Studio 中的NuGet套件管理器來完成此操作，也可以在套件管理器控制台中執行下列命令：

Install-Package Moq

此命令將安裝軟體包並將所有必要的依賴項新增至專案。

使用 NUnit 和 MOQ 編寫單元測試，模擬 ATMCashWithdrawal 類別的依賴項(IHostBank 和 IHSMModule)。

using Moq;
using NUnit.Framework;

namespace ATMSystem.Tests
{
    public class ATMTests
    {
        private ATMCashWithdrawal atmCash;

        [SetUp]
        public void Setup()
        {
            // Arrange - Setup mock objects
            var hsmModuleMock = new Mock<IHSMModule>();
            hsmModuleMock.Setup(h => h.ValidatePIN("123456781234", 1234)).Returns(true);

            var hostBankMock = new Mock<IHostBank>();
            hostBankMock.Setup(h => h.AuthenticateAmount("123456781234", 500)).Returns(true);

            atmCash = new ATMCashWithdrawal(hsmModuleMock.Object, hostBankMock.Object);
        }

        [Test]
        public void WithdrawAmount_ValidTransaction_ReturnsTrue()
        {
            // Act - Execute the method under test
            bool result = atmCash.WithdrawAmount("123456781234", 1234, 500);

            // Assert - Verify the result
            Assert.IsTrue(result);
        }

        // More test cases for different scenarios (e.g., invalid PIN, insufficient funds)
    }
}

using Moq;
using NUnit.Framework;

namespace ATMSystem.Tests
{
    public class ATMTests
    {
        private ATMCashWithdrawal atmCash;

        [SetUp]
        public void Setup()
        {
            // Arrange - Setup mock objects
            var hsmModuleMock = new Mock<IHSMModule>();
            hsmModuleMock.Setup(h => h.ValidatePIN("123456781234", 1234)).Returns(true);

            var hostBankMock = new Mock<IHostBank>();
            hostBankMock.Setup(h => h.AuthenticateAmount("123456781234", 500)).Returns(true);

            atmCash = new ATMCashWithdrawal(hsmModuleMock.Object, hostBankMock.Object);
        }

        [Test]
        public void WithdrawAmount_ValidTransaction_ReturnsTrue()
        {
            // Act - Execute the method under test
            bool result = atmCash.WithdrawAmount("123456781234", 1234, 500);

            // Assert - Verify the result
            Assert.IsTrue(result);
        }

        // More test cases for different scenarios (e.g., invalid PIN, insufficient funds)
    }
}

在本測試程式碼中，我們使用 MOQ 為 IHSMModule 和 IHostBank 建立模擬對象，並指定它們在測試期間被呼叫時的行為。

在上面的程式碼範例中，我們示範了在 C# 中使用 MOQ 模擬物件的概念。 我們為 IHSMModule 和 IHostBank 介面建立模擬對象，模擬它們在單元測試期間的行為。 這樣，我們就可以透過控制這些模擬物件的反應來隔離並徹底測試 ATMCashWithdrawal 類別。 透過模擬，我們可以確保我們的程式碼與這些依賴項正確交互，從而使我們的測試更有針對性、可預測性，並能有效地識別正在檢查的特定程式碼單元中的問題。 這種做法提高了整體可靠性、可維護性和測試程式碼品質。

步驟三：運行測試

1. 建立您的解決方案，確保所有內容都是最新的。
2. 在 Visual Studio 中開啟測試資源管理器(測試 > 測試資源管理器)。
3. 在測試資源管理器中按一下"全部執行"按鈕以執行單元測試。
4. 查看測試結果。 你應該看到你寫的測試(WithdrawAmount_ValidTransaction_ReturnsTrue)通過了。

![Moq C#(開發人員的工作原理)圖 3 - 要執行測試，首先必須建立解決方案。 建置成功後，開啟 Visual Studio 中的"測試資源管理器"，然後按一下"全部執行"按鈕開始執行單元測試。

這樣，我們就可以隔離要測試的程式碼，並透過有效地模擬依賴項來確保其在各種情況下都能如預期運作。 這種做法可以提高軟體的可靠性和可維護性，使在開發過程早期更容易發現和解決問題。

建立用於生成 PDF 的模擬對象

假設您正在開發一個產生財務報告的應用程序，並且這些報告需要儲存為 PDF 文件並進行分發。 在這種情況下，您可能需要測試 PDF 產生情況，並確保內容和格式正確。

首先，我們需要將IronPDF加入到我們的專案中。 在NuGet套件管理器控制台中輸入以下命令來安裝IronPDF。

Install-Package IronPdf

此命令將安裝並向我們的專案添加必要的依賴項。

以下是如何將IronPDF整合到單元測試流程中的方法：

生成模擬PDF

您可以使用IronPDF建立具有特定內容和樣式的模擬 PDF 文檔，以模仿真實的財務報告。 這些模擬 PDF 檔案可以用作單元測試的測試案例，如下面的程式碼片段所示：

public class PDFGenerator
{
    public void GenerateFinancialReport(string reportData)
    {
        var renderer = new ChromePdfRenderer();

        // Generate the report HTML
        string reportHtml = GenerateReportHtml(reportData);
        PdfDocument pdfDocument = renderer.RenderHtmlAsPdf(reportHtml);

        // Save the PDF to a file or memory stream
        pdfDocument.SaveAs("FinancialReport.pdf");
    }

    private string GenerateReportHtml(string reportData)
    {
        // Generate the report HTML based on the provided data
        // (e.g., using Razor views or any HTML templating mechanism)
        // Return the HTML as a string
        return "<h1>my Report</h1>";
    }
}

public class PDFGenerator
{
    public void GenerateFinancialReport(string reportData)
    {
        var renderer = new ChromePdfRenderer();

        // Generate the report HTML
        string reportHtml = GenerateReportHtml(reportData);
        PdfDocument pdfDocument = renderer.RenderHtmlAsPdf(reportHtml);

        // Save the PDF to a file or memory stream
        pdfDocument.SaveAs("FinancialReport.pdf");
    }

    private string GenerateReportHtml(string reportData)
    {
        // Generate the report HTML based on the provided data
        // (e.g., using Razor views or any HTML templating mechanism)
        // Return the HTML as a string
        return "<h1>my Report</h1>";
    }
}

使用模擬 PDF 進行單元測試

我們將編寫測試案例，使用IronPDF產生模擬 PDF 文件，以代表各種報告場景。 然後，我們將把程式碼產生的實際 PDF 與這些模擬 PDF 進行比較，以確保內容、格式和結構符合預期。

using IronPdf;
using NUnit.Framework;

internal class PDFGeneratorTests
{
    [Test]
    public void GenerateFinancialReport_CreatesCorrectPDF()
    {
        // Arrange
        var pdfGenerator = new PDFGenerator();
        var expectedPdf = PdfDocument.FromFile("ExpectedFinancialReport.pdf"); // Load a mock PDF

        // Act
        pdfGenerator.GenerateFinancialReport("Sample report data");
        var actualPdf = PdfDocument.FromFile("FinancialReport.pdf");

        // Assert
        Assert.AreEqual(actualPdf.ExtractAllText(), expectedPdf.ExtractAllText());
    }
}

using IronPdf;
using NUnit.Framework;

internal class PDFGeneratorTests
{
    [Test]
    public void GenerateFinancialReport_CreatesCorrectPDF()
    {
        // Arrange
        var pdfGenerator = new PDFGenerator();
        var expectedPdf = PdfDocument.FromFile("ExpectedFinancialReport.pdf"); // Load a mock PDF

        // Act
        pdfGenerator.GenerateFinancialReport("Sample report data");
        var actualPdf = PdfDocument.FromFile("FinancialReport.pdf");

        // Assert
        Assert.AreEqual(actualPdf.ExtractAllText(), expectedPdf.ExtractAllText());
    }
}

在本測試程式碼中，我們產生一個模擬 PDF(expectedPdf)，表示預期的輸出，並將其與 PDFGenerator 產生的 PDF(actualPdf）進行比較。 我們提取了這兩個 PDF 文件的內容，以驗證它們的內容是否相同。