Скачать или смотреть How to Extract Test Coverage from Docker Containers in GitLab-CI

A step-by-step guide to retrieve Java application test coverage from Docker in GitLab-CI after running an ApiTestSuite.
---
This video is based on the question https://stackoverflow.com/q/65923115/ asked by the user 'Mr. Skip' ( https://stackoverflow.com/u/5605525/ ) and on the answer https://stackoverflow.com/a/66142767/ provided by the user 'Mr. Skip' ( https://stackoverflow.com/u/5605525/ ) 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: Extract test coverage from the docker container in GitLab-CI

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.
---
How to Extract Test Coverage from Docker Containers in GitLab-CI

In the world of software development, ensuring that your code is tested adequately is crucial. If you're working with GitLab-CI and running a Java application inside a Docker container, you might be wondering how to retrieve the test coverage information once your tests are complete. Specifically, if you're running an ApiTestSuite, this post will walk you through the steps needed to extract the code coverage metrics from your application.

Problem Overview

You might be able to fetch code coverage while running your unit tests, but retrieving it after running tests in a Dockerized environment adds a layer of complexity. The main challenge is understanding how to configure your application to ensure that test coverage results are captured and then exported for analysis.

To illustrate the setup, consider the following simplified GitLab job configuration:

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

Let's dive into the solution!

Step-by-Step Solution

1. Enable JaCoCo Agent

To begin with, you need to tell Java to use the JaCoCo Agent when running your application inside the Docker container. This agent will help collect coverage data.

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

2. Configure the JaCoCo Agent

Next, ensure that the JaCoCo Agent writes the coverage results to a specific folder within the Docker container.

Replace folder_inside_container with a directory name that you plan to share with the host machine in your GitLab CI setup.

3. Share the Coverage Folder

Once the JaCoCo Agent is configured, you need to ensure the folder containing the coverage data is shared between the container and the host (GitLab job).

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

Here, gitlab_folder refers to a directory on your host that will allow you to access the coverage data later.

4. Export Coverage Results

After your tests complete, you will need to convert the coverage .exec file into a more readable HTML format using the JaCoCo CLI. The command looks like this:

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

Make sure to replace path_to_app_compiled_classes with the actual path to your compiled class files.

5. Display Coverage in GitLab

Finally, you can grab the coverage metrics from the generated HTML file and display them in your GitLab CI job. Here’s an example of how to set up another job in your .gitlab-ci.yml to do just that:

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

In this job:

We install the necessary JaCoCo CLI.

Generate the HTML report.

Use grep to extract the coverage percentage directly from the generated HTML.

Conclusion

By following these clear and organized steps, you'll be able to extract test coverage from your Java application running inside a Docker container during your GitLab-CI jobs. Automating this process helps ensure that your development efforts maintain the code quality you desire.

Want to take your CI/CD pipeline to the next level? Implement these strategies to effectively keep track of your application's health!