Python Unittest – Klucz do testowania Twojego kodu! Przykłady i porady

Testowanie kodu to niezwykle ważny aspekt w procesie tworzenia oprogramowania. W Pythonie jednym z najpopularniejszych narzędzi do testowania jest biblioteka unittest. Dzięki niej możemy pisać testy jednostkowe, które pozwalają na sprawdzenie poprawności poszczególnych części naszego programu. Testowanie to nie tylko sposób na upewnienie się, że nasz kod działa zgodnie z oczekiwaniami, ale także kluczowy element utrzymania jakości aplikacji w miarę jej rozwoju. Dziś przyjrzymy się dokładniej Python unittest i jak wykorzystać go do skutecznego testowania!

Co to jest Python unittest?

unittest to wbudowana biblioteka Pythona, która pozwala na łatwe pisanie testów jednostkowych. Testy jednostkowe to technika, która pozwala na testowanie najmniejszych, pojedynczych fragmentów kodu – najczęściej funkcji lub metod. Celem takich testów jest upewnienie się, że dany fragment kodu działa zgodnie z oczekiwaniami, zanim przejdziemy do testów integracyjnych, które sprawdzają działanie systemu jako całości.

unittest jest bardzo wygodnym narzędziem, ponieważ umożliwia łatwe uruchamianie testów, raportowanie wyników, a także organizowanie testów w zbiory. Jest częścią standardowej biblioteki Pythona, co oznacza, że nie musimy instalować żadnych zewnętrznych pakietów, aby móc z niego korzystać.

Dlaczego warto korzystać z unittest w Pythonie?

Python unittest jest ceniony wśród programistów z wielu powodów. Oto niektóre z nich:

• Automatyzacja testów: Dzięki unittest możemy automatycznie uruchamiać testy po każdej zmianie w kodzie. To pozwala na szybkie wykrywanie błędów.
• Łatwość integracji: unittests łatwo można zintegrować z innymi narzędziami i procesami, takimi jak CI/CD, co zapewnia ciągłą kontrolę nad jakością kodu.
• Dokumentacja: Testy jednostkowe dokumentują oczekiwane zachowanie aplikacji. Dzięki nim inni programiści łatwo mogą zrozumieć, jak dany fragment kodu powinien działać.
• Bezpieczeństwo: Pisząc testy jednostkowe, zapewniamy większą stabilność aplikacji. Każda zmiana w kodzie, która wpływa na działanie funkcji, zostanie wychwycona przez odpowiedni test.

Jak korzystać z Python unittest? Podstawy

Aby zacząć korzystać z unittest, musimy zaimportować odpowiednie moduły i stworzyć klasę testową. Testowa klasa musi dziedziczyć po klasie unittest.TestCase, co daje dostęp do metod, które pozwalają na wykonywanie testów.

Oto podstawowy przykład, który pokazuje jak napisać pierwszy test jednostkowy:

import unittest

# Funkcja, którą będziemy testować
def dodaj(a, b):
    return a + b

# Klasa testowa
class TestDodaj(unittest.TestCase):
    
    def test_dodaj_liczby(self):
        # Sprawdzamy, czy funkcja dodaj działa poprawnie
        self.assertEqual(dodaj(2, 3), 5)
        self.assertEqual(dodaj(-1, 1), 0)
        self.assertEqual(dodaj(-5, -3), -8)

# Uruchomienie testów
if __name__ == '__main__':
    unittest.main()

W powyższym przykładzie:

• Stworzyliśmy funkcję dodaj, która dodaje dwie liczby.
• Stworzyliśmy klasę TestDodaj, która dziedziczy po unittest.TestCase i zawiera metodę test_dodaj_liczby.
• Wewnątrz metody testowej wykorzystaliśmy metodę assertEqual, która sprawdza, czy wynik funkcji jest równy oczekiwanemu.

Rodzaje asercji w unittest

unittest oferuje wiele różnych metod asercji, które pozwalają na sprawdzanie różnych warunków w testach. Oto najpopularniejsze z nich:

• assertEqual(a, b): Sprawdza, czy a jest równe b.
• assertNotEqual(a, b): Sprawdza, czy a nie jest równe b.
• assertTrue(x): Sprawdza, czy x jest wartością prawdziwą (True).
• assertFalse(x): Sprawdza, czy x jest wartością fałszywą (False).
• assertIsNone(x): Sprawdza, czy x jest równy None.
• assertIsNotNone(x): Sprawdza, czy x nie jest równy None.
• assertRaises(exc, func, *args, **kwargs): Sprawdza, czy podczas wywołania funkcji func z określonymi argumentami i parametrami zostanie zgłoszony wyjątek exc.

Przykład użycia różnych asercji:

class TestAsercje(unittest.TestCase):
    
    def test_assertTrue(self):
        self.assertTrue(5 > 3)
    
    def test_assertFalse(self):
        self.assertFalse(2 > 3)
    
    def test_assertIsNone(self):
        self.assertIsNone(None)
    
    def test_assertRaises(self):
        with self.assertRaises(ZeroDivisionError):
            1 / 0

Testowanie z różnymi danymi – parametrized

Czasami chcemy uruchomić ten sam test z różnymi danymi wejściowymi. W takim przypadku z pomocą przychodzi biblioteka parameterized, która pozwala na parametryzowanie testów.

Oto przykład, jak używać tej biblioteki:

from parameterized import parameterized

class TestDodajParametryzowane(unittest.TestCase):
    
    @parameterized.expand([
        (2, 3, 5),
        (-1, 1, 0),
        (-5, -3, -8)
    ])
    def test_dodaj_liczby(self, a, b, expected):
        self.assertEqual(dodaj(a, b), expected)

W tym przypadku test test_dodaj_liczby jest uruchamiany dla różnych zestawów danych wejściowych, co pozwala zaoszczędzić czas i kod.

Uruchamianie testów i raportowanie wyników

Testy w unittest mogą być uruchamiane na różne sposoby. Najczęściej używa się komendy python -m unittest, która automatycznie wykrywa pliki testowe i uruchamia testy w nich zawarte.

Wyniki testów są przedstawiane w formie tekstowej, a także możemy skonfigurować je tak, aby generować raporty w formacie XML lub HTML. Dzięki temu łatwo śledzić, które testy zakończyły się sukcesem, a które niepowodzeniem.

Podsumowanie

Testowanie kodu w Pythonie z użyciem unittest to kluczowy krok w zapewnieniu jakości aplikacji. Dzięki unittest możemy pisać testy jednostkowe, które sprawdzają najmniejsze fragmenty kodu, zapewniając ich poprawność. Zajmując się testowaniem, inwestujemy w jakość naszego oprogramowania, co może zapobiec wielu problemom w przyszłości. Pamiętaj, że testy jednostkowe to tylko początek – ważne jest także testowanie integracyjne, systemowe i akceptacyjne, które również warto wdrożyć w projekcie.

Jeśli jeszcze nie korzystasz z unittest w swoich projektach, to najwyższa pora, aby zacząć! Twój kod stanie się bardziej niezawodny, a Ty będziesz miał pełną kontrolę nad jego jakością.