debian-mirror-gitlab/doc/ci/testing/code_coverage.md

stage	group	info
Verify	Pipeline Execution	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments

Code coverage (FREE)

Use code coverage to provide insights on what source code is being validated by a test suite. Code coverage is one of many test metrics that can determine software performance and quality.

View Code Coverage results

Code Coverage results are shown in:

• Merge request widget
• Project repository analytics
• Group repository analytics
• Repository badge

For more information on test coverage visualization in the file diff of the MR, see Test Coverage Visualization.

View code coverage results in the MR

If you use test coverage in your code, you can use a regular expression to find coverage results in the job log. You can then include these results in the merge request in GitLab.

If the pipeline succeeds, the coverage is shown in the merge request widget and in the jobs table. If multiple jobs in the pipeline have coverage reports, they are averaged.

Add test coverage results using coverage keyword

To add test coverage results to a merge request using the project's .gitlab-ci.yml file, provide a regular expression using the coverage keyword.

Test coverage examples

Use this regex for commonly used test tools.

• Simplecov (Ruby). Example: /\(\d+.\d+\%\) covered/.
• pytest-cov (Python). Example: /(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/.
• Scoverage (Scala). Example: /Statement coverage[A-Za-z\.*]\s*:\s*([^%]+)/.
• pest --coverage --colors=never (PHP). Example: /^\s*Cov:\s*\d+\.\d+?%$/.
• phpunit --coverage-text --colors=never (PHP). Example: /^\s*Lines:\s*\d+.\d+\%/.
• gcovr (C/C++). Example: /^TOTAL.*\s+(\d+\%)$/.
• tap --coverage-report=text-summary (NodeJS). Example: /^Statements\s*:\s*([^%]+)/.
• nyc npm test (NodeJS). Example: /All files[^|]*\|[^|]*\s+([\d\.]+)/.
• jest --ci --coverage (NodeJS). Example: /All files[^|]*\|[^|]*\s+([\d\.]+)/.
• excoveralls (Elixir). Example: /\[TOTAL\]\s+(\d+\.\d+)%/.
• mix test --cover (Elixir). Example: /\d+.\d+\%\s+\|\s+Total/.
• JaCoCo (Java/Kotlin). Example: /Total.*?([0-9]{1,3})%/.
• go test -cover (Go). Example: /coverage: \d+.\d+% of statements/.
• .NET (OpenCover). Example: /(Visited Points).*\((.*)\)/.
• .NET (dotnet test line coverage). Example: /Total\s*\|\s*(\d+(?:\.\d+)?)/.
• tarpaulin (Rust). Example: /^\d+.\d+% coverage/.
• Pester (PowerShell). Example: /Covered (\d+\.\d+%)/.

View history of project code coverage

• Introduced the ability to download a .csv in GitLab 12.10.
• Graph introduced in GitLab 13.1.

To see the evolution of your project code coverage over time, you can view a graph or download a CSV file with this data.

1. On the top bar, select Main menu > Projects and find your project.
2. On the left sidebar, select Analytics > Repository.

The historic data for each job is listed in the dropdown list above the graph.

To view a CSV file of the data, select Download raw data (.csv).

View history of group code coverage (PREMIUM)

To see the all the project's code coverage under a group over time, you can find view group repository analytics.

Pipeline badges

You can use pipeline badges to indicate the pipeline status and test coverage of your projects. These badges are determined by the latest successful pipeline.

Coverage check approval rule (PREMIUM)

• Introduced in GitLab 14.0.
• Made configurable in Project Settings in GitLab 14.1.

When merging a request that would cause the project's test coverage to decline, you can stipulate that such merge requests require approval by selected users or a group.

Follow these steps to enable the Coverage-Check MR approval rule:

1. Set up a coverage regular expression for all jobs you want to include in the overall coverage value.
2. Go to your project and select Settings > Merge requests.
3. Under Merge request approvals, select Enable next to the Coverage-Check approval rule.
4. Select the Target branch.
5. Set the number of Approvals required to greater than zero.
6. Select the users or groups to provide approval.
7. Select Add approval rule.

Troubleshooting

Remove color codes from code coverage

Some test coverage tools output with ANSI color codes that aren't parsed correctly by the regular expression. This causes coverage parsing to fail.

Some coverage tools do not provide an option to disable color codes in the output. If so, pipe the output of the coverage tool through a one-line script that strips the color codes.

For example:

lein cloverage | perl -pe 's/\e\[?.*?[\@-~]//g'