一 安裝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
?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'); # 白名單br>$coverage->filter()->removeDirectoryFromWhitelist('/var/www/html/userinfo.php'); # 從白名單中移除文件夾br>$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 測試
執行命令
[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?$
{
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
https://github.com/sebastianbergmann/phpcov
到此這篇關于PHP代碼覆蓋率統計詳解的文章就介紹到這了,更多相關PHP代碼覆蓋率內容請搜索腳本之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持腳本之家！
您可能感興趣的文章:- 使用PHPUnit進行單元測試并生成代碼覆蓋率報告的方法
