Code coverage uses generated reports to calculate overall code coverage inside a method, a class, and a file. It also reports on the issues connected with the missing coverage in these entities.
This feature is available under the Ultimate and Ultimate Plus licenses in the following linters:
Code coverage tool
Supported report formats
IntelliJ IDEA Code Coverage Agent is the recommended tool
How it works
For the missing code coverage issues, the predefined threshold in Qodana is currently set to 50%.
Code coverage employs several inspections that are already included in the
qodana.starter default inspection profiles, so you do not need to enable them:
Once the inspection is complete, reports are available in Qodana reports and JetBrains IDEs.
Code coverage calculation
Qodana calculates code coverage based on the number of code lines containing logic with function, method, and class statements being ignored. Here is the snippet containing comments on how it works:
Prepare the project
Configure a code coverage tool. While configuring Jest, note that all files in coverage reports should have the relative paths inside the project. For example, if your codebase files are contained in the
<project-root>/src/directory, then file paths in code coverage reports should be
If you run Qodana locally, use your code coverage tool to generate the code coverage report. Save the report to the directory where Qodana can read it. If you run Qodana in your GitHub pipeline,
configure the workflow as shown in the Run code coverage section.
Run code coverage
Map the directory containing code coverage reports to the
/data/coverage directory and the project token using the
QODANA_TOKEN variable. Here are the Docker and Qodana CLI command samples:
Create the pipeline that will store all code coverage output files in the
<project-root-dir>/.qodana/code-coverage directory. Below is the pipeline configuration example containing the comments:
You can find configuration examples in our GitHub repository.
Create the GitLab CI/CD pipeline that will store all code coverage output files in the
This uses the
QODANA_TOKEN variable to contain the project token. The
--coverage-dir=$CI_PROJECT_DIR/coverage in the
script block runs Qodana with the code coverage directory.
Fresh code is the code contained in a GitHub pull request. Qodana can calculate fresh code coverage and display the results.
Overview code coverage reports
You can find code coverage statistics in the upper-right corner of the Qodana report UI. It also enumerates the inspections that were employed by the feature.
You can overview code coverage reports using IntelliJ IDEA, WebStorm, and PhpStorm IDEs starting from version 2023.2. This feature is available for reports retrieved from Qodana Cloud after linking, or reports from local storage.
Open reports from Qodana Cloud
In your IDE, navigate to.
In thedialog, click .
This will redirect you to the authentication page.
In thedialog, search for the project you would like to link with.
Overview coverage reports in IDE
You can overview locally-based code coverage reports directly in JetBrains IDEs.
In your IDE, navigate toand open the file containing the code coverage report.
In thetool window, you can overview the test coverage report. This report shows the percentage of the code that has been executed or covered by tests.
Overview the report
The IDE highlights the codebase test coverage using color marking. By default, the green color means that a particular line was covered, and the red color means the uncovered line of code.
The report shows coverage for the lines that implement the logic of a method, function, or a class, but not for the function, method, or class declaration. The image below shows that code coverage is not applicable to line 7, while line 8 is not covered.