PHP代碼覆蓋率統(tǒng)計(jì)詳解
一 安裝php環(huán)境
二 統(tǒng)計(jì)php代碼覆蓋率
1 需要安裝xdebug
安裝步驟:
//www.dbjr.com.cn/article/116419.htm
測試環(huán)境
- 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
開啟擴(kuò)展
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
成功驗(yàn)證:①在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是根據(jù)phpunit自動(dòng)匹配的,php和phpunit對應(yīng)關(guān)系可百度或看底部)
#composer.json { "name": "root/php-code-coverage", "require-dev": { "phpunit/phpunit":"6.5.0", "phpunit/phpcov": "*" }
執(zhí)行命令安裝 php composer.phar install
安裝完成后校驗(yàn) 如下即可(phpunit和phpcov一定要在這個(gè)目錄下使用)
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>');#開始統(tǒng)計(jì) register_shutdown_function('__coverage_stop',$coverage);#注冊關(guān)閉方法 function __coverage_stop(CodeCoverage $coverage){ $coverage->stop();#停止統(tǒng)計(jì) $cov = '<?php return unserialize(' . var_export(serialize($coverage), true) . ');';#獲取覆蓋結(jié)果,注意使用了反序列化 //echo $cov; file_put_contents(dirname(__FILE__).'/cov/site.' . date('U') .'.'.uniqid(). '.cov', $cov);#將結(jié)果寫入到文件中 } 若多個(gè)域名或者接口請求要在同一個(gè)prepend文件里分別統(tǒng)計(jì),在新建$coverage前加if條件即可,如 if(strpos($_SERVER['HTTP_HOST'],'www.baidu.com') === true){}
5 測試
執(zhí)行命令
[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統(tǒng)計(jì)目錄cov下
-rw-r--r-- 1 apache apache 4609 Jul 13 14:45 site.1531464305.5b484a71c0a1c.cov
生成xml或者h(yuǎn)tml報(bào)告命令如下:
./vendor/bin/phpcov merge --clover cov/coverage.xml cov/ -vvv # 在cov目錄下生成xml報(bào)告 ./vendor/bin/phpcov merge --html="cov/coverage_html" cov/ -vvv # 在cov目錄下生成html報(bào)告
6 查看報(bào)告結(jié)果
8 工程配置
在實(shí)際項(xiàng)目中有三種配置方式
- 在php.ini中引入prepend文件:auto_prepend_file = /***/prepend.php (配置后重啟php) --- 所有php請求均會(huì)預(yù)加載該文件,文件有錯(cuò)誤時(shí)影響整個(gè)php服務(wù)
- 在文件入口文件中引入prepend文件:include_once(/www/***/prepend.conf); (一般為index.php) --- 效果同3,重新部署清掉配置
- 在nginx.conf中引入prepend文件 --- 對于該域名的請求會(huì)加載該文件(配置后重啟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 生成的報(bào)告數(shù)據(jù)全為0 - phpunit4 不能支持 php7,對應(yīng)版本見⑦
② 開始總是報(bào)錯(cuò)PHP Fatal error: Uncaught Error: Class 'SebastianBergmann\CodeCoverage\CodeCoverage' not found in
是因?yàn)闆]有引用vender目錄,在prepend.php里加一句require_once dirname(__FILE__).'/vendor/autoload.php'; 即可
③ 配置nginx
④ 請求域名沒有生成site文件:請求權(quán)限不夠,不能在對應(yīng)目錄下寫文件
chmod 777 -R 域名請求是apache權(quán)限,如果與cov文件夾權(quán)限不一致則不可寫入
⑤ 生成覆蓋率文件有要統(tǒng)計(jì)的代碼文件,但是命中情況count全為0,有兩種可能
A xdebug的collect_param 與collect_return沒打開,導(dǎo)致未收集到數(shù)據(jù),需要在php.ini里配置
B 如果在php.ini里配置了auto_prepend_file=‘**/prepend.php',則只有用指定目錄下的prepend.php文件才能生成覆蓋率數(shù)據(jù),否則覆蓋行全為0
⑥ 將xml報(bào)告集成到j(luò)enkins
注意:go 和 c++ 的xml報(bào)告可以用 Cobertura 統(tǒng)計(jì)到j(luò)enkins展示,php 的要用Clover PHP 插件統(tǒng)計(jì),phpcov生成的xml格式Cobertura解析不了會(huì)報(bào)錯(cuò)
⑦ php 和 phpunit 的對應(yīng)關(guān)系https://phpunit.de/supported-versions.html
⑧ 問題:觀察每日構(gòu)建的覆蓋率,在代碼未更新,用例未更新的前提下,覆蓋率降低
- 該方式統(tǒng)計(jì)的代碼總行數(shù)變化,與之前不一致 -- 實(shí)際兩天的代碼完全一致
- 同一個(gè)文件的覆蓋行數(shù)不一致,發(fā)現(xiàn)會(huì)出現(xiàn)同一個(gè)分支中,上下行未覆蓋,而中間行覆蓋 和 空行被覆蓋(空白行 綠色,鼠標(biāo)放置提示 1test covers..)的
原因:猜測是 xdebug 統(tǒng)計(jì)抽風(fēng),因?yàn)?xdebug 負(fù)責(zé)收集統(tǒng)計(jì)代碼,phpunit phpcov只是匯總整理為可讀報(bào)告。
解決:暫不能解決,可觀察xdebug和phpcoverage官網(wǎng)有類似問題
⑨ 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 # 更新自動(dòng)化用例并執(zhí)行用例 source /www/data/project3/venv/bin/activate git checkout master git pull python run.py # 統(tǒng)計(jì)html和xml報(bào)告,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
到此這篇關(guān)于PHP代碼覆蓋率統(tǒng)計(jì)詳解的文章就介紹到這了,更多相關(guān)PHP代碼覆蓋率內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
PHP開發(fā)中常見的安全問題詳解和解決方法(如Sql注入、CSRF、Xss、CC等)
這篇文章主要介紹了PHP開發(fā)中常見的安全問題詳解和解決方法,詳細(xì)介紹了例如Sql注入、CSRF、Xss、CC等攻擊手段的背景知識(shí)以及解決方法,需要的朋友可以參考下2014-04-04Json_encode防止?jié)h字轉(zhuǎn)義成unicode的方法
json_encode通常會(huì)把json中的漢字轉(zhuǎn)義成unicode,但是有些時(shí)候不是我們想要的,下面小編給大家介紹json_encode防止?jié)h字轉(zhuǎn)義成unicode的方法,需要的朋友參考下吧2016-02-02php empty()與isset()區(qū)別的詳細(xì)介紹
本篇文章是對php中empty()與isset()的區(qū)別進(jìn)行了詳細(xì)的分析介紹,需要的朋友參考下2013-06-06PHP正則表達(dá)式 /i, /is, /s, /isU等介紹
PHP正則表達(dá)式 /i, /is, /s, /isU等,都代表著什么意思,你知道嗎?下面為大家詳細(xì)介紹下2014-10-10