PHP單元測試利器:PHPUnit深入理解
在本系列文章的前兩篇中初探PHP單元測試利器:PHPUnit和PHP單元測試利器:PHPUnit深入用法中,分別介紹了PHPUnit的基本用法和PHPUnit中的一些重要用法。在本文中,筆者將為大家介紹PHPUnit中的兩個高級概念和用法,盡管它不一定在你的日常單元測試中都用到,但理解和學會它們的用法對學習PHPUnit還是十分重要的。
PHPUnit中的Annotations
如果有其他編程語言經驗的開發者,應該對Annotations(注解)不陌生,其實在PHPUnit中,一個簡單的如下面的一段注釋也可以認為是Annotations:
- <?php
- class MyTestClass extends PHPUnit_Framework_TestCase
- {
- /**
- * Testing the answer to “do you love unit tests?”
- */
- public function testDoYouLoveUnitTests()
- {
- $love = true;
- $this->assertTrue($love);
- }
- }
- ?>
可以看到,其實一段以/** **/為標記的文字,就可以認為是一種Annotations,但Annotations其實不單單是簡單的注釋,它是與一個程序元素相關聯信息或者元數據的標注,它不影響程序的運行,但相關的軟件工具或框架能夠將其轉換成特殊的元數據標記,以方便開發者以更少的代碼去提高效率(比如通過。如果你熟悉Java,則會發現在Java SE 5中及象Spring等框架中,都大量使用了Annotations。
然而,由于PHP并不象Java那樣是編譯性語言,因此本身缺乏去解析Annotations的機制,但幸好PHPUnit去提供了這樣的功能,我們以下面的代碼為例:
- <?php
- class MyMathClass
- {
- /**
- * Add two given values together and return sum
- */
- public function addValues($a,$b)
- {
- return $a+$b;
- }
- }
- ?>
上面的只是一個簡單的加法的例子,為此,我們使用Annotations去編寫一個單元測試,在上兩篇文章中,我們采用的是手工編寫單元測試的方法,而本文中,將介紹使用PHPUnit命令行的方法,自動生成單元測試的框架,方法如下:
首先把上面的類保存為MyMathClass.PHP,然后在命令行下運行如下命令:
- phpunit –skeleton-test MyMathClass
這時PHPUnit會自動生成如下的框架單元測試代碼:
- <?php
- require_once '/path/to/MyMathClass.php';
- /**
- * Test class for MyMathClass.
- * Generated by PHPUnit on 2011-02-07 at 12:22:07.
- */
- class MyMathClassTest extends PHPUnit_Framework_TestCase
- {
- /**
- * @var MyMathClass
- */
- protected $object;
- /**
- * Sets up the fixture, for example, opens a network connection.
- * This method is called before a test is executed.
- */
- protected function setUp()
- {
- $this->object = new MyMathClass;
- }
- /**
- * Tears down the fixture, for example, closes a network connection.
- * This method is called after a test is executed.
- */
- protected function tearDown()
- {
- }
- /**
- * @todo Implement testAddValues().
- */
- public function testAddValues()
- {
- // Remove the following lines when you implement this test.
- $this->markTestIncomplete(
- 'This test has not been implemented yet.'
- );
- }
- }
- ?>
可以看到,PHPUnit為我們生成的單元測試代碼自動引入了原來的MyMathClass.PHP,同時也生成了setUp和tearDown方法,但唯一的核心單元測試代碼是留給了我們編寫。如果想在這個基礎上更快速的生成我們想要的單元測試代碼,要如何實現呢?沒錯,就是使用annotations!我們可以在原來的MyMathClass.PHP中加入如下的annotations。
- <?php
- class MyMathClass
- {
- /**
- * Add two given values together and return sum
- * @assert (1,2) == 3
- */
- public function addValues($a,$b)
- {
- return $a+$b;
- }
- }
- ?>
然后再象上述一樣在命令行運行:
- phpunit –skeleton-test MyMathClass
這個時候會為我們生成如下的單元測試代碼:
- <?php
- /**
- * Generated from @assert (1,2) == 3.
- */
- public function testAddValues()
- {
- $this->assertEquals(
- 3,
- $this->object->addValues(1,2)
- );
- }
- ?>
看到了么?我們在原有的類中加入了注解@assert(1,2)==3,則PHPUnit自動為我們生成了正確的單元測試代碼。當然,可以參考PHPUnit手冊,學習到更多的關于@assert注解使用的規則。
下面再舉一個例子來講解annotations。假設我們的程序中的一個方法,只是僅需要數據的輸入,并且不依賴XML或者數據庫提供數據源,則為了測試這個方法,我們可能想到的一個方法是在程序中設置一個測試數據集去測試,但這里介紹一個比較簡單的方法,就是使用注解@dataProvider,修改MyMathClass.PHP如下:
- <?php
- /**
- * Data provider for test methods below
- */
- public static function provider()
- {
- return array(
- array(1,2,3),
- array(4,2,6),
- array(1,5,7)
- );
- }
- /**
- * Testing addValues returns sum of two values
- * @dataProvider provider
- */
- public function testAddValues($a,$b,$sum)
- {
- $this->assertEquals(
- $sum,
- $this->object->addValues($a,$b)
- );
- }
- ?>
可以看到,這里使用了注解@dataProvider,指明了測試用例的數據提供者是由provider方法返回的一個數組。所以在單元測試時,數組中的第0個元素則會賦值給$a,第1個元素則會賦值給b,第3個元素則會賦值給sum,可以看到,上面的第3個數組提供的數據是不能通過單元測試的,因為1+5不等于7。
此外,這里還簡單介紹兩個常用的annotations,比如@expectedException注解可以測試代碼中是否正確拋出了異常,比如:
- <?phprequire_once 'PHPUnit/Framework.php';
- class ExceptionTest extends PHPUnit_Framework_TestCase{
- /**
- * @expectedException InvalidArgumentException */
- public function testException() {
- }
- }
- ?>
這里就用注解的方法表示testException中必須拋出的異常類型為InvalidArgumentException。
另外一個是@cover注解。它的作用是標識PHPUnit只為類中的哪些方法或作用域生成測試代碼,比如:
- /**
- * @covers SampleClass::publicMethod
- * @covers SampleClass::<!public>
- * @covers HelperClass<extended>
- */
- public function testMethod()
- {
- $result = SampleClass::method();
- }
則PHPUnit只為SampleClass類中的publicMethod方法、SampleClass類中的所有非public聲明的方法和HelperClass類或者它的其中一個父類產生單元測試代碼。
#p#
PHPUnit中的Mocking
在介紹Mocking前,先來看下為什么要使用Mocking。舉一個數據庫查詢的例子,比如在某個應用中,如果要測試一個數據庫的應用,但假如這個數據庫的測試要耗費很多資源以及編寫很復雜的單元測試的代碼的話,可以嘗試使用Mocking技術。舉例說明如下:
- <?php
- class Database
- {
- public function reallyLongTime()
- {
- $results = array(
- array(1,'test','foo value')
- );
- sleep(100);
- return $results;
- }
- }
- ?>
在上面這個例子中,我們模擬了一個數據庫的操作,認為它需要運行很長時間。接下來我們編寫其單元測試代碼如下:
- <?php
- require_once '/path/to/Database.php';
- class DatabaseTest extends PHPUnit_Framework_TestCase
- {
- private $db = null;
- public function setUp()
- {
- $this->db = new Database();
- }
- public function tearDown()
- {
- unset($this->db);
- }
- /**
- * Test that the "really long query" always returns values
- */
- public function testReallyLongReturn()
- {
- $mock = $this->getMock('Database');
- $result = array(
- array(1,'foo','bar test')
- );
- $mock->expects($this->any())
- ->method('reallyLongTime')
- ->will($this->returnValue($result));
- $return = $mock->reallyLongTime();
- $this->assertGreaterThan(0,count($return));
- }
- }
- ?>
注意看這段代碼中有趣的地方,這里,使用了PHPUnit中的getMock對象方法,這里實際上是模擬生成一個Database類的“偽實例”了,這里生成了$mock這個mock對象實例,以方便接著的單元測試中用到。接下來的這三行代碼:
- $mock->expects($this->any())
- ->method('reallyLongTime')
- ->will($this->returnValue($result));
它們的含義為:無論方法reallyLongtime執行了多長時間,始終最后會直接返回$result這個數組的結果。這樣,你就可以通過mocking技術很輕易地去實現在單元測試中,繞過某些復雜的邏輯部分,而節省大量的寶貴時間提高測試效率。
下面的這個例子,講解的是Mocking技術中的更高級用法Mockbuilder。依然以上面的例子說明:
- <?php
- public function testReallyLongRunBuilder()
- {
- $stub = $this->getMockBuilder('Database')
- ->setMethods(array(
- 'reallyLongTime'
- ))
- ->disableAutoload()
- ->disableOriginalConstructor()
- ->getMock();
- $result = array(array(1,'foo','bar test'));
- $stub->expects($this->any())
- ->method('reallyLongTime')
- ->will($this->returnValue($result));
- $this->assertGreaterThan(0,count($return));
- }
- ?>
通過使用Mockbuilder,我們可以不用通過構造函數的方法去初始化一個mock對象。這段代碼跟上一段代碼的功能其實是一樣的,只不過留意一下新的兩個方法: disableAutoload和disableOriginalConstructor,其功能分別是禁止使用PHP的內置的autoload初始構造方法和禁止調用該類原有的構造函數。最后再看一個例子:
- <?php
- /**
- * Testing enforcing the type to "array" like the "enforceTypes"
- * method does via type hinting
- */
- public function ttestReallyLongRunBuilderConstraint()
- {
- $stub = $this->getMock('Database',array('reallyLongTime'));
- $stub->expects($this->any())
- ->method('reallyLongTime')
- ->with($this->isType('array'));
- $arr = array('test');
- $this->assertTrue($stub-> reallyLongTime ($arr));
- }
- ?>
在這里,我們使用了with方法,其中這個方法中指定了要傳入的參數類型為array數組類型,最后這個斷言是通過了,因為返回的的確是數組類型。
【編輯推薦】