De reținut
- Un contract surprinde de ce are nevoie de fapt un consumator de la un furnizor: cereri, răspunsuri și forma mesajelor. Fiecare parte e testată independent față de el, fără un mediu comun.
- În testarea de contract condusă de consumator (de exemplu cu Pact), testele consumatorilor generează contractul; furnizorii îl verifică în propriile pipeline-uri. Un broker stochează contractele și rezultatele verificărilor pentru fiecare versiune și mediu.
- Câștigul e la întrebarea de deploy: „pot lansa această versiune în producție?”, la care răspunde matricea de verificări, nu o rulare end-to-end lentă.
De unde pornim
Piramida testelor în practică a prezentat contractele conduse de consumator în patru pași. Articolul acesta e despre cum le rulezi pentru multe echipe și servicii: ce pui în contracte, cum le versionezi și cum iei decizii de deploy pe baza lor.
De ce nu scalează mediile end-to-end
Cu 40 de servicii deținute de 12 echipe:
- Un mediu end-to-end comun aproape niciodată nu rulează exact combinația de versiuni care va ajunge în producție.
- Eșecurile sunt greu de atribuit: a cui schimbare a stricat ceva?
- Testele sunt lente și instabile, așa că echipele așteaptă, reîncearcă și până la urmă le ignoră.
Testarea de contract înlocuiește cea mai mare parte din asta cu verificări pe perechi, versionate, care rulează în pipeline-ul obișnuit al fiecărei echipe.
Piesele
| Piesă | Rol |
|---|---|
| Testul consumatorului | Rulează codul real de client al consumatorului față de un furnizor simulat, care înregistrează interacțiunile așteptate de consumator |
| Contractul (fișierul pact) | Interacțiunile înregistrate: cereri, răspunsuri așteptate minime, matcheri |
| Broker-ul | Stochează contractele și rezultatele verificărilor, etichetate cu versiunea, ramura și mediul |
| Verificarea furnizorului | Reia fiecare interacțiune pe furnizorul real, cu datele necesare pregătite prin stări ale furnizorului (provider states) |
| can-i-deploy | Interoghează broker-ul: e această versiune compatibilă cu fiecare versiune instalată în mediul-țintă? |
| Webhook-uri | Când un consumator publică un contract schimbat, declanșează automat verificarea la furnizor |
Ce conține un contract bun
// Testul consumatorului (Pact JS, simplificat)
provider
.given("produsul 42 există") // starea furnizorului
.uponReceiving("o cerere pentru produsul 42")
.withRequest({ method: "GET", path: "/products/42" })
.willRespondWith({
status: 200,
body: {
id: integer(42), // matcheri: tip, nu valoare exactă
name: string("Cafea"),
price: decimal(32.0),
},
});
Reguli:
- Doar ce folosește consumatorul. Dacă acesta citește
id,nameșiprice, contractul nu ar trebui să menționeze celelalte 30 de câmpuri. Așa, furnizorul e liber să le schimbe. - Potrivire după tip și formă, nu după valori exacte, cu excepția cazurilor în care valoarea contează, precum un enum sau un cod de stare.
- Folosește stările furnizorului pentru precondiții („produsul 42 există”, „utilizatorul e suspendat”), ca furnizorul să-și poată pregăti datele în mod determinist.
- Include cazurile de eroare importante: 404 pentru un produs inexistent, 422 pentru date invalide, dacă consumatorul le tratează.
Versionare și siguranța deploy-ului
- Publică contractele și rezultatele verificărilor cu versiunea exactă (de exemplu, commit-ul git) și cu ramura.
- Înregistrează deploy-urile: spune-i broker-ului ce versiune e în ce mediu, la fiecare deploy.
- Condiționează deploy-ul cu can-i-deploy: înainte de deploy, întreabă dacă această versiune e verificată față de tot ce e instalat în acel mediu.
- Protejează furnizorii de așteptările noi: funcții precum contractele pending lasă o așteptare nouă a unui consumator să pice la verificare fără să blocheze build-ul existent al furnizorului, până când furnizorul o implementează.
- Verifică față de versiunile potrivite ale consumatorilor: de obicei, ramura principală și fiecare versiune instalată în producție.
Variante
- Testarea de contract bidirecțională: furnizorul își publică specificația API (de exemplu, OpenAPI), iar broker-ul verifică contractele consumatorilor față de ea, fără ca furnizorul să reia interacțiunile. E mai rapid de adoptat pentru API-urile existente, dar mai slab: presupune că specificația se potrivește cu implementarea.
- Contracte pentru mesaje: aceeași idee pentru evenimentele din cozi și topic-uri. Consumatorul declară ce forme de mesaje poate procesa; producătorul verifică dacă le poate produce.
- Verificări bazate pe scheme: pentru gRPC/Protobuf sau Avro, uneltele de compatibilitate a schemelor din pipeline prind schimbările incompatibile, precum câmpurile eliminate sau renumerotate.
O firmă cu aproximativ 30 de servicii rula noaptea o suită end-to-end într-un mediu de staging comun. Dura în jur de patru ore, pica în majoritatea nopților din cauza mediului și bloca lansările de două ori pe săptămână.
Au introdus contracte conduse de consumator întâi pentru cele mai critice zece integrări: checkout, plăți, prețuri, stocuri și identitate. Fiecare furnizor verifica contractele în propriul pipeline, declanșat prin webhook-uri când se schimba contractul unui consumator. Job-urile de deploy rulau can-i-deploy înaintea fiecărei lansări în producție.
Într-un trimestru, majoritatea defectelor de integrare erau prinse în pull request-uri și atribuite imediat echipei potrivite. Suita end-to-end a fost redusă la o scurtă rulare smoke a parcursurilor critice.
Lecția: testele de contract n-au eliminat nevoia de a testa întregul sistem. Au eliminat nevoia de a testa fiecare integrare prin întregul sistem.
Așa da
Să păstrezi contractele minimale: doar câmpurile și comportamentele pe care consumatorul le folosește efectiv, potrivite după tip, cu stări ale furnizorului pentru pregătirea datelor.
Așa nu
Să copiezi răspunsuri complete din producție în contracte, ca valori exacte. Orice schimbare inofensivă a furnizorului le va strica, iar echipele nu vor mai avea încredere în teste.
Verifică-te
O echipă de furnizor vrea să redenumească câmpul `price` în `amount`. Trei consumatori citesc `price`. Cum o ajută testele de contract și can-i-deploy să facă asta în siguranță?
Arată răspunsul
Verificarea furnizorului va pica față de contractele celor trei consumatori, așa că schimbarea incompatibilă e prinsă înainte de deploy. Drumul sigur e extinde și restrânge (expand and contract): adaugi amount alături de price, consumatorii trec pe noul câmp și publică contracte noi, iar cu can-i-deploy confirmi că nicio versiune instalată a vreunui consumator nu mai are nevoie de price. Abia apoi îl elimini.
