Automated Apache Kafka Mocking and Testing with AsyncAPI | Hugo Guerrero, Red Hat
0 likes1,422 views
The document discusses Microcks, an open-source tool for mocking and testing APIs, particularly in event-driven architectures using AsyncAPI and Kafka. It emphasizes the importance of executable specifications, service contracts, and continuous testing to improve API strategies and compliance. The presentation also promotes community engagement and resources for further learning and collaboration in the API space.
Automated Apache Kafka Mocking and Testing with AsyncAPI | Hugo Guerrero, Red Hat
- 1. @MICROCKSIO #KAFKASUMMIT Automated Kafka Mocking and Testing with AsyncAPI Hugo Guerrero / @hguerreroo
- 2. @MICROCKSIO #KAFKASUMMIT Hugo Guerrero Mexican @ MA, USA Twitter: @hguerreroo Event-Driven APIs & Open Source Advocate History, Travel & Food Enthusiast
- 3. @MICROCKSIO #KAFKASUMMIT DE - COUPLE ... INNOVATE ... CONNECT ... AT SCALE !
- 4. #KAFKASUMMIT icons by Made x Made from the Noun Project @MICROCKSIO The importance of CONTRACT and EXAMPLES GENERATED EXAMPLES GENERATED REAL-LIFE BUSINESS EXPECTATIONS EXECUTABLE SPECIFICATIONS MOCKS & TESTS
- 5. @MICROCKSIO #KAFKASUMMIT A new approach on Contracts icons by Made x Made from the Noun Project Service Contract. Development Test & Release Specification Service Contract. Synchronisation points GOAL: DEFINE A PRAGMATIC APPROACH TO MAKE SERVICE CONTRACTS USEFUL FINALLY ;-) THINK EXECUTABLE SPECIFICATION and *DD Syntactic contract Examples Matching rules
- 6. Events everywhere. Why the raise of events-driven API ? Photo by Carol Jeng on Unsplash #KAFKASUMMIT @MICROCKSIO
- 7. #KAFKASUMMIT @MICROCKSIO Kafkaesque Situation ENDPOINT DOCUMENTATION ? DATA FORMAT AND VALIDATION ? INFRASTRUCTURE ACCESS ? PUBLISHERS & CONSUMERS COMPLIANCE ? EVENTS AVAILABILITY ? MIS-UNDERSTANDING SLOW TIME TO MARKET, POOR QUALITY
- 8. @MICROCKSIO #EVENT-HASHTAG SoapUI Project (XML) 5.1+ Postman Collection (JSON) 1.0, 2.x Apicurio (Studio) OpenAPI 3.x OpenAPI (YAML, JSON) 3.x AsyncAPI (YAML, JSON) 2.x SOAP WEB- SERVICES REST APIs Event-driven APIs (Kafka, AMQP, MQTT) For what types of APIs ? icons by Made x Made from the Noun Project
- 9. @MICROCKSIO #KAFKASUMMIT Event-Driven Secret-Weapon An open source initiative that seeks to improve the current state of Event-Driven Architectures. Created to describe Event-driven APIs using MQTT, AMQP, Apache Kafka, ... “Sister” specification to OpenAPI: same base syntax, use JSON Schema or Avro underhood.
- 10. @MICROCKSIO #KAFKASUMMIT Async API Specification Protocol agnostic: ▸ AMQP ▸ MQTT ▸ NATS ▸ HTTP ▸ WebSockets ▸ Kafka ▸ STOMP ▸ JMS Open Source Tooling: ▸ Online playground (playground.asyncapi.org) ▸ Code generators ▸ Documentation generators ▸ Editors ▸ Mocking ▸ Testing
- 11. @MICROCKSIO #KAFKASUMMIT AsyncAPI Anatomy Info: metadata and documentation for this asynchronous API: version, title, description, contact and licensing terms Servers: list of brokers with binding details (URLs and security protocols) Channel Item: destination that will be used by the API to publish or consume events. Destination may be mapped to a topic, queue, address name depending on the protocol binding. Operation: whether the application using the AsyncAPI should subscribe or produce messages. Holds its own descriptive metadata Message: the content-type and structure of message headers and payload. May reference schemas of different types (AsyncAPI, JSON, Avro). May contain examples! Components: Common definitions (schemas, traits, messages) like in OpenAPI v3
- 12. @MICROCKSIO #EVENT-HASHTAG Adding some events... user-registration CRM Email Marketing Synchronous interaction (SOA) Asynchronous interaction (EDA)
- 13. @MICROCKSIO #EVENT-HASHTAG Adding some events... user-registration TOPIC user-registration { "id":"38102178-dbe5-4e81-aa65-8f6df1be4d44", "fullName":"John Doe", "email":"[email protected]", "age":36, "sentAt":"1603786974956", } AsyncAPI 2.0 Contract
- 14. @MICROCKSIO #KAFKASUMMIT Introducing Microcks Open source Kubernetes-native tool for API Mocking and Testing. It provides an enterprise-grade solution to speed up, secure and scale your API strategy for the digital era. Microcks references any types of APIs or microservices contracts and examples.
- 15. @MICROCKSIO #KAFKASUMMIT Microcks Use-cases API Provider API Provider API Consumer Turn specification into live mocks ! Ensure your implementation is compliant with contract
- 16. @MICROCKSIO #EVENT-HASHTAG icons by Made x Made from the Noun Project TECHNICAL BUSINESS SMOKE TESTS SYNTACTIC CONTRACT TESTS BUSINESS EXPECTATIONS TESTS Ensure API endpoint is correctly deployed Ensure API implementation is compliant with Swagger, OpenAPI or WSDL contracts Ensure API implementation correctly respond - with respect to business rules - to invocations Different strategies available. Usable on demand, matching your life cycle. Test strategies 16
- 17. #APIDAYS PARIS 2020 @MICROCKSIO Magic Demo Time Photo by Unsplash
- 18. @MICROCKSIO #KAFKASUMMIT All Kafkas Every N sec. user-signedup-api- 0.1.1-user-signedup Microcks connected broker (mocking topic generated by Microcks) Microcks connected schema registry Any Schema Registry Listen events during test Any Kafka broker user-registration (real application topic) Azure Event Hubs
- 19. EASE COLLABORATION REUSE YOUR ASSETS FOSTER INNOVATION AND RAPID FEEDBACKS CONTINUOUS SIMULATION AND COMPLIANCE VALIDATION SAME TOOLS FOR REST & SOAP AND ASYNC API COMING SOON: A COMMUNITY HUB TO SHARE MOCKS AND TESTS !! Microcks Benefits #EVENT-HASHTAG icons by Made x Made from the Noun Project @MICROCKSIO
- 20. @MICROCKSIO #KAFKASUMMIT More Resources Apache Kafka Mocking and Testing https://microcks.io/blog/apache-kafka-mocking-testing/ Continuous Testing - OpenAPI & AsyncAPI Together https://microcks.io/blog/continuous-testing-all-your-apis/ How Microcks Can Speed-Up Your AsyncAPI Adoption - Part 1 & 2 https://www.asyncapi.com/blog/microcks-asyncapi-part1 https://www.asyncapi.com/blog/microcks-asyncapi-part2 Join the community on Zulip https://microcksio.zulipchat.com
- 21. @MICROCKSIO #KAFKASUMMIT We Need You! Try Microcks (microcks.io) ! Come chat on Zulip microcksio.zulipchat.com Follow us on Twitter @microcksio, Distribute, & if you like it. It’s a 100% Open Source. And if you love it, contribute !
- 22. @MICROCKSIO #KAFKASUMMIT THANK YOU ! Hugo Guerrero Twitter: @hguerreroo https://www.youtube.com/user/hguerreroo https://developers.redhat.com/author/hugo-guerrero