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数组类型，最后这个断言是通过了，因为返回的的确是数组类型。
 

【编辑推荐】

1. PHP单元测试利器：PHPUnit深入用法
2. 初探PHP单元测试利器：PHPUnit
3. PHP开发者工资翻倍需做到的5件事
4. PHP企业级应用之常见缓存技术深入解读
5. PHP 5.3.6 RC1发布 修复多处BUG(附下载)