Test coverage parameters
Test coverage reports describe the percentage of your code that has been tested by your test suite during a build.
This differs from test execution reports, which describe which tests within your test suite have been run during a build. For details, see Test Execution Parameters.
Test coverage reports are not generated by SonarCloud itself. They must be generated by an external tool and then imported into SonarCloud by specifying a parameter telling the scanner where to look for the report.
The data is then displayed in your SonarCloud analysis.
Below, you will find language- and tool-specific analysis parameters for importing test coverage reports.
For information on analysis parameters in general, see Analysis Parameters.
Unless otherwise specified, these properties require values that are relative to the project root. Some properties support the following wildcards in paths. The remarks for properties that support wildcards will mention this fact. If wildcards are not noted for a given property, then they are not supported for that property.
Symbol | Meaning |
---|---|
? | a single character |
* | any number of characters |
** | any number of directories |
All languages
sonar.coverageReportPaths
Comma-delimited list of paths to coverage reports in the Generic Test Data format.
Apex
sonar.apex.coverage.reportPath
Path to the test-result-codecoverage.json
report file generated by the apex:test:run
command of the Salesforce CLI. Note, you must have a Salesforce DX project set up and linked to your organization.
C/C++/Objective-C
See C/C++/Objective-C Test Coverage for examples and details.
sonar.cfamily.gcov.reportsPath
Path to the directory containing native *.gcov
reports (not the XML reports generated by gcovr
).
sonar.cfamily.llvm-cov.reportPath
Path to the llvm-cov
report files.
sonar.cfamily.vscoveragexml.reportsPath
Path to the code coverage report files generated by Visual Studio. The path may be absolute or relative to the solution directory. Path wildcards (see above) are supported. Note that the .coverage
report format must be converted to .coveragexml
format using the tool CodeCoverage.exe
tool in order to be imported.
sonar.cfamily.bullseye.reportPath
Path to the report files generated by Bullseye, version >= 8.9.63 (use the covxml
tool)
C#
See .NET Test Coverage for examples and details.
sonar.cs.vscoveragexml.reportsPaths
Comma-delimited list of paths to the coverage reports produced by Visual Studio Code Coverage or the dotnet-coverage
tool. Wildcards are supported.
sonar.cs.dotcover.reportsPaths
Comma-delimited list of paths to the coverage reports produced by dotCover coverage .
sonar.cs.opencover.reportsPaths
Comma-delimited list of paths to the coverage reports produced by OpenCover or Coverlet.
Flex
sonar.flex.cobertura.reportPaths
Path to the Cobertura XML reports. Multiple paths may be comma-delimited. May be absolute or relative to the project base directory.
Go
sonar.go.coverage.reportPaths
Comma-delimited list of paths to coverage report files. Wildcards are supported.
Java/Kotlin/Scala/JVM
See Java Test Coverage for examples and details.
sonar.coverage.jacoco.xmlReportPaths
Comma-delimited list of paths to JaCoCo XML coverage reports. Wildcards are supported.
sonar.jacoco.reportPaths
Deprecated. Use sonar.coverage.jacoco.xmlReportPaths
.
JavaScript/TypeScript
See JavaScript/TypeScript Test Coverage for examples and details.
sonar.javascript.lcov.reportPaths
Comma-delimited list of paths to LCOV coverage report files. Paths may be absolute or relative to the project root.
PHP
See PHP Test Coverage for examples and details.
sonar.php.coverage.reportPaths
Comma-delimited list of paths to Clover XML-format coverage report files. Paths may be absolute or relative to the project root.
Python
See Python Test Coverage for examples and details.
sonar.python.coverage.reportPaths
Comma-delimited list of paths to coverage reports in the Cobertura XML format. Wildcards are supported. Leave unset to use the default (coverage-reports/*coverage-*.xml
).
Ruby
sonar.ruby.coverage.reportPaths
Comma-delimited list of paths to SimpleCov report files generated with the JSON formatter (available from SimpleCov 0.20). For SimpleCov versions before 0.18, you can provide .resultset.json
report files (though we recommend updating to 0.20 and using the JSON formatter). Paths may be absolute or relative to the project root.
Scala
sonar.scala.coverage.reportPaths
Comma-delimited list of paths to scoverage.xml
report files generated by Scoverage.
Swift with Xcode 9.3+
You can use the xccov-to-sonarqube-generic.sh script from the sonar-scanning-examples/swift-coverage project to convert output from Xcode 9.3's xccov
tool to the Generic Test Data format.
Swift with Xcode 7-9.2
sonar.swift.coverage.reportPaths
Comma-delimited list of paths to the report files generated by llvm-cov show
. The path may be absolute or relative to the project root.
VB.NET
See .NET Test Coverage for examples and details.
sonar.vbnet.vscoveragexml.reportsPaths
Comma-delimited list of paths to Visual Studio Code Coverage report files. Multiple paths may be comma-delimited or included via wildcards.
sonar.vbnet.dotcover.reportsPaths
Comma-delimited list of paths to dotCover coverage report files.
sonar.vbnet.opencover.reportsPaths
Comma-delimited list of paths to the coverage report files produced by OpenCover.
Was this page helpful?