测试用例详解
 

2009-10-16 作者：nonultimate 来源：thinkphp.cn
 

在上篇文章中介绍了如何使用PHPUnit进行单元测试，现在我就来谈谈如何编写测试用例以及怎样保证测试的全面性。

通常的测试用例继承自PHPUnit_Framework_TestCase类，其中的每个测试都以test开头，而且声明为公共类型public。每个测试用例都有一个构建方法setUp()和拆除方法tearDown()，分别在每个测试执行之前和之后执行，这两个方法都声明为被保护类型protected。测试语句的类型包括断言、标记跳过、标记未完成。自动生成的测试类使用标记未完成来表示该测试未完成，在测试条件不满足的情况下要使用标记跳过，如测试Oracle数据库驱动时没有Oracle数据库环境、Linux下无法测试SQL Server数据库驱动等。测试结果包括成功、失败和错误。出现错误的结果说明你的代码中有语法或运行时错误，这些错误要首先被解决。

标记未完成

在开始写测试用例时，我们使用标记跳过来表示测试是未完成的，这样做和什么都不写的区别是后者会认为测试是成功的，而你可能会在之后忘了写测试。

PHP代码
  1.  
  2. class UnitTest extends PHPUnit_Framework_TestCase  
  3. {  
  4.     /** 
  5.      * 测试Hello()方法 
  6.      */  
  7.     public function testHello()  
  8.     {  
  9.         $this->markTestIncomplete('这是一个未完成的测试');  
  10.     }  
  11. }  
  12. ?>  

标记跳过

使用标记跳过来跳过不满足测试条件的情况，避免出现错误而影响测试结果。

PHP代码
  1.  
  2. class UnitTest extends PHPUnit_Framework_TestCase  
  3. {  
  4.     protected function setUp()  
  5.     {  
  6.         // 该测试用例需要xxx扩展，如果不满足就跳过  
  7.         if (!extension_loaded('xxx')) {  
  8.             $this->markTestSkipped('这是一个跳过的测试');  
  9.         }  
  10.     }  
  11. }  
  12. ?>  

断言

布尔类型
assertTrue   断言为真
assertFalse  断言为假

NULL类型
assertNull     断言为NULL
assertNotNull  断言非NULL

数字类型
assertEquals             断言等于
assertNotEquals          断言不等于
assertGreaterThan        断言大于
assertGreaterThanOrEqual 断言大于等于
assertLessThan           断言小于
assertLessThanOrEqual    断言小于等于

字符类型
assertEquals          断言等于
assertNotEquals       断言不等于
assertContains        断言包含
assertNotContains     断言不包含
assertContainsOnly    断言只包含
assertNotContainsOnly 断言不只包含

数组类型
assertEquals          断言等于
assertNotEquals       断言不等于
assertArrayHasKey     断言有键
assertArrayNotHasKey  断言没有键
assertContains        断言包含
assertNotContains     断言不包含
assertContainsOnly    断言只包含
assertNotContainsOnly 断言不只包含

对象类型
assertAttributeContains           断言属性包含
assertAttributeContainsOnly       断言属性只包含
assertAttributeEquals             断言属性等于
assertAttributeGreaterThan        断言属性大于
assertAttributeGreaterThanOrEqual 断言属性大于等于
assertAttributeLessThan           断言属性小于
assertAttributeLessThanOrEqual    断言属性小于等于
assertAttributeNotContains        断言不包含
assertAttributeNotContainsOnly    断言属性不只包含
assertAttributeNotEquals          断言属性不等于
assertAttributeNotSame            断言属性不相同
assertAttributeSame               断言属性相同
assertSame                        断言类型和值都相同
assertNotSame                     断言类型或值不相同
assertObjectHasAttribute          断言对象有某属性
assertObjectNotHasAttribute       断言对象没有某属性

class类型
class类型包含对象类型的所有断言，还有
assertClassHasAttribute          断言类有某属性
assertClassHasStaticAttribute    断言类有某静态属性
assertClassNotHasAttribute       断言类没有某属性
assertClassNotHasStaticAttribute 断言类没有某静态属性

文件相关
assertFileEquals     断言文件内容等于
assertFileExists     断言文件存在
assertFileNotEquals  断言文件内容不等于
assertFileNotExists  断言文件不存在

XML相关
assertXmlFileEqualsXmlFile        断言XML文件内容相等
assertXmlFileNotEqualsXmlFile     断言XML文件内容不相等
assertXmlStringEqualsXmlFile      断言XML字符串等于XML文件内容
assertXmlStringEqualsXmlString    断言XML字符串相等
assertXmlStringNotEqualsXmlFile   断言XML字符串不等于XML文件内容
assertXmlStringNotEqualsXmlString 断言XML字符串不相等

有返回值的方法或函数根据其类型选择相应的断言，下面是一个简单例子。

PHP代码
  1.  
  2. class UnitTest extends PHPUnit_Framework_TestCase  
  3. {  
  4.     /** 
  5.      * 测试返回值为布尔类型 
  6.      */  
  7.     public function testReturnBool()  
  8.     {  
  9.         // 实际情况把TRUE和FALSE换为被测试方法或函数  
  10.         $this->assertTrue(TRUE);  
  11.         $this->assertFalse(FALSE);  
  12.     }  
  13.     /** 
  14.      * 测试返回值为字符串类型 
  15.      */  
  16.     public function testReturnString()  
  17.     {  
  18.         $expected = 'string';  
  19.         // 实际情况把下面的'string'换为被测试方法或函数  
  20.         $result = 'string';  
  21.         $this->assertEquals($expected, $result);  
  22.     }  
  23.     /** 
  24.      * 测试返回值是数字类型 
  25.      */  
  26.     public function testReturnInt()  
  27.     {  
  28.         $expected = 10;  
  29.         // 实际情况把20换为被测试方法或函数  
  30.         $result = 20;  
  31.         $this->assertGreaterThan($expected, $result);  
  32.     }  
  33.     /** 
  34.      * 测试返回值是数组类型 
  35.      */  
  36.     public function testReturnArray()  
  37.     {  
  38.         // 实际情况把$result赋值为被测试方法或函数  
  39.         $result = array('test' => 'hello');  
  40.         // 实际情况把'test'换为要测试的键名称  
  41.         $this->assertArrayHasKey('test', $result);  
  42.     }  
  43.     /** 
  44.      * 测试返回值是对象类型 
  45.      */  
  46.     public function testReturnObject()  
  47.     {  
  48.         // 实际情况把$this换为期望的对象  
  49.         $expected = $this;  
  50.         // 实际情况把$this换为被测试方法或函数  
  51.         $result = $this;  
  52.         $this->assertSame($expected, $result);  
  53.     }  
  54. }  
  55. ?>  

无返回值的方法，可以通过其他方法读取属性，也可以使用对象类型中的断言来判断属性的改变。

PHP代码
  1.  
  2. /** 
  3.  * Unit类，有一个无返回值方法 
  4.  */  
  5. class Unit  
  6. {  
  7.     protected $name;  
  8.     /** 
  9.      * 设置name属性 
  10.      */  
  11.     public function setName($value)  
  12.     {  
  13.         $this->name = $value;  
  14.     }  
  15. }  
  16. ?>  
PHP代码
  1.  
  2. require_once 'Unit.php';  
  3.   
  4. class UnitTest extends PHPUnit_Framework_TestCase  
  5. {  
  6.     /** 
  7.      * 测试无返回值的方法 
  8.      */  
  9.     public function testsetName()  
  10.     {  
  11.         $expected = 'Hello';  
  12.         $o = new Unit();  
  13.         $o->setName('Hello');  
  14.         $this->assertAttributeEquals($expected, 'name', $o);  
  15.     }  
  16. }  
  17. ?>  

编写测试

编写测试的原则是，尽可能测试每种不同的参数调用和不同的返回结果类型，既要测试成功的情况，也要测试失败的情况；无返回值的情况，要测试属性改变、输出内容、异常类型等；测试后记得要恢复现场。

在这里做了超出自己能力的事并不光荣。在你写某个函数之前，你只想让它做加法，但它却能做乘法，而且单元测试正确通过。我们来看看它是怎么做到的。

PHP代码
  1.  
  2. /** 
  3.  * 计算器类 
  4.  */  
  5. class Calculator  
  6. {  
  7.     /** 
  8.      * 做加法运算 
  9.      * 
  10.      * @param  int  $a 
  11.      * @param  int  $b 
  12.      * @return int 
  13.      */  
  14.     public function add($a, $b)  
  15.     {  
  16.         return $a * $b;  
  17.     }  
  18. }  
  19. ?> 
    　
PHP代码
  1.  
  2. require_once 'Calculator.php';  
  3.   
  4. class CalcuatorTest extends PHPUnit_Framework_TestCase  
  5. {  
  6.     public function testadd()  
  7.     {  
  8.         // 创建实例  
  9.         $c = new Calculator();  
  10.         $expected = 4;  
  11.         // 做加法  
  12.         $result = $c->add(2, 2);  
  13.         $this->assertEquals($expected, $result);  
  14.     }  
  15. }  
  16. ?>  

合理的测试能帮助我们尽早发现错误。add()方法有两个参数，测试的时候用了两个值相同的参数。如果多做几次测试又太麻烦，对于这个测试我们按照科学的方法只需要一次。从概率学上讲，当你使用的参数差异越大时，结果相同的概率越低。

对于只有几个返回值的情况，要测试全部，如布尔类型。

PHP代码
  1.  
  2. /** 
  3.  * File.php 
  4.  */  
  5.   
  6. /** 
  7.  * 在文件中写入数据并保存 
  8.  * 
  9.  * @param  string  $path 
  10.  * @param  string  $data 
  11.  * @return bool 
  12.  */  
  13. function Save($path, $data)  
  14. {  
  15.     if (is_dir($path)) {  
  16.       return FALSE;  
  17.     }  
  18.   
  19.     return file_put_contents($path, $data);  
  20. }  
  21. ?> 
    　
PHP代码
  1.  
  2. /** 
  3.  * FileTest.php 
  4.  */  
  5.   
  6. require_once 'File.php';  
  7.   
  8. class FileTest extends PHPUnit_Framework_TestCase  
  9. {  
  10.     /** 
  11.      * 测试保存文件 
  12.      */  
  13.     public function testSave()  
  14.     {  
  15.         $file = 'IamFile.txt';  
  16.         $dir = 'IamDir';  
  17.         mkdir($dir);  
  18.   
  19.         // 测试返回值为真的情况  
  20.         $this->assertTrue(Save($file, 'TestTrue'));  
  21.   
  22.         // 测试返回值为假的情况  
  23.         $this->assertFalse(Save($dir, 'TestFalse'));  
  24.   
  25.         // 恢复现场  
  26.         if (is_file($file)) {  
  27.           unlink($file);  
  28.         }  
  29.         rmdir($dir);  
  30.     }  
  31. }  
  32. ?>  

对于有多种类型返回值或不同参数的情况，分别测试每种类型和参数。下面是ThinkPHP源代码中的一个函数，有点复杂。这个例子不能单独运行，如需要请用SVN导出最新的ThinkPHP源代码（含单元测试）。

PHP代码
  1.  
  2. /** 
  3.  * URL生成函数 
  4.  * 
  5.  * @param  string  $action  方法名 
  6.  * @param  string  $module  模块名 
  7.  * @param  string  $route   路由名 
  8.  * @param  array   $params  参数 
  9.  */  
  10. function url($action=ACTION_NAME,$module=MODULE_NAME,$route='',$app=APP_NAME,$params=array())  
  11. {  
  12.     if(C('DISPATCH_ON') && C('URL_MODEL')>0) {  
  13.         switch(C('PATH_MODEL')) {  
  14.             case 1:// 普通PATHINFO模式  
  15.                 $str    =   '/';  
  16.                 foreach ($params as $var=>$val)  
  17.                     $str .= $var.'/'.$val.'/';  
  18.                 $str = substr($str,0,-1);  
  19.                 if(!emptyempty($route)) {  
  20.                     $url    =   str_replace(APP_NAME,$app,).'/'.C('VAR_ROUTER').'/'.$route.'/'.$str;  
  21.                 }else{  
  22.                     $url    =   str_replace(APP_NAME,$app,).'/'.C('VAR_MODULE').'/'.$module.'/'.C('VAR_ACTION').'/'.$action.$str;  
  23.                 }  
  24.                 break;  
  25.             case 2:// 智能PATHINFO模式  
  26.                 $depr   =   C('PATH_DEPR');  
  27.                 $str    =   $depr;  
  28.                 foreach ($params as $var=>$val)  
  29.                     $str .= $var.$depr.$val.$depr;  
  30.                 $str = substr($str,0,-1);  
  31.                 if(!emptyempty($route)) {  
  32.                     $url    =   str_replace(APP_NAME,$app,).'/'.$route.$str;  
  33.                 }else{  
  34.                     $url    =   str_replace(APP_NAME,$app,).'/'.$module.$depr.$action.$str;  
  35.                 }  
  36.                 break;  
  37.         }  
  38.         if(C('HTML_URL_SUFFIX')) {  
  39.             $url .= C('HTML_URL_SUFFIX');  
  40.         }  
  41.     }else{  
  42.         $params =   http_build_query($params);  
  43.         if(!emptyempty($route)) {  
  44.             $url    =   str_replace(APP_NAME,$app,).'?'.C('VAR_ROUTER').'='.$route.'&'.$params;  
  45.         }else{  
  46.             $url    =   str_replace(APP_NAME,$app,).'?'.C('VAR_MODULE').'='.$module.'&'.C('VAR_ACTION').'='.$action.'&'.$params;  
  47.         }  
  48.     }  
  49.     return $url;  
  50. }  
  51. ?>  
PHP代码
  1.  
  2. require_once 'functions.php';  
  3.   
  4. class functionsTest extends PHPUnit_Framework_TestCase  
  5. {  
  6.     /** 
  7.      * 确认url()返回预期的字符串 
  8.      */  
  9.     public function testurl()  
  10.     {  
  11.         define('', 'index.php');  
  12.   
  13.         C('VAR_MODULE', 'module');  
  14.         C('VAR_ACTION', 'action');  
  15.         C('VAR_ROUTER', 'route');  
  16.   
  17.         // 测试通常模式URL  
  18.         $uri = url('Index', 'Home', '', APP_NAME, array('q' => 'test', 'msg' => 'OK'));  
  19.         $this->assertEquals('index.php?module=Home&action=Index&q=test&msg=OK', $uri);  
  20.   
  21.         // 测试通常模式路由  
  22.         $uri = url('Index', 'Home', 'default', APP_NAME, array('q' => 'test', 'msg' => 'OK'));  
  23.         $this->assertEquals('index.php?route=default&q=test&msg=OK', $uri);  
  24.   
  25.          
  26.         C('DISPATCH_ON', true);  
  27.         C('URL_MODEL', 1);  
  28.         C('PATH_MODEL', 1);  
  29.          
  30.         // 测试普通PATHINFO模式URL  
  31.         $uri = url('Index', 'Home', '', APP_NAME, array('q' => 'test', 'msg' => 'OK'));  
  32.         $this->assertEquals('index.php/module/Home/action/Index/q/test/msg/OK', $uri);  
  33.   
  34.         // 测试普通PATHINFO模式路由  
  35.         $uri = url('Index', 'Home', 'default', APP_NAME, array('q' => 'test', 'msg' => 'OK'));  
  36.         $this->assertEquals('index.php/route/default/q/test/msg/OK', $uri);  
  37.   
  38.         C('PATH_MODEL', 2);  
  39.         C('PATH_DEPR', '/');  
  40.   
  41.         // 测试智能PATHINFO模式URL  
  42.         $uri = url('Index', 'Home', '', APP_NAME, array('q' => 'test', 'msg' => 'OK'));  
  43.         $this->assertEquals('index.php/Home/Index/q/test/msg/OK', $uri);  
  44.   
  45.         // 测试智能PATHINFO模式路由  
  46.         $uri = url('Index', 'Home', 'default', APP_NAME, array('q' => 'test', 'msg' => 'OK'));  
  47.         $this->assertEquals('index.php/default/q/test/msg/OK', $uri);  
  48.     }  
  49. }  
  50. ?>  

异常测试

有时程序执行了非法操作而抛出异常，我们需要模拟某个异常，然后捕捉它是否触发了该异常。

PHP代码
  1.  
  2. class UnitTest extends PHPUnit_Framework_TestCase  
  3. {  
  4.     /** 
  5.      * 测试异常 
  6.      */  
  7.     public function testException()  
  8.     {  
  9.         // 期望Exception异常  
  10.         $this->setExpectedException('Exception');  
  11.   
  12.         // 抛出Exception异常  
  13.         throw new Exception('TestException');  
  14.     }  
  15. }  
  16. ?>  

输出测试

有时某个方法并不返回而输出某些内容，我们需要继承PHPUnit_Extensions_OutputTestCase类来捕捉输出内容。PHPUnit默认不载入扩展类，需要自己加载。

PHP代码
  1.  
  2. // 载入输出测试用例扩展  
  3. require_once 'PHPUnit/Extensions/OutputTestCase.php';  
  4.   
  5. class UnitTest extends PHPUnit_Extensions_OutputTestCase  
  6. {  
  7.     /** 
  8.      * 测试输出 
  9.      */  
  10.     public function testOutput()  
  11.     {  
  12.         // 期望输出的内容是字符串 'Hello'  
  13.         $this->expectOutputString('Hello');  
  14.   
  15.         // 输出 'Hello'  
  16.         echo 'Hello';  
  17.     }  
  18. }  
  19. ?>  

数据库测试

PHPUnit的数据库测试并不完善，只提供了assertTablesEqual和assertDataSetsEqual两个断言与createFlatXMLDataSet和createXMLDataSet创建XML数据集的方法。无法进行全面的数据操作测试，建议使用DBUnit。

附录

PHPUnit断言参考
assertArrayHasKey($key, array $array, $message = '')
assertArrayNotHasKey($key, array $array, $message = '')
assertAttributeContains($needle, $haystackAttributeName, $haystackClassOrObject, $message = '')
assertAttributeContainsOnly($type, $haystackAttributeName, $haystackClassOrObject, $isNativeType = NULL, $message = '')
assertAttributeEquals($expected, $actualAttributeName, $actualClassOrObject, $message = '', $delta = 0, $maxDepth = 10, $canonicalizeEol = FALSE)
assertAttributeGreaterThan($expected, $actualAttributeName, $actualClassOrObject, $message = '')
assertAttributeGreaterThanOrEqual($expected, $actualAttributeName, $actualClassOrObject, $message = '')
assertAttributeLessThan($expected, $actualAttributeName, $actualClassOrObject, $message = '')
assertAttributeLessThanOrEqual($expected, $actualAttributeName, $actualClassOrObject, $message = '')
assertAttributeNotContains($needle, $haystackAttributeName, $haystackClassOrObject, $message = '')
assertAttributeNotContainsOnly($type, $haystackAttributeName, $haystackClassOrObject, $isNativeType = NULL, $message = '')
assertAttributeNotEquals($expected, $actualAttributeName, $actualClassOrObject, $message = '', $delta = 0, $maxDepth = 10, $canonicalizeEol = FALSE)
assertAttributeNotSame($expected, $actualAttributeName, $actualClassOrObject, $message = '')
assertAttributeSame($expected, $actualAttributeName, $actualClassOrObject, $message = '')
assertClassHasAttribute($attributeName, $className, $message = '')
assertClassHasStaticAttribute($attributeName, $className, $message = '')
assertClassNotHasAttribute($attributeName, $className, $message = '')
assertClassNotHasStaticAttribute($attributeName, $className, $message = '')
assertContains($needle, $haystack, $message = '')
assertContainsOnly($type, $haystack, $isNativeType = NULL, $message = '')
assertEqualXMLStructure(DOMNode $expectedNode, DOMNode $actualNode, $checkAttributes = FALSE, $message = '')
assertEquals($expected, $actual, $message = '', $delta = 0, $maxDepth = 10, $canonicalizeEol = FALSE)
assertFalse($condition, $message = '')
assertFileEquals($expected, $actual, $message = '', $canonicalizeEol = FALSE)
PHPUnit官方文档
http://www.phpunit.de/manual/3.3/en/index.html


火龙果软件/UML软件工程组织致力于提高您的软件工程实践能力，我们不断地吸取业界的宝贵经验，向您提供经过数百家企业验证的有效的工程技术实践经验，同时关注最新的理论进展，帮助您“领跑您所在行业的软件世界”。
资源网站: UML软件工程组织