PHP单元测试覆盖率分析，并同步至Sonar

O、背景

公司最近在利用Jenkins部署一些持续集成相关的内容。其中就涉及到了Sonar平台、PHP静态扫描/覆盖率、Java静态扫描/覆盖率的内容。
研究了一些细节问题，将关键问题做个简单的总结记录。

一、工具准备

sonar-scanner： sonar的静态扫描器，可以将扫描结果和代码覆盖率数据一起上传至SonarQube。
PHPUnit： PHP语言的单元测试框架。
xdebug： PHPUnit扫描代码覆盖率功能依赖xdebug组件，该组件需要单独安装。

二、设置代码覆盖率扫描白名单

为了让PHPUnit知道哪些源代码文件需要包含在代码覆盖率报告中，必须配置一个白名单文件。

1. 白名单配置文件格式

<!-->指定 "/src" 和 "/src2" 目录下的文件为白名单<-->
<code>
    <filter>
        <whitelist processuncoveredfilesfromwhitelist="true">
            <directory suffix=".php">./src</directory>
        </whitelist>
        <whitelist processuncoveredfilesfromwhitelist="true">
            <directory suffix=".php">./src2</directory>
        </whitelist>
    </filter>
</code>

2. 白名单的加载：

方法一：白名单可以在运行命令中，通过--whitelist参数指定白名单配置文件。
方法二：在项目根目录，将白名单配置文件命名为phpunit.xml，PHPUnit会自动识别该文件。

三、执行代码覆盖率分析

执行命令有多种方式，以下列举两种：

命令一：

phpunit --coverage-html reports src/tests
其中，reports为输出报告的目录，src/tests为单元测试用例的目录。
该命令会输出html格式的覆盖率报告。

命令二：

phpunit --coverage-clover reports/coverage.xml src/tests
其中，reports为输出报告的文件，src/tests为单元测试用例的目录。
该命令会输出xml格式的覆盖率报告，sonar指定需要该格式。

四、执行单元测试，输出xml格式的报告

sonar统计php代码覆盖率还需要Junit格式的单元测试报告。
执行命令如下：
phpunit --log-junit reports/logfile.xml src/test
其中，"reports/logfile.xml"为输出的文件路径，"src/test"为单元测试用例目录。

五、将代码覆盖率文件上传至SonarQube

sonar-scanner是sonar的一个静态扫描器，它会将静态扫描的结果和代码覆盖率数据一起上传至SonarQube。

1. 配置sonar-project.properties

在项目根目录下配置sonar-project.properties文件，文件中配置以下信息：

# 项目在sonarqube上的展示命令，必须唯一
sonar.projectKey=com.sonarqube.demo
sonar.projectName=Standard SQ-Scanner-based
sonar.projectVersion=1.0

# 静态扫描的目录、单元测试目录
sonar.sources=src/main
sonar.tests=src/test

# 指定代码覆盖率报告文件、单元测试结果文件
sonar.php.coverage.reportPath=reports/coverage.xml
sonar.php.tests.reportPath=reports/logfile.xml

2、执行静态扫描

mac下执行sonar-runner，windows下执行sonar-runner.bat命令即可。

六、参考

1、官方文档：Sonar关于PHP代码覆盖率的说明
2、官方文档：PHPUnit命令行参数说明
3、持续集成之代码质量管理-Sonar
4、mac php + xdebug安装