如果你有这样的任务:负责php代码测试
如果你有这样的疑问:我设计的测试用例是否覆盖了本次php代码的修改?
如果你有这样的需求:我知道需要增加case,但是总感觉无地放矢,有些分支走了很多遍,有些分支又好像没有走到。
使用php代码覆盖率工具可以让你hold住php代码,它会动态跟踪php代码的执行,合并并生成整个php项目的代码覆盖率,最终以html的方式展现。以此为依据,我们可以做以下事情:
1.分析新增的php代码是否被覆盖了
2.分析现在php代码覆盖率,评估测试用例的质量,决定是否要增加某些测试用例以提高代码覆盖率
一、安装php代码覆盖率支持工具
php代码覆盖率支持工具依赖于php的xdebug扩展和PHPUnit库,同时还需要自己写一点脚本。工具安装过程如下:
1.安装xdebug。yum服务器上有xdebug的包,所以直接使用命令sudoyuminstallphp-xdebug就可以安装.
2.安装PHPUnit。
a)$wgethttp://pear.php.net/go-pear.phar
b)$phpgo-pear.phar
c)$pearchannel-discoverpear.phpunit.de
d)$pearinstallphpunit/PHPUnit
二、将统计代码注入被测php
代码覆盖率统计的原理是在php开始执行时,调用xdebug提供的函数xdebug_start_code_coverage()来开始统计代码覆盖率,在php处理结束前,调用xdebug_get_code_coverage来获得统计数据。
php处理结束前,最适合的调用处就是register_shutdown_function().
完整的代码如下
1 <?php
2
3 function __xdebug_stop() {
4 $data = xdebug_get_code_coverage(XDEBUG_CC_UNUSED|XDEBUG_CC_DEAD_CODE);
5 xdebug_stop_code_coverage();
6
7 $dir = "/home/a/search/htdocs/app/coverage/logs/";
8 $file = sprintf('%s%s.code_coverage', $dir, uniqid());
9 file_put_contents($file,serialize($data));
10 }
11
12 if (function_exists('xdebug_start_code_coverage')) {
13 xdebug_start_code_coverage(XDEBUG_CC_UNUSED | XDEBUG_CC_DEAD_CODE);
14 register_shutdown_function('__xdebug_stop');
15 }
16
17 require_once("index_old.php");
注意事项:
1)我们可以把原有的index.php移成index_old.php,然后使用这个index.php
2)代码假定代码覆盖率的log放在/home/a/search/htdocs/app/coverage/logs/下,如果需要指定其他路径,则可以在index.php做替换
三、执行测试用例
四、收集代码覆盖率数据并形成html
在步骤二中得到的都是不可读的xdebug输出,它记录了每次http请求后,php代码中,每个文件哪行被调用了,哪行没有被调用。
我们需要有一个脚本来收集所有的xdebug输出文件,合并并转化为可读的html结果。
report.php中有几个路径:
1)xdebug的输出log路径,要与步骤二的输出路径一致,目前是/home/a/search/htdocs/app/coverage/logs/,如果自定义需要自行替换
2)代码覆盖率的xml输出路径:/home/a/search/htdocs/app/coverage/xml.file,如果自定义需要自行替换
3)代码覆盖率的html输出路径:/home/a/search/htdocs/app/coverage/html,如果自定义需要自行替换
运行脚本:$sudo-uadsphpreport.php
经过以上步骤,我们就可以查看html版的代码覆盖率结果了:http://hostname/coverage/html/index.html
demo环境可以查看这里:http://10.232.128.83/coverage/html/index.html