PHP代码覆盖率统计详解

2025-05-29 0 18

一 安装php环境

统计php代码覆盖率

1 需要安装xdebug

安装步骤:

https://www.zzvips.com/article/166892.html

测试环境

  • lnmp 军哥一键包1.3版本
  • php 7.0.7
  • xdebug 2.6

配置步骤

?

1

2

3

4

5

6

7

8
git clone git://github.com/xdebug/xdebug.git

cd xdebug

find / -name phpize

/usr/bin/phpize

find / -name php-config

./configure --enable-xdebug --with-php-config=/usr/local/php/bin/php-config

make

make install

开启扩展

?

1

2

3

4

5

6

7

8

9
find / -name php.ini

vi /usr/local/php/etc/php.ini

添加 extension=xdebug.so

[xdebug]

xdebug.collect_params=on

xdebug.collect_return=on

xdebug.remote_autostart=on

service restart php-fpm

成功验证:①在linux输入php -version,如下:

PHP代码覆盖率统计详解

②访问index.phpphpinfo())

PHP代码覆盖率统计详解

2 安装composer

?

1

2

3
curl -ss https://getcomposer.org/installer | php

php composer.phar --version

composer version 1.6.5 2018-05-04 11:44:59

3 安装phpcov 和 phpunit

此处选了phpunit 6.5.0 和phpcov 4.0.8,编辑composer.json文件(phpcov是根据phpunit自动匹配的,phpphpunit对应关系可百度或看底部)

?

1

2

3

4

5

6

7
#composer.json

{

"name": "root/php-code-coverage",

"require-dev": {

"phpunit/phpunit":"6.5.0",

"phpunit/phpcov": "*"

}

执行命令安装 php composer.phar install

安装完成后校验 如下即可(phpunit和phpcov一定要在这个目录下使用)

?

1

2

3

4

5

6

7

8

9
vendor/bin

[root@mt-jry-01 bin]# ll

lrwxrwxrwx 1 root root 24 jul 13 10:22 phpcov -> ../phpunit/phpcov/phpcov

lrwxrwxrwx 1 root root 26 jul 13 10:21 phpunit -> ../phpunit/phpunit/phpunit

[root@mt-jry-01 bin]# .vendor/bin/phpunit --version

phpunit 6.5.0 by sebastian bergmann and contributors.

[root@mt-jry-01 bin]# .vendor/bin/phpcov --version

phpcov 4.0.5 by sebastian bergmann.

4 编写测试代码

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17
#userinfo.php

<?php

include_once("*****/prepend.php");

$id = $_post["user_id"];

if ($id != 10086){

exit();

}

$userinfo = array(

'username'=>'jason',

'password'=>'123456',

);

$result = array(

'code'=>10000,

'message'=>"success",

'data'=>$userinfo,

);

echo json_encode($result);

?

1

2

3

4

5

6

7
#prepend.php

<?php

require_once dirname(__file__).'/vendor/autoload.php'; # 在composer生成的vender同级目录

use sebastianbergmann\\codecoverage\\codecoverage;

$coverage = new codecoverage;

$coverage->filter()->adddirectorytowhitelist('/var/www/html/userinfo.php'); # 白名单<br>$coverage->filter()->removedirectoryfromwhitelist('/var/www/html/userinfo.php'); # 从白名单中移除文件夹<br>$coverage->filter()->removefilefromwhitelist('/var/www/html/userinfo.php'); # 从白名单中移除文件

?

1

2

3

4

5

6

7

8

9

10

11

12
$coverage->start('<site coverage>');#开始统计

register_shutdown_function('__coverage_stop',$coverage);#注册关闭方法

function __coverage_stop(codecoverage $coverage){

$coverage->stop();#停止统计

$cov = '<?php return unserialize(' . var_export(serialize($coverage), true) . ');';#获取覆盖结果,注意使用了反序列化

//echo $cov;

file_put_contents(dirname(__file__).'/cov/site.' . date('u') .'.'.uniqid(). '.cov', $cov);#将结果写入到文件中

}

若多个域名或者接口请求要在同一个prepend文件里分别统计,在新建$coverage前加if条件即可,如

if(strpos($_server['http_host'],'www.baidu.com') === true){}

5 测试

执行命令

?

1

2
[root@mt-jry-01 html]# curl -d "user_id=10086" "127.0.0.1/userinfo.php"

{"code":10000,"message":"success","data":{"username":"jason","password":"123456"}}

查看prepend.php统计目录cov下

?

1
-rw-r--r-- 1 apache apache 4609 jul 13 14:45 site.1531464305.5b484a71c0a1c.cov

生成xml或者html报告命令如下:

?

1

2
./vendor/bin/phpcov merge --clover cov/coverage.xml cov/ -vvv # 在cov目录下生成xml报告

./vendor/bin/phpcov merge --html="cov/coverage_html" cov/ -vvv # 在cov目录下生成html报告 

6 查看报告结果

PHP代码覆盖率统计详解

8 工程配置

在实际项目中有三种配置方式

  1. php.ini中引入prepend文件:auto_prepend_file = /***/prepend.php (配置后重启php) — 所有php请求均会预加载该文件,文件有错误时影响整个php服务
  2. 在文件入口文件中引入prepend文件:include_once(/www/***/prepend.conf); (一般为index.php) — 效果同3,重新部署清掉配置
  3. 在nginx.conf中引入prepend文件 — 对于该域名的请求会加载该文件(配置后重启nginx)
?

1

2

3

4

5

6

7

8
location ~ .*\\.php?$

{

fastcgi_pass 127.0.0.1:9200;

fastcgi_index index.php;

include common/fastcgi.conf;

fastcgi_param my_env pre;

fastcgi_param php_value 'auto_prepend_file=/www/data/phpcoverage/prepend.php';

}

 

7 问题:

① 开始使用的phpcov 2.0.2 & phpunit 4.8.7 生成的报告数据全为0 – phpunit4 不能支持 php7,对应版本见⑦

② 开始总是报错php fatal error: uncaught error: class 'sebastianbergmann\\codecoverage\\codecoverage' not found in

是因为没有引用vender目录,在prepend.php里加一句require_once dirname(__file__).'/vendor/autoload.php'; 即可

③ 配置nginx

④ 请求域名没有生成site文件:请求权限不够,不能在对应目录下写文件

chmod 777 -r 域名请求是apache权限,如果与cov文件夹权限不一致则不可写入

⑤ 生成覆盖率文件有要统计代码文件,但是命中情况count全为0,有两种可能

a xdebug的collect_param 与collect_return没打开,导致未收集到数据,需要在php.ini里配置

b 如果在php.ini里配置了auto_prepend_file=‘**/prepend.php',则只有用指定目录下的prepend.php文件才能生成覆盖率数据,否则覆盖行全为0

⑥ 将xml报告集成到jenkins

注意:go 和 c++ 的xml报告可以用 cobertura 统计到jenkins展示,php 的要用clover php 插件统计phpcov生成的xml格式cobertura解析不了会报错

phpphpunit 的对应关系https://phpunit.de/supported-versions.html

PHP代码覆盖率统计详解

⑧ 问题:观察每日构建的覆盖率,在代码未更新,用例未更新的前提下,覆盖率降低

  1. 该方式统计代码总行数变化,与之前不一致 — 实际两天的代码完全一致
  2. 同一个文件的覆盖行数不一致,发现会出现同一个分支中,上下行未覆盖,而中间行覆盖 和 空行被覆盖(空白行 绿色,鼠标放置提示 1test covers..)的

原因:猜测是 xdebug 统计抽风,因为 xdebug 负责收集统计代码phpunit phpcov只是汇总整理为可读报告。

解决:暂不能解决,可观察xdebug和phpcoverage官网有类似问题

⑨ jenkins 配置

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23
cur_path=`pwd`

echo ${cur_path}

# 删除历史cov文件,保证覆盖率干净

find /www/data/phpcoverage/admin_cov/ -name "site*" | xargs rm -rf

rm -rf ${cur_path}/reports/*

#在工程入口文件引入 prepend 文件

sed -i '2cinclude_once("/www/data/phpcoverage/prepend.php");' /www/my_project/index.php

# 更新自动化用例并执行用例

source /www/data/project3/venv/bin/activate

git checkout master

git pull

python run.py

# 统计html和xml报告,html更易读,xml更直观反映历史情况

cd /www/data/phpcoverage

./vendor/bin/phpcov merge --clover ${cur_path}/reports/coverage.xml admin_cov/ -vvv

./vendor/bin/phpcov merge --html="${cur_path}/reports/coverage_html" admin_cov/ -vvv

# 从入口文件删除引用

sed -i '2c//' /www/my_project/index.php

https://github.com/sebastianbergmann/phpcov

到此这篇关于php代码覆盖率统计详解的文章就介绍到这了,更多相关php代码覆盖率内容请搜索快网idc以前的文章或继续浏览下面的相关文章希望大家以后多多支持快网idc!

原文链接:https://www.cnblogs.com/zhaoxd07/p/9049707.html

收藏 (0) 打赏

感谢您的支持,我会继续努力的!

打开微信/支付宝扫一扫,即可进行扫码打赏哦,分享从这里开始,精彩与您同在
点赞 (0)

声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。

快网idc优惠网 建站教程 PHP代码覆盖率统计详解 https://www.kuaiidc.com/90830.html

相关文章

发表评论
暂无评论