pyTest Tutorial #5: Konstrukcja testu
W piątej części serii pyTest Tutorial poznamy elementy, z jakich może, a z jakich musi się składać standardowa funkcja testująca.
Pytest Tutorial
Mając już wiedzę dotyczącą uruchamiania testów, a także związaną z kluczowym elementem testu, czyli asercji, możemy przyjrzeć się konstrukcji samego testu. Częściowo dzisiejsza odsłona będzie podsumowaniem dotychczas zdobytej wiedzy. Poznamy w niej dodatkowo kilka części składowych, które powinien zawierać każdy test. Ponadto przedstawimy elementy, które są opcjonalne.
Ogólna konstrukcja testów
Większość testów pisanych przy użyciu pyTest’a będzie się opierało na takim samym schemacie:
- definicja funkcji testującej,
- warunki wstępne,
- akcje testu,
- asercja (jedna lub więcej),
- czynności zamykające.
Dla większości testerów takie zestawienie nie powinno być niczym nowym, gdyż są to podstawowe elementy każdego, nawet nieautomatycznego testu. Jedyną różnicą jest rozbicie kroków testu na akcje oraz asercje.
Definicja funckji testującej
Jak już wspominałem w jednej z poprzednich części, definicja funkcji testujące musi spełniać tylko dwa warunki. Pierwszym z nich jest spełnianie wymogów dotyczących nazwy standardowej funkcji, czyli na przykład nie może się rozpoczynać od cyfry. Drugim warunkiem jest dopasowanie do jednego z poniższych wzorców. Dzięki temu informujemy pyTesta, które funkcje są funkcjami pomocniczymi, a które są testami:
- test_*
- *_test
Warunki wstępne
Warunki wstępne przygotowują środowisko do przeprowadzenia testu, oczywiście, jeśli takie przygotowanie jest wymagane. Nie inaczej jest w przypadku funkcji testujących. Na chwilę obecną, ustawianie warunków początkowych można umieścić w ciele testu, jednak już niedługo poznamy o wiele ciekawsze sposoby na ich wprwoadzanie.
Akcje testu
W przypadku bardzo prostych testów może nie być potrzebnych dodatkowych akcji w teście, jednak w znacznej większości jest to element wymagany. Są to nic innego jak kroki testu. W zależności od tego co udostępnia nam framework łączący nas z programem testowanym, mogą one zawierać interakcję z systemem.
Asercja(e)
I w końcu doszliśmy do najważniejszego elementu testu, bez którego żaden test automatyczny nie miałby sensu, gdyż nie byłoby elementu decydującego o jego pozytywnym lub negatywnym zakończeniu – oczywiście pomijając wszystkie wyjątki :). W każdym teście z reguły znajduje się jedna lub więcej asercji. Zostały one szczegółowo opisane w poprzedniej części.
Czynności zamykające test
Jest to ostatni element testu, którego istnienie jest w wielu przypadkach niezbędne. Służy on do wykonania czynności, które posprzątają po teście. Można oczywiście umieścić je w ciele testu, bezpośrednio po asercjach, jednak takie rozwiązanie posiada wiele wad — na przykład w przypadku niepowodzenia testu, czynności te się nie wykonają. W kolejnych częściach poznamy, jakie są polecane praktyki w tym zakresie.
Piszemy testy w pyTest
W części pierwszej utworzyliśmy również dwa testy w pliku test_calc.py. Plik zaczyna się od importu klasy, którą będziemy testować. Klasa ta znajduje się w pliku base, który jest w tej samej lokalizacji co plik z testami, także możemy z powodzeniem wykonać import jak w przykładzie poniżej. W poniższych testach nie będziemy mieli potrzeby wykorzystywania czynności otwierających oraz zamykających test. Z racji, że będziemy chcieli dokładniej przetestować funkcjonalności dodawania, zmieńmy nazwy stworzonych w pierwszej części testów, zgodnie z poniższym.
from base import BasicCalculator
def test_addition_10_5():
object = BasicCalculator()
object.provide_number(10)
object.provide_operand('+')
object.provide_number(5)
assert object.show_result()[0] == 15
def test_subtraction_13_21():
object = BasicCalculator()
object.provide_number(13)
object.provide_operand('-')
object.provide_number(21)
assert object.show_result()[0] == -8KodTeraz możemy dopisać kilka testów zarówno do funkcji dodawania, jak i odejmowania:
def test_addition_2_m4():
object = BasicCalculator()
object.provide_number(2)
object.provide_operand('+')
object.provide_number(-4)
assert object.show_result()[0] == -2
def test_addition_m10_12():
object = BasicCalculator()
object.provide_number(-10)
object.provide_operand('+')
object.provide_number(12)
assert object.show_result()[0] == 2
def test_subtraction_m3_m7():
object = BasicCalculator()
object.provide_number(-3)
object.provide_operand('-')
object.provide_number(-7)
assert object.show_result()[0] == 4Mając już całkiem spory zestaw testów, możemy przejść do ich uruchomienia. Wykonamy to zgodnie ze sposobami uruchamiania testów, jakie poznaliśmy w poprzednich częściach:
(env) qabrio@test:~/basic_calculator$ pytest test_calc.py -v --tb=line
========================================= test session starts =========================================
platform linux -- Python 3.6.9, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 -- /home/qabrio/basic_calculator/env/bin/python3.6
cachedir: .cache
rootdir: /home/qabrio/basic_calculator, inifile:
collected 9 items
test_calc.py::test_addition_10_5 PASSED [ 11%]
test_calc.py::test_subtraction_13_21 PASSED [ 22%]
test_calc.py::test_addition_2_m4 PASSED [ 33%]
test_calc.py::test_addition_m10_12 PASSED [ 44%]
test_calc.py::test_subtraction_m3_m7 PASSED [ 55%]
test_calc.py::test_multiplication_2_2 PASSED [ 66%]
test_calc.py::test_multiplication_m7_3 PASSED [ 77%]
test_calc.py::test_division_10_2 PASSED [ 88%]
test_calc.py::test_division_12_0 FAILED [100%]
================================================ FAILURES =============================================
/home/qabrio/basic_calculator/base.py:26: ZeroDivisionError: integer division or modulo by zero
================================= 1 failed, 8 passed in 0.02 seconds ==================================
(env) qabrio@test:~/basic_calculator$ Podsumowując, udało nam się przebrnąć przez konstrukcję pisania, a także napisaliśmy kilka dodatkowych testów do klasy BasicCalculator. Oczywiście nie są to wszystkie możliwe testy, dlatego też, w kolejnej części poznamy możliwe sposoby parametryzowania testów. Jest to bardzo przydatne narzędzie, dlatego zapraszam do lektury!
