Upgrade to Pro — share decks privately, control downloads, hide ads and more …

2-15-24 - [SF JUG] - Avoiding pitfalls with mod...

Eric Deandrea
February 15, 2024

2-15-24 - [SF JUG] - Avoiding pitfalls with modern microservices testing

Have you ever wondered why your microservices break in production after all the tests have passed during CI/CD? Have you ever wondered if you’re testing too much or too little? If you want to learn about common pitfalls and how to catch them at build time rather than at runtime, this session is for you!

In this session I’ll share some common battle scars from our experiences in the field. Additionally, I will introduce the testing pyramid and explain why it is important in helping to continuously deploy microservices independently without fear. I will demonstrate, through a test-driven development approach, how the combination of Pact contract testing combined with Quarkus developer joy can help prevent your microservices from breaking in production.

Eric Deandrea

February 15, 2024
Tweet

More Decks by Eric Deandrea

Other Decks in Technology

Transcript

  1. Eric Deandrea Sr. Principal Developer Advocate Red Hat @edeandrea Drawings

    courtesy of Holly Cummins Avoiding common pitfalls with modern microservices testing
  2. #RedHat #SFJUG @edeandrea Disclaimer! I am not a tester. (or

    even test expert) That’s ok– testing is every developer’s job!
  3. @edeandrea #RedHat #SFJUG Netflix microservice architecture Testing with microservices is

    easy! My services are so small! Everything is decoupled! But….. If you only test the points, And not the lines…. Does the thing actually work?
  4. #RedHat #SFJUG @edeandrea “It is all that is left unsaid

    upon which tragedies are built.” - Kreia, Star Wars Knights of the Old Republic II: The Sith Lords
  5. #RedHat #SFJUG @edeandrea “You lied to me. How many other

    lies have I been told by the Council? And how do you know that you even have the truth?” – Anakin Skywalker
  6. #RedHat #SFJUG @edeandrea “Many of the truths that we cling

    to depend on our viewpoint.” — Obi-Wan Kenobi, Return of the Jedi
  7. end-to-end tests unit tests integration tests low effort high realism

    tests with application server test REST endpoints tests with a database
  8. #RedHat #SFJUG @edeandrea our mock our code ✔ tests ✘

    reality our code their actual code Why mocks aren’t enough
  9. @edeandrea #RedHat #SFJUG a mock stormtrooper “Aren’t you a little

    short for a stormtrooper?” – Princess Leia
  10. @edeandrea #RedHat #SFJUG “Will someone get this big walking carpet

    out of my way?” – Princess Leia Demo The limitations of unit tests https://github.com/edeandrea/pact-quarkus-wookie-carpet-demo
  11. @edeandrea #RedHat #SFJUG “Will someone get this big walking carpet

    out of my way?” – Princess Leia Demo The limitations of unit tests https://github.com/edeandrea/pact-quarkus-wookie-carpet-demo
  12. #RedHat #SFJUG @edeandrea ✔ our tests ✔ their tests ✔

    reality our code their code contract test mock functional test A better mock
  13. #RedHat #SFJUG @edeandrea ✔ our tests ✘ their tests ✘

    reality our code their code contract test mock functional test A better mock
  14. #RedHat #SFJUG @edeandrea ✘ our tests ✔ their tests ✘

    reality A better mock our code their code contract test mock functional test
  15. #RedHat #SFJUG @edeandrea contract consumer tests mock declare (Pact) Pact

    file Consumer-driven contract testing Spring Cloud Contract Pact
  16. #RedHat #SFJUG @edeandrea contract consumer tests provider mock declare (Pact)

    contract tests verify Pact file Consumer-driven contract testing Spring Cloud Contract Pact Pact
  17. #RedHat #SFJUG @edeandrea contract consumer tests provider mock declare (Pact)

    contract tests verify Pact file Consumer-driven contract testing ☑ rich semantic testing Spring Cloud Contract Pact Pact
  18. #RedHat #SFJUG @edeandrea contract consumer tests provider mock declare (Pact)

    contract tests verify Pact file Consumer-driven contract testing ☑ rich semantic testing ☑ provider can ‘develop to the contract’ instead of developing speculatively (TDD) Spring Cloud Contract Pact Pact
  19. #RedHat #SFJUG @edeandrea contract consumer tests provider mock declare (Pact)

    contract tests verify Pact file Consumer-driven contract testing ☑ rich semantic testing ☑ provider can ‘develop to the contract’ instead of developing speculatively (TDD) ⛔ existing spec assets cannot be re-purposed Spring Cloud Contract Pact Pact
  20. #RedHat #SFJUG @edeandrea contract consumer tests provider mock declare (Pact)

    contract tests verify Pact file Consumer-driven contract testing ☑ rich semantic testing ☑ provider can ‘develop to the contract’ instead of developing speculatively (TDD) ⛔ existing spec assets cannot be re-purposed ⛔ provider needs to know who consumers are Spring Cloud Contract Pact Pact
  21. #RedHat #SFJUG @edeandrea contract consumer tests provider mock declare (Pact)

    contract tests verify Pact file Consumer-driven contract testing ☑ rich semantic testing ☑ provider can ‘develop to the contract’ instead of developing speculatively (TDD) ⛔ existing spec assets cannot be re-purposed ⛔ provider needs to know who consumers are ⛔ consumers can break provider CI Spring Cloud Contract Pact Pact
  22. #RedHat #SFJUG @edeandrea contract consumer provider OpenAPI Provider-driven contract testing

    generate (OpenAPI snapshot of current implementation) other protocol specs
  23. #RedHat #SFJUG @edeandrea contract consumer provider contract tests verify OpenAPI

    Provider-driven contract testing generate (OpenAPI snapshot of current implementation) other protocol specs Schemathesis Microcks
  24. #RedHat #SFJUG @edeandrea contract consumer tests provider mock contract tests

    verify OpenAPI Provider-driven contract testing generate (OpenAPI snapshot of current implementation) other protocol specs Prism Microcks Schemathesis Microcks
  25. #RedHat #SFJUG @edeandrea contract consumer tests provider mock contract tests

    verify OpenAPI Provider-driven contract testing generate (OpenAPI snapshot of current implementation) other protocol specs ☑ familiar contract format Prism Microcks Schemathesis Microcks
  26. #RedHat #SFJUG @edeandrea contract consumer tests provider mock contract tests

    verify OpenAPI Provider-driven contract testing generate (OpenAPI snapshot of current implementation) other protocol specs ☑ familiar contract format ☑ provider does not need comms with consumers Prism Microcks Schemathesis Microcks
  27. #RedHat #SFJUG @edeandrea contract consumer tests provider mock contract tests

    verify OpenAPI Provider-driven contract testing generate (OpenAPI snapshot of current implementation) other protocol specs ☑ familiar contract format ☑ provider does not need comms with consumers ⛔ provider does not get insight into how API is being used (deprecation is harder) Prism Microcks Schemathesis Microcks
  28. #RedHat #SFJUG @edeandrea contract consumer tests provider mock contract tests

    verify OpenAPI Provider-driven contract testing generate (OpenAPI snapshot of current implementation) other protocol specs ☑ familiar contract format ☑ provider does not need comms with consumers ⛔ provider does not get insight into how API is being used (deprecation is harder) ⛔ spec-based tests lack functional depth Prism Microcks Schemathesis Microcks
  29. #RedHat #SFJUG @edeandrea Is OpenAPI enough? It has the same

    syntax, but the semantics are different.
  30. #RedHat #SFJUG @edeandrea Is OpenAPI enough? It has the same

    syntax, but the semantics are different. It looks the same, but the behaviour is different.
  31. #RedHat #SFJUG @edeandrea Is OpenAPI enough? It has the same

    syntax, but the semantics are different. It looks the same, but the behaviour is different. Looks like a storm trooper. Behaves like Luke. (because it it is Luke)
  32. #RedHat #SFJUG @edeandrea how annoying, the provider is returning 204.

    the contract expects 404, so my test is broken. quarkus will return 204 by default. 204 vs 404 - it’s more about the theory behind REST...if a caller asks for a resource the server doesn't have, it should be a 404 - same way if a user types in an invalid URL into the browser ugh, it’s too late at night to care about REST theory. I’m just going to update the expectations in the test to match reality. what?! why is my other contract test broken now? oh … because what I’m changing is a mock…. Based on a true story….
  33. @edeandrea #RedHat #SFJUG soo … microservices testing is hard limit

    end-to-end testing mocks will not be enough contract testing can rescue you
  34. #RedHat #SFJUG @edeandrea Kubernetes Native Java with Quarkus Deployment Developer

    Joy • Quickly & easily build Kubernetes-Native Java applications • Industry leader in startup time and memory utilization for native and JVM applications • One step native executable generation • Leverage existing Java, Jakarta, MicroProfile, & Spring expertise • Imperative & reactive APIs side-by-side • Live coding with zero config https://www.infoq.com/articles/native-java-quarkus