Web端測(cè)試PHP代碼函數(shù)覆蓋率的解決方法

這篇文章主要介紹“Web端測(cè)試PHP代碼函數(shù)覆蓋率的解決方法”，在日常操作中，相信很多人在Web端測(cè)試PHP代碼函數(shù)覆蓋率的解決方法問(wèn)題上存在疑惑，小編查閱了各式資料，整理出簡(jiǎn)單好用的操作方法，希望對(duì)大家解答”Web端測(cè)試PHP代碼函數(shù)覆蓋率的解決方法”的疑惑有所幫助！接下來(lái)，請(qǐng)跟著小編一起來(lái)學(xué)習(xí)吧！

1. 關(guān)于代碼覆蓋率

衡量代碼覆蓋率有很多種層次，比如行覆蓋率，函數(shù)/方法覆蓋率，類(lèi)覆蓋率，分支覆蓋率等等。代碼覆蓋率也是衡量測(cè)試質(zhì)量的一個(gè)重要標(biāo)準(zhǔn)，對(duì)于黑盒測(cè)試來(lái)說(shuō)，如果你不確定自己的測(cè)試用例是否真正跑過(guò)了系統(tǒng)里面的每一行代碼，在測(cè)試的完整性上總要打些折扣。因此，業(yè)界幾乎對(duì)各種編程語(yǔ)言都有自己的一套代碼覆蓋率解決方案。世界上最美的語(yǔ)言PHP當(dāng)然也不例外。PHPUnit和Spike PHPCoverage提供了一套基于xdebug的代碼覆蓋率測(cè)試方案。在本文中，我將針對(duì)自己碰到的特定業(yè)務(wù)場(chǎng)景，講述一下自己進(jìn)行PHP代碼函數(shù)覆蓋率測(cè)試的解決方案。

2. 業(yè)務(wù)背景

假設(shè)我們?cè)诰€開(kāi)發(fā)了一個(gè)網(wǎng)站，交給業(yè)務(wù)測(cè)試的同事去進(jìn)行功能測(cè)試。那他們是怎么測(cè)試的呢？通常情況下，無(wú)非是開(kāi)發(fā)人員把網(wǎng)站部署好了，然后測(cè)試人員把網(wǎng)上所有功能都試用一遍，包括一些異常使用情況。對(duì)于業(yè)務(wù)測(cè)試來(lái)說(shuō)，只要我把所有的功能點(diǎn)都測(cè)了，把所有異常使用情況也測(cè)到了，那就完成了。但是對(duì)于開(kāi)發(fā)來(lái)說(shuō)，我比較好奇的是，你是否把我寫(xiě)的所有代碼都跑到了？會(huì)不會(huì)存在一些代碼，只有在很特殊的情況下才能觸發(fā)，而你從來(lái)沒(méi)有測(cè)到過(guò)這些情況？這時(shí)，可能就需要代碼覆蓋率來(lái)出馬了。

其實(shí)我首先想到了xdebug來(lái)測(cè)試覆蓋率，只需要兩三個(gè)函數(shù)即可，如下：

xdebug_start_code_coverage(); //開(kāi)始收集代碼行覆蓋情況
xdebug_get_code_coverage(); //獲取截至目前所跑過(guò)的代碼文件名和行號(hào)
xdebug_stop_code_coverage(); //停止收集代碼行覆蓋情況

xdebug提供的接口可以用于測(cè)試行覆蓋率，這是否能滿足要求呢？其實(shí)，行覆蓋率顆粒度有點(diǎn)細(xì)，實(shí)際項(xiàng)目中，開(kāi)發(fā)人員可能會(huì)對(duì)代碼進(jìn)行微調(diào)。比如，這次測(cè)試，你跑過(guò)了A.php文件的第10行，但是我有一天對(duì)A.php進(jìn)行了微調(diào)，在A.php第9行和第10行之間又加了兩行代碼。于是，原來(lái)的第10行變?yōu)榱说?2行，而xdebug的行覆蓋信息只記錄了行號(hào)……這樣之前的數(shù)據(jù)豈不是不準(zhǔn)確了么。。?？紤]再三，我覺(jué)得函數(shù)覆蓋是個(gè)不錯(cuò)的顆粒度。在相對(duì)成熟的項(xiàng)目中，很少有大規(guī)模函數(shù)變動(dòng)的情況。不過(guò)問(wèn)題是，xdebug并沒(méi)有提供函數(shù)覆蓋的接口。

于是，我們現(xiàn)在碰到的場(chǎng)景是：

【1】希望測(cè)到某次測(cè)試中所覆蓋的所有函數(shù)列表，知道這個(gè)項(xiàng)目總共有多少個(gè)函數(shù)，計(jì)算一下覆蓋率是否足夠高。

【2】測(cè)試完成之后，要生成一份覆蓋率報(bào)告，將代碼的覆蓋情況可視化。

【3】完整測(cè)試的流程如下：

其中插樁的意思是在測(cè)試執(zhí)行之前的一些準(zhǔn)備工作。

3. 函數(shù)覆蓋率解決方案

（1）原理

xdebug天生提供了對(duì)行覆蓋率的支持，我們要自己計(jì)算出函數(shù)覆蓋率。函數(shù)覆蓋率需要兩點(diǎn)數(shù)據(jù)，一個(gè)是哪些函數(shù)被執(zhí)行，一個(gè)是文件中總共有多少個(gè)函數(shù)。

文件中總共的函數(shù)量，由于我們不可能把所有函數(shù)都執(zhí)行一遍，因此這部分只能通過(guò)代碼靜態(tài)掃描來(lái)實(shí)現(xiàn)。如果是在C++或者Java中，可能就需要詞法分析工具了，然而在最美的語(yǔ)言PHP面前，我們完全不需要那么復(fù)雜。從PHP4.3開(kāi)始，PHP Zend Engine中內(nèi)置了tokenizer功能，幫助開(kāi)發(fā)者做源碼詞法分析。我們只需要找到PHP中定義函數(shù)時(shí)所對(duì)應(yīng)的詞法規(guī)律，就可以輕松得到指定PHP文件中的全部函數(shù)了。

tokenizer定義的接口也十分簡(jiǎn)單：

array token_get_all (string $source)

該函數(shù)進(jìn)行文件解析，將php源代碼拆成由token組成的數(shù)組。

string token_name (int $token)

將整數(shù)形式的token轉(zhuǎn)變?yōu)樽址问?。?lèi)似于C語(yǔ)言中的strerror函數(shù)。有了tokenizer，自己再根據(jù)php函數(shù)定義的規(guī)律和格式設(shè)計(jì)一個(gè)有限狀態(tài)機(jī)，即可完成全量函數(shù)的解析。

求函數(shù)覆蓋率的另外一個(gè)難點(diǎn)在于獲取被執(zhí)行的函數(shù)列表。這地方讓我們走了一些彎路。一開(kāi)始一個(gè)最簡(jiǎn)單的辦法，我們既然通過(guò)xdebug拿到被執(zhí)的行，可以通過(guò)行號(hào)來(lái)反推此行屬于哪一個(gè)函數(shù)。然而每一次的請(qǐng)求獲取的行號(hào)信息量是非常大的，如果一個(gè)求情執(zhí)行了1000行，那就要進(jìn)行1000次判斷，效率上會(huì)比較差。調(diào)研了一番之后，發(fā)現(xiàn)xdebug提供了function trace的功能，可以把一次請(qǐng)求中的函數(shù)調(diào)用關(guān)系獲取到，只不過(guò)拿到了函數(shù)名字，卻沒(méi)辦法得到它所在的文件。于是，再次調(diào)研一番，發(fā)現(xiàn)了Reflection，給定方法名和類(lèi)名，可以反推出來(lái)它在哪個(gè)文件中定義。于是我們使用function trace把函數(shù)調(diào)用關(guān)系暫存在一個(gè)臨時(shí)文件中，然后通過(guò)文件解析，拿到執(zhí)行的函數(shù)名（如果是類(lèi)方法，則是“類(lèi)名::函數(shù)名”的形式），再通過(guò)reflection機(jī)制反推出定義這個(gè)函數(shù)的文件即可。再次體會(huì)到了世界上最美語(yǔ)言的強(qiáng)大之處。

（2）插樁

為了降低使用門(mén)檻，我們盡可能少地改變PHP源代碼為好。xdebug收集信息的原理是分別調(diào)用xdebug_start_code_coverage和xdebug_stop_code_coverage來(lái)控制覆蓋率信息收集的開(kāi)始和結(jié)束，因此不可避免地要改變?cè)创a。此處我們的解決辦法是，將xdebug_stop_code_coverage通過(guò)register_shutdown_function注冊(cè)為php程序結(jié)束前必須要跑的一段程序（類(lèi)似C語(yǔ)言的atexit函數(shù)），將其封裝到一個(gè)文件中，然后在源代碼第一行require這個(gè)文件即可。如果你的PHP框架是CodeIgniter這種所有請(qǐng)求都有一個(gè)統(tǒng)一入口index.php的框架，那就只需要改變這一個(gè)文件即可，對(duì)源代碼只有一行的改動(dòng)！實(shí)際上，目前基本上所有的PHP框架，都是以一個(gè)index.php文件作為所有請(qǐng)求的入口。

我們對(duì)源代碼的改動(dòng)只有入口文件index.php的第一行加入了一句話：

<?php require_once "/file/path/to/phpcoverage.php"; ?>

而phpcoverage.php核心代碼邏輯大致如下：

<?php
 ……
function xdebugPhpcoverageBeforeShutdown(){
 ……
 $lineCovData = xdebug_get_code_coverage();
 xdebug_stop_code_coverage();
 ……
 xdebug_stop_trace();
 ……
}
register_shutdown_function(‘xdebugPhpcoverageBeforeShutdown');
……
xdebug_start_trace(……);
xdebug_start_code_coverage();
//備注：上面省略號(hào)表示非關(guān)鍵代碼，這里就不展示了

（3）信息存儲(chǔ)

我們的函數(shù)覆蓋率測(cè)試有了思路，使用xdebug的function trace獲取一次請(qǐng)求中所有函數(shù)的調(diào)用關(guān)系，得到執(zhí)行過(guò)的所有函數(shù)，輸出到文件中，通過(guò)文件解析和reflection獲得被執(zhí)行的函數(shù)名和該函數(shù)所在文件。將這些信息存入數(shù)據(jù)庫(kù)或文件即可。

之前試用Spike的時(shí)候，我們發(fā)現(xiàn)這些信息以xml格式存入文件，數(shù)據(jù)冗余度很高，導(dǎo)致幾個(gè)測(cè)試下來(lái)，文件已經(jīng)非常大了。這顯然不是我們想看到的。因此在數(shù)據(jù)存儲(chǔ)的時(shí)候，我們直接將數(shù)據(jù)做json格式的序列化，字符串形式存在文件中，大大減少了文件大小。與此同時(shí)，我們?cè)偻ㄟ^(guò)請(qǐng)求來(lái)源的IP和日期作為分隔，分別存儲(chǔ)不同的文件。這樣，來(lái)自每個(gè)機(jī)器每天的請(qǐng)求數(shù)據(jù)都能一目了然，向著“精準(zhǔn)”的方向又邁進(jìn)了一步，可以對(duì)測(cè)試人員的每個(gè)請(qǐng)求做精確的監(jiān)控。下圖是我們?cè)跇I(yè)務(wù)實(shí)踐中搜集的部分?jǐn)?shù)據(jù)文件截圖：

這樣，來(lái)自任何一個(gè)IP的每一次Web請(qǐng)求，它所覆蓋的行和函數(shù)信息，都會(huì)被記錄到文件中。對(duì)于一般的項(xiàng)目測(cè)試中，也就只有幾個(gè)測(cè)試人員在使用，所以不需要考慮一些性能問(wèn)題。

4. 報(bào)告生成

上面講了生成覆蓋率數(shù)據(jù)的原理，不過(guò)我們至此獲得的只是一份份的數(shù)據(jù)文件，如何匯總成一份完整的報(bào)告呢？這就需要我們自己來(lái)寫(xiě)一段腳本解析剛才生成的數(shù)據(jù)文件了。我們的做法是借鑒了開(kāi)源工具spike phpcoverage的模版，并加入自己的代碼邏輯，特別是加入了該工具所不具有的函數(shù)覆蓋率統(tǒng)計(jì)數(shù)據(jù)。我們自己測(cè)試的web頁(yè)面生成的報(bào)告如下：

圖中可以看到每個(gè)文件的行覆蓋率，函數(shù)覆蓋率，還有總的覆蓋率統(tǒng)計(jì)數(shù)據(jù)。如果需要更精確的數(shù)據(jù)，可以點(diǎn)進(jìn)文件連接，查看到底覆蓋的是哪些代碼行（藍(lán)色為覆蓋，紅色為未覆蓋）：

到此，關(guān)于“Web端測(cè)試PHP代碼函數(shù)覆蓋率的解決方法”的學(xué)習(xí)就結(jié)束了，希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí)，快去試試吧！若想繼續(xù)學(xué)習(xí)更多相關(guān)知識(shí)，請(qǐng)繼續(xù)關(guān)注億速云網(wǎng)站，小編會(huì)繼續(xù)努力為大家?guī)?lái)更多實(shí)用的文章！