Downloaded 20 times
Uploaded byVMware Tanzu
Consumer Driven Contracts like TDD to the API - Olga Maciaszek-Sharma & Marcin Grzejszczak
The document discusses Spring Cloud Contract, focusing on consumer-driven contracts that facilitate cooperation between service producers and consumers. It highlights the importance of stub validity and reusability in integration testing while demonstrating how to implement changes effectively. Additionally, it presents various scenarios and the benefits of using Spring Cloud Contract with tools like YAML and Swagger to streamline API management.
More Related Content
Similar to Consumer Driven Contracts like TDD to the API - Olga Maciaszek-Sharma & Marcin Grzejszczak
Consumer Driven Contracts like TDD to the API - Olga Maciaszek-Sharma & Marcin Grzejszczak
- 1. 1 © 2019Pivotal Consumer Driven Contracts like TDD to the API Olga Maciaszek-Sharma, @olga_maciaszek Marcin Grzejszczak, @mgrzejszczak
- 2. 2 Spring Cloud developerat Pivotal Working mostly on ● Spring Cloud Contract ● Spring Cloud Netflix ● Spring Cloud Gateway About us Twitter: @olga_maciaszek
- 3. 3 Spring Cloud developerat Pivotal Working mostly on ● Spring Cloud Sleuth ● Spring Cloud Contract ● CI / CD About us Twitter: @mgrzejszczak Blog: http://toomuchcoding.com
- 4.
- 5. 5 What we willNOT be talking about?
- 6. 6 ● Schema ● WSDL ●ESB ● XSD ● XSLT What we will NOT be talking about? THE IDEA OF SPRING CLOUD CONTRACT IS NOT TO INTRODUCE UNNECESSARY COUPLING OR REPLICATE OLD MISTAKES
- 7. 7 ● Producer ○ servicethat exposes an API / sends a message ● Consumer ○ service that consumes the API of the producer / listens to a message from the producer ● Contract ○ agreement between producer and consumer how the API / message will look like ● Consumer Driven Contracts ○ approach where the consumer drives the changes of the API of the producer Introduction
- 8. 8 ● Stub validity& reusability in the integration tests ● Nice API creation Introduction What problems are we trying to solve?
- 9.
- 10. 10 Introduction How to writea test for it? HTTP CONSUMER PRODUCER
- 11. 11 Introduction How to writea test for it? HTTP CONSUMER PRODUCER
- 12.
- 13. 13 Introduction A typical scenario WE’REON THE CONSUMER SIDE!! CONSUMER OWNS THE STUB DEFINITIONS
- 14. 14 Introduction Stub validity &reusability
- 15. 15 Introduction Let’s assume thatwe’re introducing a new endpoint... 15
- 16.
- 17. 17 ● I writethe missing code to work with the new URL ● The unit and integration tests pass ● Now we deploy to an environment where real integrations take place... Introduction So now what?
- 18.
- 19. 19 Stubs that wereused in the build phase have nothing to do with the real API!! Introduction What went wrong? HTTP CONSUMER PRODUCER TEST OK HTTP CONSUMER PRODUCER REALITY WAT?!
- 20. 20 Stubs that wereused in the build phase have nothing to do with the real communication!! Introduction Another example with messaging CONSUMERPRODUCER TEST PRODUCER CONSUMER REALITY topic: bar topic: foo topic: bar
- 21. 21 ● Stubs residewith the consumer ● Consumer controls the stubbing process ● How are you sure that the stubs are valid? ● What if other teams want to reuse those stubs? ● How are you sure you’re listening to the proper topic / queue? ● Are you sure you’ll deserialize your message properly? Introduction Stub validity & reusability - typical problems
- 22. 22 ● It’s theconsumer that uses the API ● Consumers should take part in the creation of the API of the producer ● The producer’s API change should be driven by consumers Introduction Nice API creation
- 23. 23 Introduction Nice API creation- no cooperation results
- 24. 24 Introduction Nice API creation- no cooperation results
- 25.
- 26. 26 ● Consumer ○ servicethat gets beer requests ○ has to ask another service if the client can get the beer ● Producer ○ service that checks if the client is old enough to buy beer ● Feature ○ if the user is too young - the beer will not be sold ○ otherwise the beer will be granted Demo What are we going to code?
- 27. 27 Introduction What are wegoing to code? I’m 22 give me a beer CONSUMER PRODUCER THERE YOU GO Can the beer be sold? status: OK, name: marcin
- 28. 28 Introduction What are wegoing to code? I’m 17 give me a beer CONSUMER PRODUCER GET LOST Can the beer be sold? status: NOT_OK, name: marcin
- 29. 29 Demo Who is who? WHITETERMINAL WHITE IDE CONSUMER BLACK TERMINAL BLACK IDE PRODUCER
- 30. 30 Demo Consumer’s offline work Consumer Phase1 Consumer Phase 2 Consumer’s switching to online Producer phase Producer’s implementing the feature
- 31.
- 32.
- 33. 33 Demo PRODUCER CONSUMER PRODUCER CLONE INTERACTION CONSUMER FILES APR Consumer flow 1
- 34.
- 35.
- 36. 36 Demo PRODUCER TAKES OVER THE PR Producerflow WRITES THE MISSING IMPLEMENTATIO N
- 37. 37 Demo PRODUCER TAKES OVER THE PR Producerflow WRITES THE MISSING IMPLEMENTATIO N MERGES TO MASTER CI UPLOADS TO NEXUS / ARTIFACTORY
- 38.
- 39. 39 Demo CONSUMER Consumer flow 2 SWITCHES TOONLINE MODE DOWNLOADS STUBS OF COLLABORATORS DURING BUILD PHASE
- 40.
- 41. 41 I don’t wantto write any scripts!
- 42. 42 Spring Cloud Contractwith YML Don’t worry! You can use Spring Cloud Contract with YML 42
- 43. 43 Spring Cloud Contractwith YML 43
- 44. 44 Spring Cloud Contractwith Swagger If you must… then you can also use Swagger definitions 44
- 45. 45 Spring Cloud Contractwith Rest Docs You can also use Spring Cloud Contract with Rest Docs!! 45
- 46. 46 With Spring CloudContract and Consumer Driven Contracts: ● we’ve created an API that suits the consumer and the producer ● expectations were defined by readable contracts ● expectations were tested against the producer ● producer stubs can be reused by consumers ● starting and setting stubs is fully automated Summary
- 47. 47 Learn More. StayConnected. ▪ Read the docs http://cloud.spring.io/spring-cloud-contract/ ▪ Check the samples https://github.com/spring-cloud-samples/spring-cloud -contract-samples ▪ Talk to us on Gitter https://gitter.im/spring-cloud/spring-cloud-contract Twitter: twitter.com/springcentral YouTube: spring.io/video LinkedIn: spring.io/linkedin Google Plus: spring.io/gplus
- 48.