Solving the Allure Report Issue in Spring Cloud Contract Tests with RestAssured's RQ/RS

Описание: Discover how to successfully log RestAssured request and response details in Allure reports when using Spring Cloud Contract tests, ensuring better visibility and diagnostics.
---
This video is based on the question https://stackoverflow.com/q/65940479/ asked by the user 'Daemon2017' ( https://stackoverflow.com/u/5449454/ ) and on the answer https://stackoverflow.com/a/65952563/ provided by the user 'Daemon2017' ( https://stackoverflow.com/u/5449454/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Can't attach RestAssured's RQ/RS of Spring Cloud Contract's tests to Allure report

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Tackling the Challenge of Logging RestAssured RQ/RS in Allure Reports

If you are working with Spring Cloud Contract tests and want to leverage the power of Allure reports to visualize your test results, you might have run into a tricky issue where request and response logs from RestAssured are not being attached to the Allure report. This article will guide you through resolving this problem step by step.

Understanding the Problem

While integrating Allure2 with Spring Cloud Contract tests, users have reported that the "Overview" tab in the generated reports is blank despite successful test runs. This can be frustrating if you’re keen on having detailed logs for debugging and analysis. The core issue here stems from the fact that Spring Cloud Contract (SCC) does not utilize standard JUnit test executions but runs tests differently, which prevents custom JUnit listeners from being effectively employed.

Analyzing the Initial Approach

Your initial implementation included a custom JUnit listener (JunitListener) designed to log RestAssured's request and response. Here’s a quick overview of how this listener functions:

It captures HTTP request and response through RestAssured filters during the lifecycle of the test methods.

At the end of each test method, it logs this data as attachments to be shown in Allure reports.

However, since Spring Cloud Contract employs SpringBootTest instead of plain JUnit tests, your listener didn’t get invoked, resulting in missing data in the Allure report.

Implementing the Solution

To fix this, a custom Spring Test Execution Listener is required. This listener will hook into the Spring testing lifecycle and ensure that the request and response logs are recorded correctly. Here are the steps to create and implement this solution:

Step 1: Create the Custom Test Execution Listener

Define a new class CustomTestExecutionListener that implements the TestExecutionListener interface. This will allow you to interact with test lifecycle events effectively.

[[See Video to Reveal this Text or Code Snippet]]

Step 2: Register the Listener in Your Test Base Class

You’ll need to add this custom listener to your base test class using the @ TestExecutionListeners annotation. This ensures that your listener is integrated into the test execution lifecycle managed by Spring.

[[See Video to Reveal this Text or Code Snippet]]

Step 3: Verify the Allure Report

After implementing the above listener, run your tests again. You should notice that the Allure report now contains the recorded request and response logs in two separate sections, providing you with enhanced visibility over the API interactions during tests.

Conclusion

By creating a CustomTestExecutionListener, we can effectively log RestAssured's request and response data in Allure reports for Spring Cloud Contract tests. This not only resolves the initial challenge but greatly improves our ability to troubleshoot and understand test behavior.

Now you can leverage Allure's powerful reporting features to get deeper insights into your tests, ensuring that you're always informed about the API interactions occurring in your tests.

If you found this guide helpful, don't hesitate to share it with fellow developers tackling similar issues!