DÍL 17a KAPITOLA 17 · SEKCE 17.01–17.04

Unit testy agregátů a InMemory repozitář v PHP

Testování doménové vrstvy bez Symfony kernelu: testovací pyramida, ice-cream cone a proč poměr vrstev odpovídá množství doménové logiky. PHPUnit 13 s atributy místo anotací, test hodnotového objektu, entity a agregátu. Doménové události přes releaseEvents(), trait s asercemi a given-when-then nad event-sourced agregátem. Test doubles podle Meszarose a Fowlera, InMemory repozitář místo mocku a Test Data Builder pro testovací data.

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

Testy, které hlídají implementaci

Modelová situace. Tým v rozhraní repozitáře přejmenuje metodu save na add. Pravidla registrace se nezmění a IDE upraví všechna volání v kódu.

Testy handleru přesto padají jeden za druhým. Každý mockuje, kterou metodu handler volá, a její název drží v řetězci. Hlídají zkrátka implementační detail místo chování.

Filozofie testování v DDD

Doménová vrstva nezávisí na frameworku ani na databázi. Test ji proto volá přímo z PHPUnitu a Symfony kernel vůbec nebootuje.

Tam, kde unit testy potřebují kontejner, zaplatí bootstrap každý z nich. Bez kernelu je test řádově rychlejší, a doménovou sadu se proto vyplatí pouštět po každé změně.

Rozložení testů popisuje testovací pyramida. Zpopularizoval ji Mike Cohn v knize Succeeding with Agile z roku dva tisíce devět. Základ tvoří unit testy domény a stovky jich proběhnou za sekundu.

Uprostřed leží integrační testy. Ověřují, že třeba Doctrine repozitář správně implementuje doménové rozhraní. Na špičce zůstává pár funkčních testů, které projdou celý use case přes HTTP.

Kolik čeho, to pyramida neříká. Fowler k ní staví protipól, takzvaný ice-cream cone. Je to kornout, ve kterém převažují pomalé testy přes uživatelské rozhraní.

Build se s ním táhne a drobná změna systému rozbije spoustu testů naráz. A v pipeline bez grafického prostředí se takové testy spouštějí těžko.

Pro DDD z toho plyne vodítko. Těžiště sady se řídí tím, kolik má kontext doménové logiky. Ten s bohatým modelem unese širokou základnu unit testů.

Krátký odhad. Jiný kontext jen překládá HTTP požadavky na dotazy do databáze. Kde bude mít těžiště testů?

V integračních testech. Logiky, kterou by šlo testovat izolovaně, má málo, a záruku proto nesou testy proti databázi.

Na stejné úvaze staví Kent C. Dodds svou Testing Trophy, psanou pro JavaScript.

Unit testy doménové vrstvy

Ukázky v kapitole počítají s PHPUnitem třináct a PHP 8.4. Na verzi tu záleží víc než obvykle. PHPUnit dvanáct totiž odstranil metadata v dokumentačních komentářích.

Test převzatý z návodu pro PHPUnit devět vypadá třeba takhle. Data provider je zapsaný anotací nad metodou.

Krátký odhad. Co s ním udělá PHPUnit třináct?

Anotaci přečte jako obyčejný komentář. Metoda nedostane argument a test skončí chybou. To je ještě ta lepší varianta.

Záludnější je anotace, která metodu označuje za test. Když jméno metody nezačíná slovem test, PHPUnit ji tiše přestane spouštět a nikdo si toho nevšimne.

Metadata se dnes zapisují atributy, tady DataProvider nad metodou. Samotný provider musí být veřejný a statický, a to už od PHPUnit jedenáct.

Klíče v provideru se vyplatí pojmenovat. Kdyby Email modelově pustil adresu bez domény, výstup řekne rovnou, který případ spadl.

Na jeden nebo dva vstupy stačí TestWith přímo nad metodou. Samostatný provider se vyplatí od tří případů výš.

Hodnotový objekt test prověří ve třech bodech. Neplatný vstup vyhodí výjimku, rovnost se ověří přes equals a objekt se nemění.

Normalizaci přitom testuje továrna fromUserInput. Konstruktor jen validuje.

U entity test volá veřejné metody a výsledek čte zase přes ně. Když sahá reflexí na privátní vlastnost, sleduje implementaci místo chování.

Agregát přidává invarianty, které platí po každé operaci. Potvrdit jde jen rozpracovanou objednávku.

Příprava objednávku založí, přidá položku a potvrdí ji. Pak test ohlásí očekávanou výjimku a teprve potom zavolá confirm podruhé.

Pořadí tu není náhoda. Očekávání výjimky musí padnout před voláním, které ji hodí.

A invariant ze stěny z dílu čtyři á tak skončil jako jeden test s výmluvným jménem.

Testování doménových událostí

Doménovými událostmi agregát mluví se zbytkem systému. Test proto kontroluje, co agregát po operaci vydal. Typ události, její data a pořadí.

Event dispatcher ani bus k tomu nepotřebuje. Agregát sbírá události v privátním poli a releaseEvents je vydá. Kapitola tomu říká Record and Verify Events.

Test pořadí vypadá takhle. Objednávka vznikne, dostane položku a potvrdí se. Pak přijde kontrola počtu a tři aserce na typ, pro každou událost jedna.

Stejná kontrola se opakuje v mnoha testech, a kapitola ji proto vytahuje do traitu DomainEventAssertions. Ze čtyř řádků zbude jedno volání. Události trait typuje jako object, protože record žádného společného předka nevyžaduje.

Jinak se píše test event-sourced agregátu z dílu třináct á. Jeho stav vzniká z historie. Given je proto stream událostí, when volání doménové metody a then události nahrané právě touto operací.

Rekonstrukce stav aplikuje, ale nic nenahrává, takže aserce se týká jen toho, co přidal confirm. Řetězcová ID v ukázce patří event-sourced modelu z třinácté kapitoly.

Krátký odhad. Confirm na objednávce bez položek hodí výjimku. Co má potom vrátit releaseEvents?

Prázdné pole. Neúspěšná operace nesmí nechat v bufferu událost.

Takhle by vypadala chyba. Confirm nahraje OrderConfirmed ještě před kontrolou položek. Výjimka sice letí, jenže událost už v bufferu leží.

Repozitář by ji při nejbližším uložení zapsal do streamu a historie by tvrdila něco, co se nestalo. Oprava přesune nahrání události až za všechny kontroly. A druhý test ve stejné třídě tohle pravidlo hlídá.

Test doubles a InMemory repozitáře

Náhradě skutečné závislosti v testu se obecně říká test double. Pět typů popsal Gerard Meszaros v knize xUnit Test Patterns z roku dva tisíce sedm. Do širšího povědomí je dostal Fowler článkem Mocks Aren't Stubs.

S PHPUnitem se potkáte hlavně se čtyřmi. Stub vrací předpřipravené odpovědi. Mock navíc ověřuje, že se metoda zavolala s danými argumenty.

Spy volání zaznamená a kontroluje se až po akci. A fake je zjednodušená, ale funkční implementace rozhraní, typicky v paměti.

Fowler odlišuje state verification, tedy kontrolu stavu po akci, a behavior verification, kontrolu proběhlých volání. Na té druhé trvá jedině mock.

Zpátky k testu z úvodu. Mock vystřídá InMemory repozitář a konfigurace očekávání zmizí. Test pak ověří data. Repozitář drží jednoho uživatele a najde ho podle e-mailu.

Přejmenování metody teď test nerozbije. Fake rozhraní implementuje, takže IDE přejmenuje metodu i v něm.

Samotný fake je pár řádků. Uživatele drží v poli a metoda save navíc napodobí unikátní index na e-mailu. Duplicitní adresu odmítne výjimkou DuplicateEmailException.

Krátký odhad. Test registrace s tímhle repozitářem projde. Ověřil tím, že dvě souběžné registrace se stejným e-mailem neprojdou?

Neověřil. V produkci hlídá unikátnost databáze a handler překládá UniqueConstraintViolationException na doménovou výjimku. Ten překlad ověří jen integrační test proti skutečné databázi.

Mocky tím z testů nemizí. Patří tam, kde se ověřuje vedlejší efekt, třeba odeslaný e-mail nebo volání externího API.

Zbývají testovací data. Test objednávky opakuje place, addItem i confirm, přitom mu záleží na jediném čísle. Tady na třech kusech.

Test Data Builder od Steva Freemana a Nata Pryce ten šum schová. Každý parametr má bezpečnou výchozí hodnotu a test přepíše jen to, na čem mu záleží.

Když konstruktor dostane další parametr, mění se jediné místo. Builder je ale mutabilní, takže si ho každý test staví znovu.

Starší příbuzný Object Mother vrací hotové fixtury. Fowler mu vyčítá, že se testy navážou na přesná data jedné fixtury.

Otázky a shrnutí

Otázka na rozmyšlenou. Test nejdřív zavolá releaseEvents a výsledek zahodí. Pak přejmenuje uživatele na stejné jméno a čeká nula událostí. Proč to první volání?

Registrace nahrála UserRegistered. Bez vyprázdnění bufferu by aserce na nulu událostí selhala, i kdyby rename nenahrál nic.

A jedna z dílu patnáct bé. Pod jakým klíčem si Idempotent Inbox ukládá zpracovanou zprávu?

Pod dvojicí eventId plus jméno konzumenta. Unikátní index hlídá právě ji a záznam vzniká ve stejné transakci jako efekt.

Takže v kostce. Doménová sada běží bez kernelu, a proto se spouští po každé změně.

Události se testují přes releaseEvents, včetně typu, dat a pořadí.

Repozitář je v testu fake a mocky zůstávají na vedlejší efekty. Testovací data skládá builder.

Příští díl kernel nabootuje. Čekají nás integrační testy s Doctrine, asynchronní toky a architektonické testy. Celou kapitolu najdete v knize na ddd-v-symfony.katuscak.cz.

← Všechny díly videokurzu