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 。

若要在 Visual Studio 解決方案中加入 NUnit 測試專案，請遵循下列步驟：

1.在解決方案上按一下滑鼠右鍵：在解決方案總管中（通常在右側），按一下解決方案名稱的滑鼠右鍵。 2.新增 > 新專案： 從上下文功能表中選擇"新增"，然後選取"新專案..."。 3.建立新專案：在"新增專案"對話方塊中，您可以搜尋"NUnit"以尋找可用的 NUnit 模版。 選擇 NUnit 測試專案，如下所示。

。

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

現在，您的解決方案中已有一個獨立的 NUnit 測試專案，您可以在其中編寫和管理您的單元測試。 您也可以在此專案中加入您想要測試的專案參考，並開始撰寫您的 NUnit 測試案例。

若要開始在測試專案中使用 MOQ，您需要將 MOQ NuGet 套件新增至您的解決方案中。 您可以使用 Visual Studio 中的 NuGet Package Manager 或在 Package Manager Console 中執行以下指令來完成：

Install-Package Moq

此指令將安裝套件，並將所有所需的相依性加入專案中。

使用 NUnit 和 MOQ 撰寫單元測試，以模擬 ATMCashWithdrawal class 的依賴項目 (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 類別。 透過 mocking，我們可以確保程式碼能正確地與這些相依性互動，讓我們的測試更有焦點、更可預測，並能有效找出所檢查的特定程式碼單元中的問題。 此做法可提升整體可靠性、可維護性及測試代碼的品質。

步驟 3 執行測試

1.建立您的解決方案，確保所有內容都是最新的。 2.開啟 Visual Studio 中的 Test Explorer (Test > Test Explorer)。 3.按一下 Test Explorer 中的"Run All"按鈕來執行單元測試。 4.檢閱測試結果。 您應該會看到您所寫的測試 (WithdrawAmount_ValidTransaction_ReturnsTrue) 通過。

透過這種方式，我們可以隔離想要測試的程式碼，並透過有效的模擬依賴關係，確保程式碼在各種情況下的行為符合預期。 這種做法可提高軟體的可靠性和可維護性，讓您更容易在開發過程中及早發現並修復問題。

建立模擬物件以產生 PDFs

假設您正在開發一個會產生財務報告的應用程式，而這些報告需要以 PDF 文件的形式儲存與散佈。 在這種情況下，您可能想要測試 PDF 的產生，並確保內容和格式正確無誤。

首先，我們需要在專案中加入 IronPdf。 在 NuGet Package Manager Console 中編寫以下指令以安裝 IronPDF。

Install-Package IronPdf

此指令將安裝及新增必要的相依性至我們的專案。

以下是 IronPdf 如何融入單元測試流程：

產生模擬 PDFs

您可以使用 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 的內容，以驗證它們是否具有相同的內容。