【PHP】代码覆盖率
一 安装php环境
二 统计php代码覆盖率
1 需要安装xdebug
安装步骤:
http://www.jb51.net/article/116419.htm
测试环境
- 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 // 生成configure 文件 find / -name php-config . /configure -- enable -xdebug --with-php-config= /usr/local/php/bin/php-config make make install |
注意此处./configure 可能会报错,是因为linux 5之后不支持 ( 了,需要转义 \( --- 应该是php版本的问题,可以联系公司运维也可以自己转义下
开启扩展
1
2
3
4
|
find / -name php.ini vi /usr/local/php/etc/php .ini 添加 extension=xdebug.so [Xdebug] zend_extension="/usr/local/php7/lib/php/20170718/xdebug.so" service restart php-fpm 注意:xdebug 2->3 参数有变更,具体见 https://xdebug.org/docs/upgrade_guide#changed-xdebug.collect_params
xdebug.collect_return=on
xdebug.mode=coverage xdebug.start_with_request=yes
|
成功验证:①在linux输入php -version,如下:
② 访问index.php(phpinfo())
2 安装composer
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自动匹配的,php和phpunit对应关系可百度或看底部)
#composer.json { "name": "root/php-code-coverage", "require-dev": { "phpunit/phpunit":"6.5.0", "phpunit/phpcov": "*" }
执行命令安装 php composer.phar install
安装完成后校验 如下即可(phpunit和phpcov一定要在这个目录下使用)
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 编写测试代码
#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);
#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'); # 白名单
$coverage->filter()->removeDirectoryFromWhitelist('/var/www/html/userinfo.php'); # 从白名单中移除文件夹
$coverage->filter()->removeFileFromWhitelist('/var/www/html/userinfo.php'); # 从白名单中移除文件
$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 测试
执行命令(注意要确保 httpd 服务是启动的)
[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下
-rw-r--r-- 1 apache apache 4609 Jul 13 14:45 site.1531464305.5b484a71c0a1c.cov
生成xml或者html报告命令如下:
./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 查看报告结果
8 工程配置
在实际项目中有四种配置方式
- 在php.ini中引入prepend文件:auto_prepend_file = /***/prepend.php (配置后重启php) --- 所有php请求均会预加载该文件,文件有错误时影响整个php服务
- 在文件入口文件中引入prepend文件:include_once(/www/***/prepend.conf); (一般为index.php) --- 效果同3,重新部署清掉配置
- 在 prepend 文件中对指定域名的访问统计对应覆盖率文件 -- 无此种配置,改配置只满足 多个域名需要统计在不同文件夹下覆盖率文件的场景
-
# 此处可打印_SERVER的各个属性 if ($_SERVER['HTTP_HOST']=='mydomain.com'){ $coverage = new CodeCoverage; $coverage->filter()->addDirectoryToWhitelist('/www/****'); $coverage->start('<Site coverage>');#开始统计 register_shutdown_function('__coverage_s',$coverage,$_dir = 'cov');#注册关闭方法 } function __coverage_s(CodeCoverage $coverage,$_dir){ $coverage->stop();#停止统计 $cov = '<?php return unserialize(' . var_export(serialize($coverage), true) . ');';#获取覆盖结果,注意使用了反序列化 file_put_contents(dirname(__FILE__).'/'.$_dir.'/site.' . date('U') .'.'.uniqid(). '.cov', $cov);#将结果写入到文件中 }
-
- 在nginx.conf中引入prepend文件 --- 对于该域名的请求会加载该文件(配置后重启nginx)
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解析不了会报错
⑦ php 和 phpunit 的对应关系 https://phpunit.de/supported-versions.html
⑧ 问题:观察每日构建的覆盖率,在代码未更新,用例未更新的前提下,覆盖率降低
- 该方式统计的代码总行数变化,与之前不一致 -- 实际两天的代码完全一致
- 同一个文件的覆盖行数不一致,发现会出现同一个分支中,上下行未覆盖,而中间行覆盖 和 空行被覆盖(空白行 绿色,鼠标放置提示 1test covers..)的
原因:猜测是 xdebug 统计抽风,因为 xdebug 负责收集统计代码,phpunit phpcov只是汇总整理为可读报告。
解决:暂不能解决,可观察xdebug和phpcoverage官网有类似问题
⑨ jenkins 配置
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
⑩ _SERVER所包含的属性
$_SERVER['PHP_SELF'] #当前正在执行脚本的文件名,与 document root相关。 $_SERVER['argv'] #传递给该脚本的参数。 $_SERVER['argc'] #包含传递给程序的命令行参数的个数(如果运行在命令行模式)。 $_SERVER['GATEWAY_INTERFACE'] #服务器使用的 CGI 规范的版本。例如,“CGI/1.1”。 $_SERVER['SERVER_NAME'] #当前运行脚本所在服务器主机的名称。 $_SERVER['SERVER_SOFTWARE'] #服务器标识的字串,在响应请求时的头部中给出。 $_SERVER['SERVER_PROTOCOL'] #请求页面时通信协议的名称和版本。例如,“HTTP/1.0”。 $_SERVER['REQUEST_METHOD'] #访问页面时的请求方法。例如:“GET”、“HEAD”,“POST”,“PUT”。 $_SERVER['QUERY_STRING'] #查询(query)的字符串。 $_SERVER['DOCUMENT_ROOT'] #当前运行脚本所在的文档根目录。在服务器配置文件中定义。 $_SERVER['HTTP_ACCEPT'] #当前请求的 Accept: 头部的内容。 $_SERVER['HTTP_ACCEPT_CHARSET'] #当前请求的 Accept-Charset: 头部的内容。例如:“iso-8859-1,*,utf-8”。 $_SERVER['HTTP_ACCEPT_ENCODING'] #当前请求的 Accept-Encoding: 头部的内容。例如:“gzip”。 $_SERVER['HTTP_ACCEPT_LANGUAGE']#当前请求的 Accept-Language: 头部的内容。例如:“en”。 $_SERVER['HTTP_CONNECTION'] #当前请求的 Connection: 头部的内容。例如:“Keep-Alive”。 $_SERVER['HTTP_HOST'] #当前请求的 Host: 头部的内容。 $_SERVER['HTTP_REFERER'] #链接到当前页面的前一页面的 URL 地址。 $_SERVER['HTTP_USER_AGENT'] #当前请求的 User_Agent: 头部的内容。 $_SERVER['HTTPS'] — 如果通过https访问,则被设为一个非空的值(on),否则返回off $_SERVER['REMOTE_ADDR'] #正在浏览当前页面用户的 IP 地址。 $_SERVER['REMOTE_HOST'] #正在浏览当前页面用户的主机名。 $_SERVER['REMOTE_PORT'] #用户连接到服务器时所使用的端口。 $_SERVER['SCRIPT_FILENAME'] #当前执行脚本的绝对路径名。 $_SERVER['SERVER_ADMIN'] #管理员信息 $_SERVER['SERVER_PORT'] #服务器所使用的端口 $_SERVER['SERVER_SIGNATURE'] #包含服务器版本和虚拟主机名的字符串。 $_SERVER['PATH_TRANSLATED'] #当前脚本所在文件系统(不是文档根目录)的基本路径。 $_SERVER['SCRIPT_NAME'] #包含当前脚本的路径。这在页面需要指向自己时非常有用。 $_SERVER['REQUEST_URI'] #访问此页面所需的 URI。例如,“/index.html”。 $_SERVER['PHP_AUTH_USER'] #当 PHP 运行在 Apache 模块方式下,并且正在使用 HTTP 认证功能,这个变量便是用户输入的用户名。 $_SERVER['PHP_AUTH_PW'] #当 PHP 运行在 Apache 模块方式下,并且正在使用 HTTP 认证功能,这个变量便是用户输入的密码。 $_SERVER['AUTH_TYPE'] #当 PHP 运行在 Apache 模块方式下,并且正在使用 HTTP 认证功能,这个变量便是认证的类型。
11 更新为 php 7.2; phpunit 8.0.0; phpcov 6.0.1后,出现过autoload.php文件引入报错的场景,追查到如下文件,注释掉就ok了。后续有使用再排查
# file composer/autoload_files.php <?php // autoload_files.php @generated by Composer $vendorDir = dirname(dirname(__FILE__)); $baseDir = dirname($vendorDir); return array( '320cde22f66dd4f5d3fd621d3e88b98f' => $vendorDir . '/symfony/polyfill-ctype/bootstrap.php', # 'a4a119a56e50fbb293281d9a48007e0e' => $vendorDir . '/symfony/polyfill-php80/bootstrap.php', # php8的支持,注释掉 '0d59ee240a4cd96ddbb4ff164fccea4d' => $vendorDir . '/symfony/polyfill-php73/bootstrap.php', '0e6d7bf4a5811bfa5cf40c5ccd6fae6a' => $vendorDir . '/symfony/polyfill-mbstring/bootstrap.php', # '6124b4c8570aa390c21fafd04a26c69f' => $vendorDir . '/myclabs/deep-copy/src/DeepCopy/deep_copy.php', # 注释掉 );
https://github.com/sebastianbergmann/phpcov