Download to read offline
![Running in Prod
Tests Pass in
Build
Implement
changes
Deployed in
Prod
User
Service
Login
Service
!
✓ ✓ ✓ ✓
✓
{
...
"role": "editor"
}
{
...
"roles": ["publisher","editor"]
}
Running in Prod
✓ ✓](https://image.slidesharecdn.com/testbashmanchestercontracttestinginpractice-191002124453/85/Test-bash-manchester-contract-testing-in-practice-5-320.jpg)
![[docs.pact.io]
PACT Specification
Verification philosophy: Tolerant Reader
Implementation guidelines
Implementations](https://image.slidesharecdn.com/testbashmanchestercontracttestinginpractice-191002124453/85/Test-bash-manchester-contract-testing-in-practice-15-320.jpg)
![User
Service
A
P
I
1. Set Provider State
2. Send Request
3. Verify Response
Interaction Verification Test
INSERT INTO users [...]
GET /users/pierre
Accept: application/json
{
"user": "pierre",
...
}
{
"user": "pierre",
...
}
?](https://image.slidesharecdn.com/testbashmanchestercontracttestinginpractice-191002124453/85/Test-bash-manchester-contract-testing-in-practice-18-320.jpg)
Uploaded byPierre Vincent
[Test bash manchester] contract testing in practice
The document discusses contract testing using Pact, highlighting its importance in ensuring API compatibility between consumer and provider services. It describes practical steps for implementing contract testing, including defining interactions, generating pact files, and verifying responses within a CI/CD pipeline. The workshop also emphasizes collaboration between teams to agree on API designs and manage changes effectively.
More Related Content
Similar to [Test bash manchester] contract testing in practice
![[Test bash NL] Contract testing in practice with Pact](https://cdn.slidesharecdn.com/ss_thumbnails/testbashnlcontracttestinginpracticeworkshop-201015074302-thumbnail.jpg?width=640&height=640&fit=bounds)
![[Test Bash Manchester] Observability and Testing](https://cdn.slidesharecdn.com/ss_thumbnails/testbashmanchesterobservabilityandtesting-191003095825-thumbnail.jpg?width=640&height=640&fit=bounds)
![[RebelCon] Increasing visibility of distributed systems in production](https://cdn.slidesharecdn.com/ss_thumbnails/rebelconincreasingvisibilityofdistributedsystemsinproduction-170619080715-thumbnail.jpg?width=640&height=640&fit=bounds)
[Test bash manchester] contract testing in practice
- 1. @PierreVincent Contract testing in practice withPact October 2nd, 2019 – TestBash Manchester @PierreVincent pvincent.io
- 2. @PierreVincent Pierre Vincent Infra. &Reliability Manager @PierreVincent pvincent.io
- 3. From this... …to this.
- 4. Login Service User Service API GET /users/pierre { "user": "pierre", "name":"Pierre Vincent", "role": "publisher" } 200 OK How do we test this?
- 5. Running in Prod TestsPass in Build Implement changes Deployed in Prod User Service Login Service ! ✓ ✓ ✓ ✓ ✓ { ... "role": "editor" } { ... "roles": ["publisher","editor"] } Running in Prod ✓ ✓
- 6. Maybe we shouldhave tested before deploying to production…? Tested what though?
- 7.
- 8. Contract Login Service User Service API Authentication Team UsersTeam Consumer Provider
- 9. What’s in acontract? Request Headers HTTP MethodAPI Endpoint Query Parameters Request Body Response HeadersStatus Code Response Body e.g. /api/users e.g. POST e.g. ?fields=name e.g. Authorization e.g. Content-Typee.g. 200
- 10. Our running examplefor the workshop Game Service Leaderboard Service APIAPI Play a game Return result & current win-rate Record game result Return updated win-rate Contract
- 11. POST /play { "username": "pierre", "game":"headsOrTails", "choice": "heads" } Game Service API 200 OK Content-Type: application/json; charset=UTF-8 { "won": true, "message": "You won!", "totalPlays": 120, "totalWins": 71, "winRate": 59 }
- 12. Activity 1 Thinking aboutAPI design
- 13. Game Service Leaderboard Service API Record game result: Gameplayed, User playing, Won/Lost Return win-rate: Games played, Games won, Win-Loss Ratio “Consumer” Teams - Document what API you need to send game results “Provider” Teams - Document what API you will implement to receive game results
- 14. Game Service Leaderboard Service API Record game result: Gameplayed, User playing, Won/Lost Return win-rate: Games played, Games won, Win-Loss Ratio “Consumer” & “Provider” Teams - Meet to compare your API designs - Discuss differences and come to agreement on the API interaction - Have you thought of “unhappy” paths? (API errors)
- 15. [docs.pact.io] PACT Specification Verification philosophy:Tolerant Reader Implementation guidelines Implementations
- 16. Login Service User Service A P I Pact Mock Server Authentication Team UsersTeam Pact Consumer Unit Test Define interaction Trigger interaction Generate Pact Pact Provider Test Share Pact Replay interaction Replay & Verify Play & Record
- 17. Consumer Provider Provider State Request Expected Response Login Service UserService Given that user 'pierre' exists Method GET Path /users/pierre Headers Accept: application/json Status 200 Headers Content-Type: application/json Body { "user": "pierre", "name": "Pierre Vincent", "role": "publisher" } Interaction
- 18. User Service A P I 1. Set ProviderState 2. Send Request 3. Verify Response Interaction Verification Test INSERT INTO users [...] GET /users/pierre Accept: application/json { "user": "pierre", ... } { "user": "pierre", ... } ?
- 19. Activity 2 Implementing the APIContract
- 20. RecordScore API (orwrite your own) Game Service Leaderboard Service POST /recordScore { “username”: “anna”, “game”: “headOrTails”, “won”: true } { “gamesPlayed”: 123, “gamesWon”: 55 } Request Response
- 21. API Implement API clientin Consumer - In LeaderboardClient.java: - API endpoint (recordScoreUrl) - Request Body (RecordScoreRequestBody) - Response Body (RecordScoreResponseBody) ./gradlew run Run the service (in game-service dir) curl -X POST -H "Content-Type: application/json" --data '{"username": "pierre", "game":"headsortails", "choice": "tails"}' http://localhost:8080/play Try your API Game Service
- 22. API Creating the Pact -In LeaderboardClientPactTest.java: - Complete the PACT definition (RequestResponsePact) - Update expected response (expectedResponse) - Update expected request (client.recordScore) ./gradlew test Run the pact test (in game-service dir) cat build/pacts/game-service-leaderboard-service.json Find the generated PACT Contract
- 23. Leaderboard Service API Implement the ProviderAPI - In ScoreController.java: - API endpoint (@PostMapping) - Request Body (RecordScoreRequestBody) - Response Body (RecordScoreResponseBody) ./gradlew run Run the service (in leaderboard-service dir) curl -X POST -H "Content-Type: application/json" --data 'YOUR_JSON_PAYLOAD' http://localhost:8081/your/api/endpoint Try your API
- 24. Verifying the pact -Copy the generated PACT file (game/build/pacts/*.json) to the Provider test resources (leaderboard-service/src/test/resources/pacts) - Complete the PACT definition (RequestResponsePact) - Update expected response (expectedResponse) - Update expected request (client.recordScore()) ./gradlew test Run the verification test (in leaderboard-service dir) Contract ✓
- 25.
- 26. Authentication Dev Team Users Dev Team CMS DevTeam Billing Dev Team Pact Broker PACT PACT PACT PACT PACT PACT PACT PACT PACT PACT pactflow.io ✓ ✓ ✓
- 27. Dependency Graphs Living documentation by example ✓Versioning ✓ Tagging ✓ REST Api Build/Deployment Pipeline integration Pact Broker pactflow.io
- 28. Bonus content Pacts inCI/CD Pipelines
- 29. Provider pipeline Implement changesGet Pacts from Broker Replay & Verify Interactions Deploy Service Build Deploy to EU PROD-EU Get Pacts from Broker Replay & Verify Interactions Stop deployment of incompatible Provider Stop introduction of breaking change PROD-US PROD-EU
- 30. Consumer pipeline Implement changes Generate Pacts (Build) PushPacts to Broker Tag Pacts Each Provider verifies Pacts Deploy Service Tag Pacts Build Deploy to EU HEAD Stop deployment of incompatible Consumer HEAD PROD-EU
- 31. @PierreVincent Thank you! Pierre Vincent Infra.& Reliability Manager @PierreVincent pvincent.io