Chcąc zapewnić poprawną współpracę mikroserwisów, wpadamy często w pułapkę testów, którym nie ufamy lub które są zbyt trudne w utrzymaniu. Testy kontraktowe to alternatywne podejście oferujące z jednej strony szybką informację zwrotną a z drugiej strony poziom pewności niedostępny dla testów izolowanych. To nie jedyne korzyści: z ich wykorzystaniem możemy przyspieszyć nasz cykl pracy oraz lepiej zrozumieć, jak połączone są nasze systemy. W trakcie prezentacji zobaczymy minimalny działający przykład napisany w Kotlinie przy użyciu frameworku Pact, prześledzimy, co możemy zyskać w zależności od nakładu pracy oraz spojrzymy szerzej na ekosystem testów kontraktowych, porównując Pact z biblioteką Spring Cloud Contract.

1. Lotny start
z testami
kontraktowymi
Piotr Kubowicz
@pkubowicz

2. ➔ Java/JVM od 2007
➔ kontrybutor pact-jvm
$ whois piotr-kubowicz

4. Planner Supplies
Ile wózków widłowych na
jutrzejsze dostawy?
➔ jutro: 300 jabłek, 45 kg
➔ jutro: 40 butelek wody, 60 kg
➔ pojutrze: 600 marchewek, 36 kg

5. Testy z prawdziwymi
zależnościami
(„testy integracyjne”)

6. Mockowanie zależności
Planner tests
Supplies tests
Planner
Planner
Fake Planner
Supplies
Fake Supplies
Supplies

7. Typowy problem
{
"count": 15,
"status": "CANCELED"
}
{
"count": 15,
"status": "CANCELLED"
}

8. Testy kontraktowe
KontraktPlanner Supplies
wymuszony w automatyczny sposób

9. Terminologia
Planner Supplies
REST
Consumer Provider

10. Jak to działa?

11. Szybkość
Consumer:
220przypadków testowych na minutę
Provider:
2400przypadków testowych na minutę

12. Workflow dla Pacta
➔ Test Consumera
➔ Doprecyzowanie API
➔ Dzielenie się kontraktem
➔ Zaadoptowanie Providera

13. Workflow dla Pacta
Nie trzeba czekać na implementację w Providerze
Można zacząć bez samego Providera

14. Dzielenie się kontraktem
Załącznik do maila i wrzucenie do Gita
Publikacja w repozytorium artefaktów (Maven)
Specjalny serwer Pact Broker

15. Pact Broker

16. Pact Broker

17. Pact Broker

18. Obsługiwane języki
➔ JVM
➔ JS
➔ Ruby
➔ .NET
➔ Go
➔ Swift
➔ PHP

19. Obsługiwane języki
➔ JVM
➔ JS
➔ Ruby
➔ .NET
➔ Go
➔ Swift
➔ PHP
➔ dowolny (dla Providera)

20. Pact po stronie Providera
Pact provider
verifier
Twój Provider
Docker dowolny język

21. Pact po stronie Providera
Planner Shop
Supplies

22. Przypadki użycia testów kontraktowych
➔ zespoły w różnych lokalizacjach
➔ backend-frontend w jednym zespole
➔ kolejki

23. Alternatywne narzędzia
Spring Cloud Contract

24. Consumer test
Contract
Provider test
Provider test
Stubs
Consumer test
Contract

25. Provider test
Stubs
Consumer test
Contract Groovy/Java/Kotlin
Gradle/Maven
JUnit 4/5
Spock
Maven repo
Stub runner
WireMock

26. Provider test
Stubs
Consumer test
Contract YAML
Docker
Maven repo / Git
Docker

27. Kontrakt (Groovy)
org.springframework.cloud.contract.spec.Contract.make {
request {
method 'GET'
url('/supplies') {
queryParameters {
parameter day: '2020-09-14'
}
}
}
response {
status OK()
body([status: "CANCELED"])
headers { contentType('application/json') }
}
}

28. Wygenerowany test
public class ManySuppliesTest extends ContractVerifierBase {
@Test
public void validate_returnsManySupplies() throws Exception {
Response response = given().spec(request)
.queryParam("day","2020-09-14").get("/supplies");
// ...
assertThatJson(parsedJson).array()
.contains("['status']").isEqualTo("CANCELED");

29. Klasa bazowa, którą sami piszemy
abstract class ContractVerifierBase {
@Before
fun startServer() {
RestAssured.port = 9053
MyServer().start(9053)
}

30. Dziwactwa
response {
body([
[status: "CANCELED"],
[count: 4, totalWeight: 20, status: "ACTIVE"],
])
}
[
{"status": "CANCELED"},
{"count": 4, "totalWeight": 20, "status": "ACTIVE"},
{"count": 151, "totalWeight": 980, "status": "ACTIVE"}
]
Akceptuje 3 elementy

31. Dziwactwa
response {
body([
[status: "CANCELED"],
[count: 4, totalWeight: 20, status: "ACTIVE"],
])
}
[
{"count": 4, "totalWeight": 980, "status": "CANCELED"},
{"count": 151, "totalWeight": 20, "status": "ACTIVE"}
]
Akceptuje „na krzyż”

32. Interoperatywność
Spring Cloud Contract potrafi czytać kontrakty Pacta

34. Skąd wziąć czas – mam pracy po uszy
➔ piszę testy na wysyłanie zapytań HTTP
➔ dopytuję drugiego zespołu, jakie dane chcą
➔ myślę o przypadkach brzegowych
➔ testuję zapytania do bazy danych

35. Testy kontraktowe
➔ sprawdzają poprawność zapytań Consumera
➔ dokumentują zapytania i odpowiedzi
➔ współdzielą dane i przypadki testowe
➔ weryfikują pełny stack Providera

36. Dziękuję!

37. Q&A
Piotr Kubowicz
piotr.kubowicz@gmail.com
@pkubowicz
github.com/pkubowicz/contract-testing-samples
http://pact.io
http://cloud.spring.io/spring-cloud-contract/