Jak skutecznie pisać c# unit tests? Przykłady i porady

Testowanie kodu to kluczowy element w procesie tworzenia oprogramowania. W dzisiejszych czasach, kiedy zależy nam na jakości, stabilności i niezawodności aplikacji, nie możemy sobie pozwolić na ignorowanie testów. C# unit tests to jedno z najważniejszych narzędzi w rękach każdego programisty. W tym artykule przyjrzymy się, jak pisać i uruchamiać testy jednostkowe w języku C#, zaprezentujemy przykłady, oraz pokażemy, dlaczego unit testy są niezbędne w każdym projekcie programistycznym.

Co to są unit testy i dlaczego są ważne?

Unit testy (testy jednostkowe) to małe fragmenty kodu, które sprawdzają poprawność działania pojedynczych jednostek aplikacji, czyli funkcji lub metod. Celem tych testów jest upewnienie się, że każdy komponent systemu działa zgodnie z oczekiwaniami i nie wprowadza nieoczekiwanych błędów.

W skrócie, unit testy pomagają w wykrywaniu błędów na wczesnym etapie pracy, co oszczędza czas i zasoby. Dzięki testom jednostkowym programista może mieć pewność, że kod jest odporny na zmiany i działa poprawnie w różnych warunkach. Jeśli jeden z testów nie przejdzie, programista natychmiast otrzymuje informację, gdzie dokładnie wystąpił problem. Testowanie jednostkowe umożliwia również łatwiejsze refaktoryzowanie kodu oraz wprowadzenie nowych funkcji bez obawy o wprowadzenie regresji.

Jak zacząć pisać testy jednostkowe w C#?

W C# testy jednostkowe są zazwyczaj pisane za pomocą frameworków takich jak MS Test, JUnit (w połączeniu z biblioteką NUnit), xUnit czy Moq do mockowania zależności. Zanim jednak przejdziemy do przykładów, warto dowiedzieć się, jak w ogóle zacząć pracę z tymi narzędziami.

Aby rozpocząć pisanie unit testów w C#, należy wykonać kilka kroków:

• Instalacja frameworka testowego: Aby korzystać z unit testów w C#, musisz zainstalować odpowiedni framework. Możesz wybrać MS Test, xUnit, JUnit lub NUnit. Wybór zależy od Twoich preferencji i wymagań projektu.
• Utworzenie projektu testowego: Aby pisać testy, musisz utworzyć nowy projekt testowy w Visual Studio. Możesz to zrobić, wybierając opcję "Projekt testowy" w szablonach dostępnych w Visual Studio.
• Dodanie zależności: Następnie należy dodać odpowiednie pakiety NuGet, takie jak Microsoft.VisualStudio.TestTools.UnitTesting lub xUnit, w zależności od wybranego frameworka.

Podstawowa struktura testu jednostkowego w C#

Każdy test jednostkowy w C# ma swoją specyficzną strukturę. Oto podstawowy przykład testu jednostkowego napisanego przy użyciu frameworka MS Test:

using Microsoft.VisualStudio.TestTools.UnitTesting;

[TestClass]
public class CalculatorTests
{
    [TestMethod]
    public void Add_TwoNumbers_ReturnsCorrectResult()
    {
        // Arrange
        var calculator = new Calculator();
        var number1 = 3;
        var number2 = 5;
        
        // Act
        var result = calculator.Add(number1, number2);
        
        // Assert
        Assert.AreEqual(8, result);
    }
}

W tym przykładzie mamy do czynienia z bardzo prostym testem jednostkowym. Składa się on z trzech głównych etapów:

• Arrange: Przygotowanie danych do testu – w tym przypadku tworzymy obiekt klasy Calculator i ustawiamy liczby do dodania.
• Act: Wywołanie metody, którą chcemy przetestować – w tym przypadku jest to metoda Add, która sumuje dwie liczby.
• Assert: Sprawdzenie wyniku testu – sprawdzamy, czy wynik dodawania dwóch liczb wynosi 8.

Przykłady bardziej zaawansowanych testów jednostkowych

Testy jednostkowe mogą być bardziej złożone, gdy aplikacja staje się bardziej rozbudowana. Oto kilka przykładów bardziej zaawansowanych testów jednostkowych w C#:

Przykład 1: Test z mockowaniem zależności (Moq)

Często w aplikacjach korzystamy z zewnętrznych zależności, takich jak bazy danych, API czy systemy płatności. W takich przypadkach warto mockować (czyli udawać) te zależności, aby testy nie zależały od rzeczywistych zasobów. Można to zrobić za pomocą biblioteki Moq.

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

public interface IDatabaseService
{
    string GetData(int id);
}

public class DataProcessor
{
    private readonly IDatabaseService _databaseService;

    public DataProcessor(IDatabaseService databaseService)
    {
        _databaseService = databaseService;
    }

    public string ProcessData(int id)
    {
        var data = _databaseService.GetData(id);
        return $"Processed {data}";
    }
}

[TestClass]
public class DataProcessorTests
{
    [TestMethod]
    public void ProcessData_ValidId_ReturnsCorrectResult()
    {
        // Arrange
        var mockDatabaseService = new Mock();
        mockDatabaseService.Setup(service => service.GetData(1)).Returns("Sample Data");
        
        var dataProcessor = new DataProcessor(mockDatabaseService.Object);

        // Act
        var result = dataProcessor.ProcessData(1);

        // Assert
        Assert.AreEqual("Processed Sample Data", result);
    }
}

W tym przykładzie mockujemy usługę bazy danych, aby testować klasę DataProcessor bez rzeczywistego połączenia z bazą danych.

Przykład 2: Testy dla wyjątków

Często w aplikacjach musimy obsługiwać wyjątki, na przykład gdy użytkownik podaje błędne dane wejściowe. Testowanie obsługi wyjątków jest równie ważne, jak testowanie poprawnych scenariuszy.

[TestMethod]
[ExpectedException(typeof(ArgumentException))]
public void Divide_DivideByZero_ThrowsArgumentException()
{
    // Arrange
    var calculator = new Calculator();
    
    // Act
    calculator.Divide(10, 0); // powinno rzucić wyjątek
    
    // Assert - wyjątek jest oczekiwany, więc brak dodatkowego kodu
}

W tym przypadku testujemy metodę Divide, która rzuca wyjątek ArgumentException, gdy dzielimy przez zero.

Jak uruchomić testy jednostkowe w C#?

Po napisaniu testów jednostkowych w C#, możesz je uruchomić za pomocą narzędzi dostępnych w Visual Studio. Istnieje kilka metod uruchamiania testów:

• Test Explorer: W Visual Studio dostępne jest okno Test Explorer, w którym możesz uruchomić wszystkie testy, sprawdzić ich wyniki i debugować.
• Run Tests: Możesz kliknąć prawym przyciskiem myszy na pliku testowym i wybrać opcję "Uruchom testy".
• Integracja z Continuous Integration: Testy mogą być również zintegrowane z systemami CI/CD, aby uruchamiały się automatycznie po każdej zmianie w repozytorium.

Podsumowanie

C# unit tests są potężnym narzędziem w arsenale każdego programisty, pomagającym w utrzymaniu wysokiej jakości kodu. Pisanie testów jednostkowych pozwala na wczesne wykrywanie błędów, poprawia wydajność zespołu i zapewnia większą stabilność aplikacji. Dzięki takim narzędziom jak Moq czy xUnit, proces testowania staje się jeszcze łatwiejszy i bardziej elastyczny. Pamiętaj, że testowanie kodu to inwestycja w jakość, która zawsze się opłaca!