PHP test coverage
SonarQube supports the reporting of test coverage information as part of the analysis of your PHP project.
However, SonarQube does not generate the coverage report itself. Instead, you must set up a third-party tool to produce the report as part of your build process. You then need to configure your analysis to tell the SonarScanner where the report is located so that it can pick it up and send it to SonarQube, where it will be displayed on your project dashboard along with the other analysis metrics.
For PHP projects, we recommend PHPUnit for testing and coverage reporting.
To enable coverage, you need to:
- Adjust your build process so that the coverage tool runs before the scanner report generation step runs.
- Make sure that the coverage tool writes its report file to a defined path in the build environment.
- Configure the scanning step of your build so that the scanner picks up the report file from that defined path.
The details of setting up coverage within your build process depend on which tools you are using. In our example below we use:
- Composer, as a package manager
- PHPUnit with Xdebug, to execute the tests
- Clover to do the coverage reporting, and
- GitHub Actions to perform the build.
Simply add the following to your
The resulting file should look something like this:
First, you install all your project dependencies using Composer as a package manager and then invoke PHPUnit with XDebug to run your tests and generate a coverage report file.
The essential requirements are that the tool produces its report in the
clover.xml format and writes it to a place from which the scanner can then pick it up.
The next step is to add
sonar.php.coverage.reportPaths to your analysis parameters. This parameter must be set to the path of the report file produced by your coverage tool. In this example, that path is set to the default. It is set in the
sonar-project.properties file, located in the project root:
As with other analysis parameters,
sonar.php.coverage.reportPaths can be set in multiple places:
- In the
sonar-project.propertiesfile, as mentioned above.
- On the command line of the scanner invocation using the
--defineswitch, for example,
- In the SonarQube interface under Your Project > Project Settings > General Settings > Languages > PHP > PHPUnit for project-level settings, and Administration > Configuration > General Settings > Languages > PHP > PHPUnit for global settings (applying to all projects).