Integrační testy Doctrine, Messenger a Deptrac
Testy tam, kde vstupuje infrastruktura. Integrační test repozitáře proti skutečné databázi, flush() a clear() kvůli Identity Map, transakční rollback přes dama/doctrine-test-bundle a jeho limity. Funkční test přes WebTestCase, asynchronní tok s in-memory transportem a zenstruck/messenger-test, test idempotence handleru a dvě záruky outboxu. Architektonické testy s Deptracem a PHPArkitectem, code coverage a mutation testing s Infection.
Přehrávač YouTube se načte až po kliknutí · otevřít na YouTube (nové okno) ↗
Přepis dílu komentář tak, jak zazní ve videu
Zelený test, prázdná databáze
Modelová situace. Integrační test repozitáře uloží uživatele, načte ho podle ID a porovná e-mail. Svítí zeleně.
Do databáze se přitom nezapsal ani řádek. Test nezavolal flush a Doctrine vrátil objekt rovnou z paměti, z takzvané Identity Map.
Integrační testy s Doctrine
Unit testy neřeknou, jestli mapování Doctrine a dotazy repozitáře dělají, co rozhraní slibuje. To ověří až integrační test.
Dědí z KernelTestCase. Ten nabootuje kernel bez HTTP vrstvy a test si z kontejneru vezme skutečný repozitář. WebTestCase přidává HTTP klienta a patří funkčním testům.
Databáze má být stejná jako v produkci, spuštěná v kontejneru. SQLite v paměti je rychlejší, jenže jinak zachází s typy, unikátními constrainty i transakcemi.
Lokálně je to vědomá zkratka. CI na ní stát nemá.
Zpátky k testu z úvodu. Metoda save v knize jen persistuje, flush patří handleru. Test si ho proto musí zavolat sám.
Po flushi přijde clear. Vyprázdní Identity Map a findById pak objekt opravdu načte z tabulky. Bez něj dostane test zpátky tutéž instanci, kterou před chvílí uložil.
Zbývá úklid. Kdyby každý test nechal v tabulce svá data, testy by se navzájem ovlivňovaly. Kapitola to řeší balíčkem DAMA Doctrine Test Bundle.
Ten drží jedno statické spojení s databází po celý běh. Před každým testem otevře transakci a po něm ji vrátí zpět. Testovací kód se přitom nemění.
Zapíná se jako rozšíření PHPUnitu v konfiguračním souboru.
Háček mají MySQL a MariaDB. Příkazy, které mění schéma, třeba ALTER TABLE, transakci implicitně commitnou. Rollback pak spadne na chybějícím savepointu, a schéma se proto připravuje před během testů.
Krátký odhad. Rozšíření je v konfiguraci PHPUnitu zapsané. Testy napoprvé projdou, podruhé padají na duplicitním e-mailu. Co chybí?
Registrace bundlu v souboru bundles. Flex recept leží v contrib repozitáři a bez potvrzení se nespustí. Rozšíření sice nastartuje, ale nic nevrací zpět.
Ještě drobnost. Testovací kontejner vydá i privátní služby, ale jen ty, které kompilace neodstranila.
Test si proto repozitář zveřejní v konfiguraci pro prostředí test. Blok defaults tam být musí, protože se mezi soubory nedědí.
Funkční testy a asynchronní zprávy
O patro výš stojí funkční test. Request projde kontrolerem, aplikační vrstvou i databází a test kontroluje status, tělo a hlavičky.
Tenhle pošle stejnou registraci dvakrát. Poprvé čeká dvě stě jedna, podruhé konflikt čtyři sta devět.
Aserce frameworku, tady assertResponseStatusCodeSame, mají proti holému assertSame výhodu. Při selhání vypíšou i odpověď, takže se ladí bez dumpu.
Funkční testy jsou nejpomalejší a nejkřehčí, a pokrývají proto jen hlavní scénář a nejdůležitější chybové cesty. Validace zůstává unit testům.
Registrace ale spouští ještě asynchronní krok. Posluchač UserRegistered pošle příkaz SendWelcomeEmail a ten míří na transport async commands.
Tok se tím dělí na dvě poloviny, odeslání a zpracování workerem. Test pokryje každou zvlášť.
Pro první polovinu stačí v prostředí test přepsat DSN transportu na in-memory. Zprávy nikam neodcházejí a zůstanou v paměti procesu.
Test si transport vezme z kontejneru a přes getSent zjistí, co odešlo. Uklízet nemusí. Framework in-memory transporty po každém testu resetuje sám.
Druhou polovinu obslouží balíček Zenstruck Messenger Test. Trait InteractsWithMessenger zpřístupní frontu a metoda process ji zpracuje přímo v testu, bez workera.
Balíček má vlastní transport s DSN test. Transport má v prostředí jediné DSN, takže jde použít jen jednu z nich.
Idempotence handleru a test outboxu
Asynchronní transport doručuje at least once. Po pádu workera dorazí tatáž zpráva znovu, a handler proto smí vyvolat jen jeden efekt.
Deduplikaci obstarává Idempotent Inbox z dílu patnáct bé. Test je krátký. Zavolá handler dvakrát se stejnou zprávou a spočítá odeslané e-maily.
Mailer je tu spy a inbox fake v paměti. Očekává se jediný e-mail.
Outbox zaručuje dvě věci a každá má vlastní integrační test. První kontroluje, že po flushi leží událost v outbox tabulce, zapsaná ve stejné transakci jako agregát.
Druhý test spustí relay přes CommandTester. Limit jedna sekunda je nutný, jinak by smyčka relaye běžela celou výchozí hodinu.
Relay posílá na async events, v testu tedy na in-memory transport. Test končí dvojicí asercí. Zpráva odešla a čekajících záznamů je nula.
Krátký odhad. K čemu je ta druhá aserce? Relay zprávu publikoval, ale neoznačil ji jako odeslanou. Co se stane při dalším běhu?
Pošle ji znovu. Záznam zůstal pending a relay ho vezme v příští dávce. Test s jedinou asercí by tuhle chybu nepoznal.
Architektonické testy
Pravidlo, že doména nezávisí na infrastruktuře, drží do prvního uspěchaného review. Pak někdo do entity natáhne repozitář z Infrastructure.
Architektonický test popíše pravidla deklarativně a porušení shodí build v CI. Nástroje znáte z dílu osm bé, teď k nastavení Deptracu.
Pozor na jméno balíčku, podle něj se hledá dokumentace. Balíček qossmic deptrac je na Packagistu označený jako opuštěný a nahradil ho deptrac deptrac. Řada čtyři drží konfiguraci v PHP souboru a příkaz init generuje právě ten.
Konfigurace popisuje vrstvy a pravidla mezi nimi. Každou vrstvu sbírá regulární výraz nad cestou k souboru.
U domény je v něm negativní lookahead. Obecný výraz by pohltil i doménu ve SharedKernel a Deptrac by tytéž třídy hlásil ve dvou vrstvách.
Pravidla pak skládají mapu. Doména smí jen na sdílený kernel. Aplikace stojí na doméně a infrastruktura implementuje doménová rozhraní.
Když entita User sáhne na DoctrineUserRepository, analýza vypíše porušení a build spadne.
Krátký odhad. Kontroler smí podle konfigurace sahat i na doménovou vrstvu, nejen na aplikační. Proč?
Kvůli doménovým výjimkám. Kontroler je chytá a překládá na HTTP status, třeba duplicitní e-mail na čtyři sta devět.
Do starého projektu se pravidlo dostane přes baseline, jako v dílu osm bé. Formátor baseline zapíše současná porušení do souboru a konfigurace ho načte. Nová porušení pak padají.
PHPArkitect pracuje o úroveň níž, pravidla píše nad jednotlivými třídami. Oba nástroje mají vlastní CLI a v pipeline běží jako samostatný krok.
Kdo píše testy v Pestu, má třetí cestu. Funkce arch zapíše totéž pravidlo přímo v testové sadě.
Code coverage a mutation testing
Code coverage měří, kolik řádků se při testech provede. O kvalitě testů neříká nic. Sto procent jde nasbírat i testy, které metody jen volají a nic nekontrolují.
Užitečná je obráceně. Kde je pokrytí nízké, leží netestovaný kód. A sleduje se trend. Když pokrytí domény mezi sprinty klesne, přibylo v ní něco bez testu.
Cílové procento kniha nedoporučuje, žádný kanonický zdroj ho nestanovuje.
Jestli by si test změny vůbec všiml, zjistí mutation testing. V PHP ho obstará Infection. Do kódu zanese drobnou změnu, třeba posune mez, a pustí testy.
Modelová metoda objednávky. Doprava je zdarma od tisíce korun. Testy zkoušejí patnáct set a pět set korun a řádek má plné pokrytí.
Krátký odhad. Infection v tom řádku posune mez. Poznají to testy?
Nepoznají. Mutace změní větší nebo rovno na větší než, testy zůstanou zelené a mutant přežije. Chybí test přesně na hranici tisíc korun.
Nejvíc se mutation testing vyplatí nad doménou, kde je logika hustá a testy rychlé. Nad infrastrukturou běh trvá dlouho a nálezy bývají technické.
Konfigurace PHPUnitu nakonec skládá testy do čtyř sad.
Past je v testu, který do žádné z nich nespadne. PHPUnit ho mlčky vynechá a CI zůstane zelené. Kontrola je prostá. Pustíte PHPUnit bez argumentu a pak nad adresářem tests. Počet testů musí sedět.
Otázky a shrnutí
Otázka na rozmyšlenou. Poslední test v kapitole volá po save metodu findByEmail a dostane null. Z úvodu přitom víme, že findById by tentýž objekt vrátil. Proč ten rozdíl?
FindById jde přes find a ten se nejdřív podívá do Identity Map. FindByEmail volá findOneBy, který se ptá databáze. A tam uživatel před flushem ještě není.
A jedna z dílu šestnáct á. Podle čeho v Profileru poznáte N plus jedna?
Podle opakovaných dotazů se stejnou strukturou, které se liší jen parametrem. Totéž jde hlídat asercí v integračním testu, dotazy spočítá middleware z kapitoly o výkonu.
Takže v kostce. Integrační test běží proti skutečné databázi, uklízí po něm rollback a mezi zápisem a čtením volá flush a clear.
Asynchronní tok se testuje ve dvou polovinách a handler na opakované doručení.
Deptrac hlídá závislosti mezi vrstvami a mutation testing ukáže, co coverage nevidí.
Příští díl otevírá migraci z CRUD na DDD. Strangler Fig, datová migrace a Anti-Corruption Layer. Celou kapitolu o testování najdete v knize na ddd-v-symfony.katuscak.cz.