C# Unit Testing (How It Works For Developers)

建立單元測試項目

要開始在 C# 中進行單元測試，您需要在 Visual Studio 中設定一個單元測試專案。 Visual Studio 提供了一個內建的單元測試框架，因此入門非常簡單。 建立新專案時，請在 C# 類別下選擇"單元測試項目"範本。 此模板設定了創建單元測試並高效運行它們所需的一切。

using Microsoft.VisualStudio.TestTools.UnitTesting;
using System;

namespace Unit_Test_Project_Example
{
    // A simple calculator class with an Add method
    public class Calculator
    {
        public int Add(int a, int b)
        {
            return a + b;
        }
    }

    // A test class to validate the functionality of the Calculator class
    [TestClass]
    public class CalculatorTests
    {
        // A test method to check if the Add method in Calculator returns the correct sum
        [TestMethod]
        public void Add_ShouldReturnCorrectSum()
        {
            // Arrange
            var calculator = new Calculator();

            // Act
            var result = calculator.Add(2, 2);

            // Assert
            Assert.AreEqual(4, result);
        }
    }
}

using Microsoft.VisualStudio.TestTools.UnitTesting;
using System;

namespace Unit_Test_Project_Example
{
    // A simple calculator class with an Add method
    public class Calculator
    {
        public int Add(int a, int b)
        {
            return a + b;
        }
    }

    // A test class to validate the functionality of the Calculator class
    [TestClass]
    public class CalculatorTests
    {
        // A test method to check if the Add method in Calculator returns the correct sum
        [TestMethod]
        public void Add_ShouldReturnCorrectSum()
        {
            // Arrange
            var calculator = new Calculator();

            // Act
            var result = calculator.Add(2, 2);

            // Assert
            Assert.AreEqual(4, result);
        }
    }
}

理解測試方法和測試類

在單元測試專案中，你需要將測試組織成類別和方法。 測試類別代表一組應該一起執行的單元測試方法。 每個單元測試方法都以[TestMethod]特性修飾，其中包含測試程式碼中特定功能的邏輯。 測試類別本身帶有[TestClass]屬性，向測試框架發出訊號，表示它包含要執行的測試。

在 Visual Studio 中使用測試資源管理器

Visual Studio 測試資源管理器視窗是執行和管理所有測試方法的中心樞紐。 您可以執行所有測試、選定的測試或單一測試。 測試運行後，測試資源管理器會提供通過和失敗測試的詳細摘要，使您能夠快速識別和解決問題。

解讀測試結果

*通過測試：*這些測試運行成功，表示被測程式碼在指定條件下如預期運行。 測試失敗：**這表示預期結果與實際結果之間存在差異，表示需求或測試程式碼中可能存在錯誤或誤解。

及時調查失敗的測試至關重要，因為它們可以提供程式碼庫中問題的早期預警訊號。

C# 單元測試（開發者如何操作）：圖 1 - Visual Studio 中通過的單元測試範例

有效組織考試

良好的組織能力是維護大量測試的關鍵。 按功能對測試進行邏輯分組。 使用描述性的名稱來命名你的測試方法和類別，以表明每個測試驗證的內容。 這種方法使得以後更容易找到和理解測試，尤其是在測試套件不斷增長的情況下。

模擬和依賴注入

通常情況下，您正在測試的程式碼會與外部資源或應用程式的其他部分進行互動。 在這種情況下，可以使用 Moq 或 NSubstitute 等模擬框架來建立模擬物件。 這些替代物件模擬真實物件的行為，使您可以在隔離的環境中測試程式碼。 依賴注入使你的程式碼更容易測試，因為它允許你在測試期間用模擬或樁替換真實的依賴項。

using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;

// A sample test class demonstrating the use of mocks
[TestClass]
public class ProductServiceTests
{
    // A test method to verify the GetProductById method of ProductService
    [TestMethod]
    public void GetProductById_ShouldReturnCorrectProduct()
    {
        // Arrange
        var mockRepository = new Mock<IProductRepository>();
        mockRepository.Setup(x => x.FindById(1)).Returns(new Product { Id = 1, Name = "Laptop" });

        ProductService productService = new ProductService(mockRepository.Object);

        // Act
        Product result = productService.GetProductById(1);

        // Assert
        Assert.IsNotNull(result);
        Assert.AreEqual("Laptop", result.Name);
    }
}

using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;

// A sample test class demonstrating the use of mocks
[TestClass]
public class ProductServiceTests
{
    // A test method to verify the GetProductById method of ProductService
    [TestMethod]
    public void GetProductById_ShouldReturnCorrectProduct()
    {
        // Arrange
        var mockRepository = new Mock<IProductRepository>();
        mockRepository.Setup(x => x.FindById(1)).Returns(new Product { Id = 1, Name = "Laptop" });

        ProductService productService = new ProductService(mockRepository.Object);

        // Act
        Product result = productService.GetProductById(1);

        // Assert
        Assert.IsNotNull(result);
        Assert.AreEqual("Laptop", result.Name);
    }
}

利用數據驅動測試

資料驅動測試可讓您使用不同的輸入資料多次執行相同的測試方法。 這種技術特別適用於測試各種輸入和場景，而無需編寫多個測試方法。 Visual Studio 支援資料驅動測試，可讓您從各種來源（例如內聯資料、CSV 檔案或資料庫）指定測試資料。

有效理解和運用斷言

斷言是測試方法的核心，因為它們可以驗證測試結果。 了解測試框架中可用的各種斷言方法，並適當地使用它們來檢查預期值、異常或條件。 使用正確的斷言可以讓你的測驗更清晰、更健壯。

持續整合和測試自動化

將單元測試整合到持續整合 (CI) 管線中。這樣可以確保每次程式碼庫發生變更時都會自動執行測試，有助於及早發現並修復問題。 自動化還有助於頻繁、持續地運行測試，這對於維護健康的程式碼庫至關重要。

保持測試程式碼和生產程式碼同步

單元測試的品質取決於它與生產程式碼的一致性。 確保功能上的任何變更都能反映在相應的單元測試中。 這種做法可以防止過時的測試錯誤地通過，並確保您的測試套件準確地反映應用程式的狀態。

從失敗的測試中學習

考試失敗是學習和進步的機會。 失敗的測試可以揭示意想不到的行為、錯誤的假設，或程式碼中比必要情況更複雜、更容易出錯的部分。 仔細分析失敗的測試，了解其根本原因，並利用這些見解來改進你的測試和生產程式碼。

程式碼範例

以下是如何在 C# 單元測試場景中使用 IronPDF 的範例。 假設你想測試一個從 HTML 內容產生 PDF 的函數。 您可以使用 IronPDF 將 HTML 渲染成 PDF，然後在測試中驗證 PDF 是否存在或內容是否正確：

using IronPdf;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using System;
using System.IO;

// A sample test class to verify PDF generation
[TestClass]
public class PdfGenerationTests
{
    // A test method to verify HTML to PDF generation using IronPDF
    [TestMethod]
    public void TestHtmlToPdfGeneration()
    {
        IronPdf.License.LicenseKey = "License-Key"; // Set your IronPDF license key

        var renderer = new ChromePdfRenderer();

        // Render HTML to a PDF
        var pdf = renderer.RenderHtmlAsPdf("<h1>Hello, world!</h1>");

        string filePath = Path.Combine(Path.GetTempPath(), "test.pdf");

        // Save the generated PDF to a file
        pdf.SaveAs(filePath);

        // Assert the PDF file was created successfully
        Assert.IsTrue(File.Exists(filePath), "The generated PDF does not exist.");

        // Additional assertions to verify the PDF content could be added here
        // Clean up generated file
        File.Delete(filePath);
    }
}

using IronPdf;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using System;
using System.IO;

// A sample test class to verify PDF generation
[TestClass]
public class PdfGenerationTests
{
    // A test method to verify HTML to PDF generation using IronPDF
    [TestMethod]
    public void TestHtmlToPdfGeneration()
    {
        IronPdf.License.LicenseKey = "License-Key"; // Set your IronPDF license key

        var renderer = new ChromePdfRenderer();

        // Render HTML to a PDF
        var pdf = renderer.RenderHtmlAsPdf("<h1>Hello, world!</h1>");

        string filePath = Path.Combine(Path.GetTempPath(), "test.pdf");

        // Save the generated PDF to a file
        pdf.SaveAs(filePath);

        // Assert the PDF file was created successfully
        Assert.IsTrue(File.Exists(filePath), "The generated PDF does not exist.");

        // Additional assertions to verify the PDF content could be added here
        // Clean up generated file
        File.Delete(filePath);
    }
}

本範例示範了一個簡單的單元測試，該測試使用 IronPDF 從 HTML 字串產生 PDF，將其儲存到臨時文件，然後驗證文件是否存在。

C# 單元測試（開發者如何操作）：圖 3 - 上一個測試已通過