🗓️ October 17, 2023 | 8

Microcks 1.8.0 release 🚀

As the seasons transition, we are excited to unveil the 1.8.0 release of Microcks, the CNCF ’s open-source cloud-native tool for API Mocking and Testing, right on the cusp of winter! ❄️ 🚀

With 47 resolved issues and 5 external PR (from new contributors) - This new release brings you a wave of new features, including AI Copilot, support for HAR artifacts, OAuth2 secured endpoint testing, Microcks super light Uber image, Testcontainers official module, two developer-friendly buttons for easy interactions (Copy as curl command and Add to your CI/CD), and an enhanced contextual help.


Without further ado, let’s review the latest updates for each of our key highlights.

Open to the community!

This new 1.8.0 release is the first one since the project entered the Cloud Native Computing Foundation just before the Summer. As a new Sandbox project, we’ve gone through our onboarding process and worked hard to set the bar high regarding Open Source & Community best practices! As a result, this release of Microcks is the first where the trademark and source code copyright entirely belong to the CNCF.

This trademark update makes the contributions and governance guarantees transparent and aligned with the world’s best practices. Yet another strong confirmation of the Microcks community to drive this fantastic project the open source way! In addition, we introduced with this release:

We’re looking forward to growing our vibrant community as a radically transparent, diverse, inclusive and harassment-free space for collaborating on the future of cloud-native API testing! ☁️

Open to streamlined usages!

This 1.8.0 release also brings its batch of functional improvements to ease your life working in this multi-protocol API ecosystem. Because working with API can happen in a number of situations, workflows and in a rich ecosystem of solutions, we worked hard to have Microcks being relevant and easier to use in those situations.

Introducing AI Copilot

Adding samples to an existing OpenAPI specification or Postman Collection - so that Microcks can handle mocks for you - can sometimes be tedious or boring. Microcks now make life easier, integrating generative AI for this! Simply tap the “AI Copilot” button, and we’ll promptly produce compliant and contextually relevant samples for REST, GraphQL, and AsyncAPI!

This feature leverages OpenAI GPT models API underhood as a first implementation. We designed it to be adaptable and ready for other AI engines in the future. Check this issue for more information.

Support for HAR artifacts

We heard many people capture live traffic to re-inject this data into their OpenAPI or Postman Collection files and reuse them as mock definitions. During this process, they curate the recording list and have to develop/automate the transformation of their captured data to other formats. We want to ease their pain and propose a more straightforward way using HTTP Archive Format (HAR) .

Lots of proxy tooling already use this format as an export format (mitmproxy, Chromium-based browsers, Postman, Insomnia, Proxyman, Fiddler, Gatling, Selenium, GitLab HAR recorder, etc.), so it is easy to integrate with most existing recording solutions.

That way, we think we’ve got Linux philosophy as it’s best, supporting the following flow:

  1. Let specialized tooling do the capture/recording and exporting of traffic using HAR format.
  2. Optionally curate the recorded content to remove noise and inappropriate data
  3. Integrate the resulting HAR into Microcks to reuse the captures as mock sources.

Using HAR in Microcks as a primary or secondary artifact is pretty straightforward. You only have to add a specific comment to your file to tell Microcks the name and version of the API it relates to. Check our documentation .

Test OAuth2 secured endpoints

Testing a secured API endpoint can be tedious as it often involves retrieving and managing an access token for the target endpoint. Luckily, if you secure your API endpoint using OAuth2, Microcks can now handle this burden!

We’ve introduced the support of OAuth2 Client Credentials Flow , Refresh Token Rotation and Resource Owner Password Flow so that you have to provide your OAuth client information to Microcks, and it will handle the authorization flow for you - taking care of transmitting the retrieved token to your API or services under test.

This feature is now enabled via the Microcks UI, API, command line tool microcks-cli, and the different CI/CD integration. Check our documentation .

User experience enhancements

A simple button can bring considerable usability improvement! We scratched our heads and delivered four noticeable enhancements to Microcks’ UI:

  • We now have a “Copy as curl command” button to ease playing with mocks,
  • We added an “Add to your CI/CD” button that generates the code to paste into your CI/CD pipeline. It works for GitHub Actions, GitLab CI, Jenkins pipelines, Tekton pipelines and our own CLI,
  • We added contextual help when launching a new test from the Microcks UI. It’s now way easier to figure out the correct syntax for AsyncAPI or to set the suitable security options,
  • We augmented and curated the online “Help Box” which displays help on the most common features.

See those features in action in the screenshots below. Click on screenshots to access the whole image and get details.

Open to Shift-Left eXperiences!

We’ve been looking at integrating Microcks into Inner Loop of Shift-Left scenarios for a long time. Fast bootstrap time and very light weight are critical to achieve this and provide a smooth developer’s experience. Unfortunately, we were not able to do that with previous versions of Microcks.

Welcome Uber image

Things have changed this Summer, and we’re pleased to announce a new dedicated container image called microcks-uber! microcks-uber can be considered a stripped-down distribution of Microcks, following the same lifecycle but providing the essential services in a single container. How to run microcks-uber? It is as simple as running this command line:

docker run -p 8585:8080 -it

Putting together this new container image has also brought a lot of enhancement to regular Microcks container images. We have some wonderful achievements out there:

  • We decreased the size of the image by 30MB (that’s close to 12%)
  • We reduced the number of CVEs by 18 (that’s close to 35%)
  • The startup time of the container is now 2.2 sec instead of 2.7 sec on my machine (that’s close to 20%)
  • The memory consumption has also decreased as we’re loading way fewer classes in Heap and Metaspace

As the Uber distribution of Microcks is perfectly well-adapted for a quick evaluation, we don’t recommend running it in production! It doesn’t embed the authorization/authentication features provided by Keycloak and the performance guarantees offered by an external MongoDB instance. The original purpose of this Uber distribution is for use with testing libraries like Testcontainers .

Welcome Testcontainers 🧊

A direct illustration of the benefits of microcks-uber is its usage from the trendy Testcontainers library! Microcks now provides official modules for Testcontainers via a partnership with AtomicJar , the company behind this fantastic library! You can find information on the official module on Testcontainers Microcks page .

How does it feel to use Microcks from Testcontainers? Well, it is pretty straightforward! From your unit tests, you have to start a `MicrocksContainer, and you have a ready-to-use ephemeral instance of Microcks for mocking your dependencies or contract-testing your API:

const microcks = await new MicrocksContainer().start();

As of today, we provide support for the following languages:

  • Java ☕️ - See our GitHub repository - See our demo application for Spring Boot 🍃 and for Quarkus .
  • NodeJS - See our GitHub repository
  • Go is coming soon, and we will be happy to have community contributions for Python and other libraries 😎 You want to become a Microcks maintainer? Just join us on GitHub 🙌

Open to contributions!

Community contributions are essential to us and do not come only from feature requests, bug issues, and open discussions. What a pleasure to see people relaying our messages, integrating Microcks in a demonstration, inviting us to events, or even talking about Microcks!

We’d like to thank the following awesome people:

What’s coming next?

As usual, we will eagerly to prioritize items according to community feedback.You can check and collaborate via our list of issues on GitHub and the project roadmap

Remember that we are an open community, which means you, too, can jump on board to make Microcks even greater! Come and say hi! on our GitHub discussion or Discord chat 🐙, send some love through GitHub stars ⭐️ or follow us on Twitter , Mastodon , LinkedIn and our YouTube channel !

Thanks for reading and supporting us! ❤️

Laurent Broudoux

Laurent Broudoux

Co-founder of Microcks | Director of Engineering at Postman Open Technologies

comments powered by Disqus