Unit testing

Během práce na předchozích úlohách jste jistě zjistili, že testování toho, co naprogramujete, je nedílnou součástí tvorby softwaru. Vlastně každá funkce, metoda, nebo třída by měla mít svůj testovací kód, který vám jako programátorům pomůže zajistit, že váš kód dělá to, co po něm chcete.

Nebylo by pěkné, kdybyste pak mohli přijít ke svému třeba i poměrně rozsáhlému projektu a říct: “Hej, projekte, otestuj se?” A jakési kouzlo by pak prošlo, spustilo a zkontrolovalo výsledky všech testů, které jste pro svůj kód připravili. To je jeden z účelů metodiky, které se říká unit testing.

Úloha Spam je trochu rozsáhlejší. Abyste si mohli být jistí, že jdete po správné cestě, připravili jsme pro vás sadu unit testů, které by měly zkontrolovat všechny důležité aspekty vašeho kódu. Kontrola v upload systému kontroluje hlavně váš finální produkt - spam filtr. Unit testy zkontrolují dílčí funkce a třídy, které budete muset vytvořit. Pokud porozumíte jejich výstupům, měly by vám dát poměrně dobrá vodítka k tomu, kde se ve vašem kódu vyskytuje chyba či jiný problém.

U každého dílčího kroku na úloze Spam, který po vás požadujeme, proto najdete jeden či více souborů s unit testy. Ty si ukládejte a spouštějte ve stejném adresáři, kde budete vyvíjet svůj spam filtr a jeho podpůrné třídy či funkce.

Unit testy, které od nás dostanete, budou v modulech, jejichž názvy mají tvar test_xxxxx.py. Dostanete od nás také soubory, jejichž jména budou ve tvaru tst_xxxxx.py. Tyto moduly neobsahují unit testy, ale např. definice nějakých konstant či podpůrných funkcí, a jsou importovány do modulů s unit testy.

Váš kód v žádném případě nesmí importovat ani moduly test_xxxxx, ani tst_xxxxx. Můžete testovací kódy studovat a inspirovat se v nich, ale nesmíte je přímo využívat jako součást vašeho řešení úlohy, protože tyto moduly nebudou při finální kontrole kódu k dispozici!

Existuje několik balíků či knihoven umožňujících provádět unit testing. V základní distribuci Pythonu najdete dva:

• doctest (který je použitý např. v Python tutoriálu) a
• unittest.

Pro implementaci našich testů jsme vybrali druhou možnost, balík unittest, protože je Pythonovskou implementací standardně používaného testovacícho frameworku xUnit.

K otestování jedné dílčí funkce, metody nebo třídy stačí spustit příslušný unit test. V pozdější fázi řešení úlohy budete občas chtít spustit všechny unit testy. Doporučujeme vám vytvořit si dávkový soubor, po jehož spuštění modul unittest vyhledá a spustí všechny testy v aktuálním adresáři:

c:\python34\python -m unittest discover .

Řetězec c:\python34\ je cesta k interpretru Pythonu a vy si ji samozřejmě správně upravte podle vlastní instalace. Tečka za mezerou na konci řádku označuje aktuální adresář a musí tam být. Funkce discover je k dispozici až od verze 3.2. Vyvíjíte-li v Pythonu 3.1, udělejte si dávku s výčtem všech unit testů.

Viz též Spouštění testů v PyCharm.

Existuje celá řada doporučení, jak unit testy psát, co v nich dělat a co naopak nedělat. Např. se v praxi nedoporučuje v unit testech pracovat se soubory na disku, protože to přináší řadu neblahých jevů (testy jsou pomalé, dochází k souběhu, atd.).

My jsme se záměrně rozhodli některá z těchto doporučení porušit kvůli názornosti. V unit testech např. vytváříme na disku adresáře a soubory, které následně mažeme. Když budete kód procházet pomocí debuggeru, máte možnost vidět adresáře a soubory, které skutečně váš program zpracovává. Snad nám tyto prohřešky zkušenější programátoři mezi vámi odpustí.