PHP代码覆盖率统计详解

网络编程 2024/11/18 佚名

3 2 1

一安装php环境

二统计php代码覆盖率

1 需要安装xdebug

安装步骤：

//www.jb51.net/article/116419.htm

测试环境

LNMP 军哥一键包1.3版本
PHP 7.0.7
Xdebug 2.6

配置步骤

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

开启扩展

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，如下：

②访问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
<"*****/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
<"htmlcode">

$coverage->start('<Site coverage>');#开始统计
register_shutdown_function('__coverage_stop',$coverage);#注册关闭方法
 
function __coverage_stop(CodeCoverage $coverage){
 $coverage->stop();#停止统计
 $cov = '<"color: #ff0000">5 测试
执行命令


[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，重新部署清掉配置
  在nginx.conf中引入prepend文件 --- 对于该域名的请求会加载该文件（配置后重启nginx）



location ~ .*\.php"external nofollow" target="_blank" href="https://phpunit.de/supported-versions.html">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


https://github.com/sebastianbergmann/phpcov

                                
                                
                                    PHP代码覆盖率,覆盖率统计 
                                
                                    标签：
                                        PHP代码覆盖率,覆盖率统计