Testowanie jednostkowe w języku C# (jak to działa dla programistów)

Tworzenie projektu testów jednostkowych

Aby rozpocząć testowanie jednostkowe w języku C#, należy skonfigurować jeden z projektów testów jednostkowych w programie Visual Studio. Visual Studio oferuje wbudowaną platformę do testowania jednostkowego, co ułatwia rozpoczęcie pracy. Podczas tworzenia nowego projektu wybierz szablon "Unit Test Project" w kategorii C#. Ten szablon zawiera wszystko, czego potrzebujesz do tworzenia testów jednostkowych i ich wydajnego uruchamiania.

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);
        }
    }
}

Imports Microsoft.VisualStudio.TestTools.UnitTesting
Imports System

Namespace Unit_Test_Project_Example
	' A simple calculator class with an Add method
	Public Class Calculator
		Public Function Add(ByVal a As Integer, ByVal b As Integer) As Integer
			Return a + b
		End Function
	End Class

	' 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 Sub Add_ShouldReturnCorrectSum()
			' Arrange
			Dim calculator As New Calculator()

			' Act
			Dim result = calculator.Add(2, 2)

			' Assert
			Assert.AreEqual(4, result)
		End Sub
	End Class
End Namespace

Zrozumienie metod testowych i klas testowych

W projekcie testów jednostkowych organizujesz testy w klasy i metody. Klasa testowa reprezentuje zbiór metod testów jednostkowych, które powinny być uruchamiane razem. Każda metoda testu jednostkowego, oznaczona atrybutem [TestMethod], zawiera logikę służącą do testowania konkretnej funkcji kodu. Sama klasa testowa jest oznaczona atrybutem [TestClass], sygnalizującym frameworkowi testowemu, że zawiera ona testy do wykonania.

Korzystanie z eksploratora testów w programie Visual Studio

Okno Visual Studio Test Explorer stanowi centralny punkt do uruchamiania wszystkich metod testowych i zarządzania nimi. Możesz uruchomić wszystkie testy, wybrane testy lub pojedyncze testy. Po przeprowadzeniu testów Test Explorer udostępnia szczegółowe podsumowanie testów zakończonych sukcesem i niepowodzeniem, co pozwala szybko zidentyfikować i rozwiązać problemy.

Interpretacja wyników testów

• Testy zakończone sukcesem: Testy te przebiegły pomyślnie, co oznacza, że testowany kod zachowuje się zgodnie z oczekiwaniami w określonych warunkach.
• Nieudane testy: Wskazują one na rozbieżność między oczekiwanymi a rzeczywistymi wynikami, sygnalizując potencjalne błędy lub nieporozumienia w wymaganiach lub kodzie testowym.

Konieczne jest szybkie zbadanie nieudanych testów, ponieważ mogą one stanowić wczesne sygnały ostrzegawcze o problemach w kodzie źródłowym.

Skuteczna organizacja testów

Dobra organizacja jest kluczem do utrzymania dużej Suite testów. Pogrupuj testy logicznie według funkcji, które obejmują. Używaj opisowych nazw dla metod testowych i klas, aby wskazać, co weryfikuje każdy test. Takie podejście ułatwia późniejsze wyszukiwanie i zrozumienie testów, zwłaszcza w miarę rozrastania się Suite testów.

Mocking i wstrzykiwanie zależności

Często testowany kod współdziała z zasobami zewnętrznymi lub innymi częściami aplikacji. W takich przypadkach należy używać frameworków do tworzenia obiektów testowych, takich jak Moq lub NSubstitute. Te zastępcze obiekty naśladują zachowanie prawdziwych obiektów, umożliwiając testowanie kodu w izolacji. Wstrzykiwanie zależności sprawia, że kod jest łatwiejszy do testowania, ponieważ pozwala zastąpić rzeczywiste zależności makietami lub stubami podczas testowania.

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);
    }
}

Imports Microsoft.VisualStudio.TestTools.UnitTesting
Imports 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 Sub GetProductById_ShouldReturnCorrectProduct()
		' Arrange
		Dim mockRepository = New Mock(Of IProductRepository)()
		mockRepository.Setup(Function(x) x.FindById(1)).Returns(New Product With {
			.Id = 1,
			.Name = "Laptop"
		})

		Dim productService As New ProductService(mockRepository.Object)

		' Act
		Dim result As Product = productService.GetProductById(1)

		' Assert
		Assert.IsNotNull(result)
		Assert.AreEqual("Laptop", result.Name)
	End Sub
End Class

Wykorzystanie testów opartych na danych

Testy oparte na danych pozwalają na wielokrotne uruchamianie tej samej metody testowej z różnymi danymi wejściowymi. Technika ta jest szczególnie przydatna do testowania szerokiego zakresu danych wejściowych i scenariuszy bez konieczności pisania wielu metod testowych. Visual Studio obsługuje testowanie oparte na danych, umożliwiając określenie danych testowych z różnych źródeł, takich jak dane wbudowane, pliki CSV lub bazy danych.

Zrozumienie i efektywne wykorzystanie asercji

Aserty są sercem metod testowych, ponieważ weryfikują wyniki testów. Zapoznaj się z zakresem metod assert dostępnych w Twoim frameworku testowym i stosuj je odpowiednio do sprawdzania oczekiwanych wartości, wyjątków lub warunków. Użycie odpowiedniego aserty może sprawić, że Twoje testy będą bardziej przejrzyste i solidniejsze.

Ciągła integracja i automatyzacja testów

Zintegruj testy jednostkowe z procesem ciągłej integracji (CI). Dzięki temu testy będą uruchamiane automatycznie za każdym razem, gdy wprowadzone zostaną zmiany w kodzie, co pomoże wcześnie wykrywać i naprawiać problemy. Automatyzacja ułatwia również częste i konsekwentne przeprowadzanie testów, co ma kluczowe znaczenie dla utrzymania dobrej kondycji kodu źródłowego.

Synchronizacja testów i kodu produkcyjnego

Jakość testów jednostkowych zależy od tego, na ile są one zgodne z kodem produkcyjnym. Należy upewnić się, że wszelkie zmiany w funkcjonalności zostaną odzwierciedlone w odpowiednich testach jednostkowych. Takie postępowanie zapobiega nieprawidłowemu przechodzeniu przestarzałych testów i gwarantuje, że Suite testów dokładnie odzwierciedla stan aplikacji.

Wnioski płynące z nieudanych testów

Kiedy test kończy się niepowodzeniem, jest to okazja do nauki i doskonalenia się. Niepowodzenie testu może ujawnić nieoczekiwane zachowania, błędne założenia lub obszary kodu, które są bardziej złożone i podatne na błędy niż to konieczne. Dokładnie analizuj nieudane testy, aby zrozumieć ich przyczyny, a następnie wykorzystaj te spostrzeżenia do ulepszenia zarówno testów, jak i kodu produkcyjnego.

Przykład kodu

Oto przykład wykorzystania IronPDF w scenariuszu testowania jednostkowego w języku C#. Załóżmy, że chcesz przetestować funkcję, która generuje plik PDF na podstawie treści HTML. Możesz użyć IronPDF do renderowania kodu HTML jako pliku PDF, a następnie zweryfikować istnienie lub zawartość pliku PDF w ramach testu:

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);
    }
}

Imports IronPdf
Imports Microsoft.VisualStudio.TestTools.UnitTesting
Imports System
Imports 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 Sub TestHtmlToPdfGeneration()
		IronPdf.License.LicenseKey = "License-Key" ' Set your IronPDF license key

		Dim renderer = New ChromePdfRenderer()

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

		Dim filePath As String = 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)
	End Sub
End Class

Ten przykład przedstawia prosty test jednostkowy, który wykorzystuje IronPDF do wygenerowania pliku PDF z ciągu znaków HTML, zapisania go w pliku tymczasowym, a następnie sprawdzenia istnienia tego pliku.