php单元测试进阶(7)- 核心技术 - 桩件(stub) - 构造函数注入桩件
本系列文章主要代码与文字来源于《单元测试的艺术》,原作者:Roy Osherove。译者:金迎。
本系列文章根据php的语法与使用习惯做了改编。所有代码在本机测试通过。如转载请注明出处。
源代码
(1)t2\application\index\controller下根据测试需要(实际是解耦,让程序更加结构清晰)提取的接口
IExtensionManager.php
<?php
namespace app\index\controller;
/**
* 文件名是否有效接口
* 源代码中的文件管理器类会实现,一个桩件也会实现
* 接口的存在,让所有代码的含义更加清晰,稳定。
*/
interface IExtensionManager
{
/**
* 判断文件名是否有效
* @param string $filename
* @return boolean
*/
public function isValid($filename);
}
(2)t2\application\index\controller下文件管理器类,实现了上面的接口,但是实际被排除在单元测试之外,不测它。应该使用集成测试来测试此类。
FileExtensionManager.php
<?php
namespace app\index\controller;
/**
* 文件管理器类
*
*/
class FileExtensionManager implements IExtensionManager
{
/**
* 根据某个配置文件的内容判断文件名是否有效
* @param string $filename
*/
public function isValid($filename)
{
// 会使用file_get_contents函数读取某个文件的内容
// 这里为了简略不写,因为不是重点。
return true;
}
}
(3)t2\application\index\controller下被测类,日志分析器。使用了构造方法注入的方式来写代码,便于测试
LogAnalyzer.php
<?php
namespace app\index\controller;
/**
* 日志分析器类,也是被测类
*
* 注意,这是用构造方法注入的例子。
*/
class LogAnalyzer
{
/**
* @var IExtensionManager
*/
private $manager;
public function __construct(IExtensionManager $mgr)
{
$this->manager = $mgr;
}
/**
* 判断文件名是否有效,调用另一个类来实现
* @param string $filename
*/
public function isValidLogFileName($filename)
{
return $this->manager->isValid($filename);
}
}
测试代码
(4)t2\tests\index\controller\下,桩件类,用于替换文件管理器,便于测试
FakeExtensionManager.php
<?php
namespace tests\index\controller;
/**
* 一个桩件类,用于测试日志分析器,因为日志分析会读取文件,妨碍单元测试。
*/
class FakeExtensionManager implements \app\index\controller\IExtensionManager
{
public $willBeValid = false;
/**
* 根据某个配置文件的内容判断文件名是否有效
* @param string $filename
*/
public function isValid($filename)
{
return $this->willBeValid;
}
}
(5)t2\tests\index\controller\下,最后是测试类,用构造方法注入桩件
LogAnalyzerTest.php
<?php
namespace tests\index\controller;
/**
* 测试用的类
*/
class LogAnalyzerTest extends \think\testing\TestCase
{
/**
* @test
* 使用构造器注入桩件的方法 进行测试
* 注意,尽量使得测试的方法名称有意义,这非常重要,便于维护测试代码。有规律
*/
public function isValidFileName_NameSupportedExtension_ReturnTrue()
{
//准备好一个返回true的桩件
$myFakeManager = new FakeExtensionManager();
$myFakeManager->willBeValid = true;
//开始创建被测类的对象,准备测试
$analyzer = new \app\index\controller\LogAnalyzer($myFakeManager);
$result = $analyzer->isValidLogFileName("short.ext");
$this->assertTrue($result);
}
}
打开cmd窗口,测试通过。
额外说明,本文里,源代码的组织方式位于同一命名空间内,实际至少不应放在控制器命名空间下,本文为了简便放一起。还有,测试代码倒无所谓,放一起挺好
上一篇:php单元测试进阶(6)- 核心技术 - 桩件(stub)
下一篇:php单元测试进阶(8)- 核心技术 - 桩件(stub) - 属性注入桩件