利用單元測(cè)試對(duì)PHP代碼進(jìn)行檢查
測(cè)試驅(qū)動(dòng)的開(kāi)發(fā)和單元測(cè)試是確保代碼在經(jīng)過(guò)修改和重大調(diào)整之后依然能如我們期望的一樣工作的最新方法。在本文中,您將學(xué)習(xí)到如何在模塊、數(shù)據(jù)庫(kù)和用戶(hù)界面(UI)層對(duì)自己的 PHP 代碼進(jìn)行單元測(cè)試。
現(xiàn)在是凌晨 3 點(diǎn)。我們?cè)鯓硬拍苤雷约旱拇a依然在工作呢?
Web 應(yīng)用程序是 24x7 不間斷運(yùn)行的,因此我的程序是否還在運(yùn)行這個(gè)問(wèn)題會(huì)在晚上一直困擾我。單元測(cè)試已經(jīng)幫我對(duì)自己的代碼建立了足夠的信心 —— 這樣我就可以安穩(wěn)地睡個(gè)好覺(jué)了。
單元測(cè)試 是一個(gè)為代碼編寫(xiě)測(cè)試用例并自動(dòng)運(yùn)行這些測(cè)試的框架。測(cè)試驅(qū)動(dòng)的開(kāi)發(fā)是一種單元測(cè)試方法,其思想是應(yīng)該首先編寫(xiě)測(cè)試程序,并驗(yàn)證這些測(cè)試可以發(fā)現(xiàn)錯(cuò)誤,然后才開(kāi)始編寫(xiě)需要通過(guò)這些測(cè)試的代碼。當(dāng)所有測(cè)試都通過(guò)時(shí),我們開(kāi)發(fā)的特性也就完成了。這些單元測(cè)試的價(jià)值是我們可以隨時(shí)運(yùn)行它們 —— 在簽入代碼之前,重大修改之后,或者部署到正在運(yùn)行的系統(tǒng)之后都可以。
PHP 單元測(cè)試
對(duì)于 PHP 來(lái)說(shuō),單元測(cè)試框架是 PHPUnit2。可以使用 PEAR 命令行作為一個(gè) PEAR 模塊來(lái)安裝這個(gè)系統(tǒng):% pear install PHPUnit2。
在安裝這個(gè)框架之后,可以通過(guò)創(chuàng)建派生于 PHPUnit2_Framework_TestCase 的測(cè)試類(lèi)來(lái)編寫(xiě)單元測(cè)試。
模塊單元測(cè)試
我發(fā)現(xiàn)開(kāi)始單元測(cè)試最好的地方是在應(yīng)用程序的業(yè)務(wù)邏輯模塊中。我使用了一個(gè)簡(jiǎn)單的例子:這是一個(gè)對(duì)兩個(gè)數(shù)字進(jìn)行求和的函數(shù)。為了開(kāi)始測(cè)試,我們首先編寫(xiě)測(cè)試用例,如下所示。
清單 1. TestAdd.php
<?phprequire_once 'Add.php';require_once 'PHPUnit2/Framework/TestCase.php';class TestAdd extends PHPUnit2_Framework_TestCase{; function test1() { $this->assertTrue( add( 1, 2 ) == 3 ); }; function test2() { $this->assertTrue( add( 1, 1 ) == 2 ); }}?>
這個(gè) TestAdd 類(lèi)有兩個(gè)方法,都使用了 test 前綴。每個(gè)方法都定義了一個(gè)測(cè)試,這個(gè)測(cè)試可以與清單 1 一樣簡(jiǎn)單,也可以十分復(fù)雜。在本例中,我們?cè)诘谝粋€(gè)測(cè)試中只是簡(jiǎn)單地?cái)喽?1 加 2 等于 3,在第二個(gè)測(cè)試中是 1 加 1 等于 2。
PHPUnit2 系統(tǒng)定義了 assertTrue() 方法,它用來(lái)測(cè)試參數(shù)中包含的條件值是否為真。然后,我們又編寫(xiě)了 Add.php 模塊,最初讓它產(chǎn)生錯(cuò)誤的結(jié)果。
清單 2. Add.php
<?phpfunction add( $a, $b ) { return 0; }?>
現(xiàn)在運(yùn)行單元測(cè)試時(shí),這兩個(gè)測(cè)試都會(huì)失敗。
清單 3. 測(cè)試失敗
% phpunit TestAdd.phpPHPUnit 2.2.1 by Sebastian Bergmann.FFTime: 0.0031270980834961There were 2 failures:1) test1(TestAdd)2) test2(TestAdd)FAILURES!!!Tests run: 2, Failures: 2, Errors: 0, Incomplete Tests: 0.
現(xiàn)在我知道這兩個(gè)測(cè)試都可以正常工作了。因此,可以修改 add() 函數(shù)來(lái)真正地做實(shí)際的事情了。
現(xiàn)在這兩個(gè)測(cè)試都可以通過(guò)了。
<?phpfunction add( $a, $b ) { return $a+$b; }?>
清單 4. 測(cè)試通過(guò)
% phpunit TestAdd.phpPHPUnit 2.2.1 by Sebastian Bergmann...Time: 0.0023679733276367OK (2 tests)%
盡管這個(gè)測(cè)試驅(qū)動(dòng)開(kāi)發(fā)的例子非常簡(jiǎn)單,但是我們可以從中體會(huì)到它的思想。我們首先創(chuàng)建了測(cè)試用例,并且有足夠多的代碼讓這個(gè)測(cè)試運(yùn)行起來(lái),不過(guò)結(jié)果是錯(cuò)誤的。然后我們驗(yàn)證測(cè)試的確是失敗的,接著實(shí)現(xiàn)了實(shí)際的代碼使這個(gè)測(cè)試能夠通過(guò)。
我發(fā)現(xiàn)在實(shí)現(xiàn)代碼時(shí)我會(huì)一直不斷地添加代碼,直到擁有一個(gè)覆蓋所有代碼路徑的完整測(cè)試為止。在本文的最后,您會(huì)看到有關(guān)編寫(xiě)什么測(cè)試和如何編寫(xiě)這些測(cè)試的一些建議。
數(shù)據(jù)庫(kù)測(cè)試
在進(jìn)行模塊測(cè)試之后,就可以進(jìn)行數(shù)據(jù)庫(kù)訪(fǎng)問(wèn)測(cè)試了。數(shù)據(jù)庫(kù)訪(fǎng)問(wèn)測(cè)試帶來(lái)了兩個(gè)有趣的問(wèn)題。首先,我們必須在每次測(cè)試之前將數(shù)據(jù)庫(kù)恢復(fù)到某個(gè)已知點(diǎn)。其次,要注意這種恢復(fù)可能會(huì)對(duì)現(xiàn)有數(shù)據(jù)庫(kù)造成破壞,因此我們必須對(duì)非生產(chǎn)數(shù)據(jù)庫(kù)進(jìn)行測(cè)試,或者在編寫(xiě)測(cè)試用例時(shí)注意不能影響現(xiàn)有數(shù)據(jù)庫(kù)的內(nèi)容。
數(shù)據(jù)庫(kù)的單元測(cè)試是從數(shù)據(jù)庫(kù)開(kāi)始的。為了闡述這個(gè)問(wèn)題,我們需要使用下面的簡(jiǎn)單模式。
清單 5. Schema.sql
DROP TABLE IF EXISTS authors;CREATE TABLE authors (; id MEDIUMINT NOT NULL AUTO_INCREMENT,; name TEXT NOT NULL,; PRIMARY KEY ( id ));
清單 5 是一個(gè) authors 表,每條記錄都有一個(gè)相關(guān)的 ID。
接下來(lái),就可以編寫(xiě)測(cè)試用例了。
清單 6. TestAuthors.php
<?phprequire_once 'dblib.php';require_once 'PHPUnit2/Framework/TestCase.php';class TestAuthors extends PHPUnit2_Framework_TestCase{; function test_delete_all() {;;$this->assertTrue( Authors::delete_all() )}; function test_insert() {;;$this->assertTrue( Authors::delete_all() );;;$this->assertTrue( Authors::insert( 'Jack' ) )}; function test_insert_and_get() {;;$this->assertTrue( Authors::delete_all() );;;$this->assertTrue( Authors::insert( 'Jack' ) );;;$this->assertTrue( Authors::insert( 'Joe' ) );;;$found = Authors::get_all();;;$this->assertTrue( $found != null );;;$this->assertTrue( count( $found ) == 2 )}}?>
這組測(cè)試覆蓋了從表中刪除作者、向表中插入作者以及在驗(yàn)證作者是否存在的同時(shí)插入作者等功能。這是一個(gè)累加的測(cè)試,我發(fā)現(xiàn)對(duì)于尋找錯(cuò)誤來(lái)說(shuō)這非常有用。觀察一下哪些測(cè)試可以正常工作,而哪些測(cè)試不能正常工作,就可以快速地找出哪些地方出錯(cuò)了,然后就可以進(jìn)一步理解它們之間的區(qū)別。
最初產(chǎn)生失敗的 dblib.php PHP 數(shù)據(jù)庫(kù)訪(fǎng)問(wèn)代碼版本如下所示。
清單 7. dblib.php
<?phprequire_once('DB.php');class Authors{; public static function get_db(); {;$dsn = 'mysql://root:password@localhost/unitdb';;$db =& DB::Connect( $dsn, array() );;if (PEAR::isError($db)) { die($db->getMessage()); };return $db}; public static function delete_all(); {;return false}; public static function insert( $name ); {;return false}; public static function get_all(); {;return null}}?>
對(duì)清單 8 中的代碼執(zhí)行單元測(cè)試會(huì)顯示這 3 個(gè)測(cè)試全部失敗了:
清單 8. dblib.php
% phpunit TestAuthors.phpPHPUnit 2.2.1 by Sebastian Bergmann.FFFTime: 0.007500171661377There were 3 failures:1) test_delete_all(TestAuthors)2) test_insert(TestAuthors)3) test_insert_and_get(TestAuthors)FAILURES!!!Tests run: 3, Failures: 3, Errors: 0, Incomplete Tests: 0.%
現(xiàn)在我們可以開(kāi)始添加正確訪(fǎng)問(wèn)數(shù)據(jù)庫(kù)的代碼 —— 一個(gè)方法一個(gè)方法地添加 —— 直到所有這 3 個(gè)測(cè)試都可以通過(guò)。最終版本的 dblib.php 代碼如下所示。
清單 9. 完整的 dblib.php
<?phprequire_once('DB.php');class Authors{; public static function get_db(); {;$dsn = 'mysql://root:password@localhost/unitdb';;$db =& DB::Connect( $dsn, array() );;if (PEAR::isError($db)) { die($db->getMessage()); };return $db}; public static function delete_all(); {;$db = Authors::get_db();;$sth = $db->prepare( 'DELETE FROM authors' );;$db->execute( $sth );;return true}; public static function insert( $name ); {;$db = Authors::get_db();;$sth = $db->prepare( 'INSERT INTO authors VALUES (null,?)' );;$db->execute( $sth, array( $name ) );;return true}; public static function get_all(); {;$db = Authors::get_db();;$res = $db->query( 'SELECT * FROM authors' );;$rows = array();;while( $res->fetchInto( $row ) ) { $rows []= $row; };return $rows}}?>
HTML 測(cè)試
對(duì)整個(gè) PHP 應(yīng)用程序進(jìn)行測(cè)試的下一個(gè)步驟是對(duì)前端的超文本標(biāo)記語(yǔ)言(HTML)界面進(jìn)行測(cè)試。要進(jìn)行這種測(cè)試,我們需要一個(gè)如下所示的 Web 頁(yè)面。
清單 10. TestPage.php
<?phprequire_once 'HTTP/Client.php';require_once 'PHPUnit2/Framework/TestCase.php';class TestPage extends PHPUnit2_Framework_TestCase{; function get_page( $url ); {;$client = new HTTP_Client();;$client->get( $url );;$resp = $client->currentResponse();;return $resp['body']}; function test_get(); {;$page = TestPage::get_page( 'http://localhost/unit/add.php' );;$this->assertTrue( strlen( $page ) > 0 );;$this->assertTrue( preg_match( '/<html>/', $page ) == 1 )}; function test_add(); {;$page = TestPage::get_page( 'http://localhost/unit/add.php?a=10&b=20' );;$this->assertTrue( strlen( $page ) > 0 );;$this->assertTrue( preg_match( '/<html>/', $page ) == 1 );;preg_match( '/<span id='result'>(.*?)</span>/', $page, $out );;$this->assertTrue( $out[1]=='30' )}}?>
這個(gè)測(cè)試使用了 PEAR 提供的 HTTP Client 模塊。我發(fā)現(xiàn)它比內(nèi)嵌的 PHP Client URL Library(CURL)更簡(jiǎn)單一點(diǎn)兒,不過(guò)也可以使用后者。
有一個(gè)測(cè)試會(huì)檢查所返回的頁(yè)面,并判斷這個(gè)頁(yè)面是否包含 HTML。第二個(gè)測(cè)試會(huì)通過(guò)將值放到請(qǐng)求的 URL 中來(lái)請(qǐng)求計(jì)算 10 和 20 的和,然后檢查返回的頁(yè)面中的結(jié)果。
這個(gè)頁(yè)面的代碼如下所示。
清單 11. TestPage.php
<html><body><form><input type='text' name='a' value='<?php echo($_REQUEST['a']); ?>' /> +<input type='text' name='b' value='<?php echo($_REQUEST['b']); ?>' /> =<span id='result'><?php echo($_REQUEST['a']+$_REQUEST['b']); ?></span><br/><input type='submit' value='Add' /></form></body></html>
這個(gè)頁(yè)面相當(dāng)簡(jiǎn)單。兩個(gè)輸入域顯示了請(qǐng)求中提供的當(dāng)前值。結(jié)果 span 顯示了這兩個(gè)值的和。 標(biāo)記標(biāo)出了所有區(qū)別:它對(duì)于用戶(hù)來(lái)說(shuō)是不可見(jiàn)的,但是對(duì)于單元測(cè)試來(lái)說(shuō)卻是可見(jiàn)的。因此單元測(cè)試并不需要復(fù)雜的邏輯來(lái)找到這個(gè)值。相反,它會(huì)檢索一個(gè)特定 標(biāo)記的值。這樣當(dāng)界面發(fā)生變化時(shí),只要 span 存在,測(cè)試就可以通過(guò)。
與前面一樣,首先編寫(xiě)測(cè)試用例,然后創(chuàng)建一個(gè)失敗版本的頁(yè)面。我們對(duì)失敗情況進(jìn)行測(cè)試,然后修改頁(yè)面的內(nèi)容使其可以工作。結(jié)果如下:
清單 12. 測(cè)試失敗情況,然后修改頁(yè)面
% phpunit TestPage.phpPHPUnit 2.2.1 by Sebastian Bergmann...Time: 0.25711488723755OK (2 tests)%
這兩個(gè)測(cè)試都可以通過(guò),這就意味著測(cè)試代碼可以正常工作。
在對(duì)這段代碼運(yùn)行測(cè)試時(shí),所有的測(cè)試都可以沒(méi)有問(wèn)題地運(yùn)行,這樣我們就可以知道自己的代碼可以正確工作了。
不過(guò)對(duì) HTML 前端的測(cè)試有一個(gè)缺陷:JavaScript。超文本傳輸協(xié)議(HTTP)客戶(hù)機(jī)代碼對(duì)頁(yè)面進(jìn)行檢索,但是卻沒(méi)有執(zhí)行 JavaScript。因此如果我們?cè)?JavaScript 中有很多代碼,就必須創(chuàng)建用戶(hù)代理級(jí)的單元測(cè)試。我發(fā)現(xiàn)實(shí)現(xiàn)這種功能的最佳方法是使用 Microsoft? Internet Explorer? 內(nèi)嵌的自動(dòng)化層功能。通過(guò)使用 PHP 編寫(xiě)的 Microsoft Windows? 腳本,可以使用組件對(duì)象模型(COM)接口來(lái)控制 Internet Explorer,讓它在頁(yè)面之間進(jìn)行導(dǎo)航,然后使用文檔對(duì)象模型(DOM)方法在執(zhí)行特定用戶(hù)操作之后查找頁(yè)面中的元素。
這是我了解的對(duì)前端 JavaScript 代碼進(jìn)行單元測(cè)試的惟一一種方法。我承認(rèn)它并不容易編寫(xiě)和維護(hù),這些測(cè)試即使在對(duì)頁(yè)面稍微進(jìn)行改動(dòng)時(shí)也很容易遭到破壞。
編寫(xiě)哪些測(cè)試以及如何編寫(xiě)這些測(cè)試
在編寫(xiě)測(cè)試時(shí),我喜歡覆蓋以下情況:
所有正面測(cè)試
這組測(cè)試可以確保所有的東西都如我們期望的一樣工作。
所有負(fù)面測(cè)試
逐一使用這些測(cè)試,從而確保每個(gè)失效或異常情況都被測(cè)試到了。
正面序列測(cè)試
這組測(cè)試可以確保按照正確順序的調(diào)用可以像我們期望的一樣工作。
負(fù)面序列測(cè)試
這組測(cè)試可以確保當(dāng)不按正確順序進(jìn)行調(diào)用時(shí)就會(huì)失敗。
負(fù)載測(cè)試
在適當(dāng)情況下,可以執(zhí)行一小組測(cè)試來(lái)確定這些測(cè)試的性能在我們期望的范圍之內(nèi)。例如,2,000 次調(diào)用應(yīng)該在 2 秒之內(nèi)完成。
資源測(cè)試
這些測(cè)試確保應(yīng)用編程接口(API)可以正確地分配并釋放資源 —— 例如,連續(xù)幾次調(diào)用打開(kāi)、寫(xiě)入以及關(guān)閉基于文件的 API,從而確保沒(méi)有文件依然是被打開(kāi)的。
回調(diào)測(cè)試
對(duì)于具有回調(diào)方法的 API 來(lái)說(shuō),這些測(cè)試可以確保如果沒(méi)有定義回調(diào)函數(shù),代碼可以正常運(yùn)行。另外,這些測(cè)試還可以確保在定義了回調(diào)函數(shù)但是這些回調(diào)函數(shù)操作有誤或產(chǎn)生異常時(shí),代碼依然可以正常運(yùn)行。
這是有關(guān)單元測(cè)試的幾點(diǎn)想法。有關(guān)如何編寫(xiě)單元測(cè)試,我也有幾點(diǎn)建議:
不要使用隨機(jī)數(shù)據(jù)
盡管在一個(gè)界面中產(chǎn)生隨機(jī)數(shù)據(jù)看起來(lái)貌似一個(gè)好主意,但是我們要避免這樣做,因?yàn)檫@些數(shù)據(jù)會(huì)變得非常難以調(diào)試。如果數(shù)據(jù)是在每次調(diào)用時(shí)隨機(jī)生成的,那么就可能產(chǎn)生一次測(cè)試時(shí)出現(xiàn)了錯(cuò)誤而另外一次測(cè)試卻沒(méi)有出現(xiàn)錯(cuò)誤的情況。如果測(cè)試需要隨機(jī)數(shù)據(jù),可以在一個(gè)文件中生成這些數(shù)據(jù),然后每次運(yùn)行時(shí)都使用這個(gè)文件。采用這種方法,我們就獲得了一些 “噪音” 數(shù)據(jù),但是仍然可以對(duì)錯(cuò)誤進(jìn)行調(diào)試。
分組測(cè)試
我們很容易累積起數(shù)千個(gè)測(cè)試,需要幾個(gè)小時(shí)才能執(zhí)行完。這沒(méi)什么問(wèn)題,但是對(duì)這些測(cè)試進(jìn)行分組使我們可以快速運(yùn)行某組測(cè)試并對(duì)主要關(guān)注的問(wèn)題進(jìn)行檢查,然后晚上運(yùn)行完整的測(cè)試。
編寫(xiě)穩(wěn)健的 API 和穩(wěn)健的測(cè)試
編寫(xiě) API 和測(cè)試時(shí)要注意它們不能在增加新功能或修改現(xiàn)有功能時(shí)很容易就會(huì)崩潰,這一點(diǎn)非常重要。這里沒(méi)有通用的絕招,但是有一條準(zhǔn)則是那些 “振蕩的” 測(cè)試(一會(huì)兒失敗,一會(huì)兒成功,反復(fù)不停的測(cè)試)應(yīng)該很快地丟棄。
結(jié)束語(yǔ)
單元測(cè)試對(duì)于工程師來(lái)說(shuō)意義重大。它們是敏捷開(kāi)發(fā)過(guò)程(這個(gè)過(guò)程非常強(qiáng)調(diào)編碼的作用,因?yàn)槲臋n需要一些證據(jù)證明代碼是按照規(guī)范進(jìn)行工作的)的一個(gè)基礎(chǔ)。單元測(cè)試就提供了這種證據(jù)。這個(gè)過(guò)程從單元測(cè)試開(kāi)始入手,這定義了代碼應(yīng)該 實(shí)現(xiàn)但目前尚未實(shí)現(xiàn)的功能。因此,所有的測(cè)試最初都會(huì)失敗。然后當(dāng)代碼接近完成時(shí),測(cè)試就通過(guò)了。當(dāng)所有測(cè)試全部通過(guò)時(shí),代碼也就變得非常完善了。
我從來(lái)沒(méi)有在不使用單元測(cè)試的情況下編寫(xiě)大型代碼或修改大型或復(fù)雜的代碼塊。我通常都是在修改代碼之前就為現(xiàn)有代碼編寫(xiě)了單元測(cè)試,這樣可以確保自己清楚在修改代碼時(shí)破壞了什么(或者沒(méi)有破壞什么)。這為我對(duì)自己提供給客戶(hù)的代碼提供了很大的信心,相信它們正在正確運(yùn)行 —— 即便是在凌晨 3 點(diǎn)。
