欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

php单元测试进阶(9)- 核心技术 - 桩件(stub) - 工厂类注入桩件 博客分类: PHP phpunit单元测试php单元测试进阶 

程序员文章站 2024-02-16 08:22:04
...
php单元测试进阶(9)- 核心技术 - 桩件(stub) - 工厂类注入桩件

本系列文章主要代码与文字来源于《单元测试的艺术》,原作者:Roy Osherove。译者:金迎。

本系列文章根据php的语法与使用习惯做了改编。所有代码在本机测试通过。如转载请注明出处。
这一节讨论的场景是:你在对一个对象进行操作之前才能得到其实例,而不是通过构造方法或者属性注入得到。换句话说,桩件(通过工厂类)和调用桩件的方法联系更加紧密。

这种情况的不同之处在于发起桩件请求的对象是被测试代码。而之前几节中,那些伪对象是在测试开始之前,由被测代码之外的代码设置的。

工厂模式是一种设计模式,允许另一个类负责创建对象。
为了增强控制,方便测试,本示例中的工厂有一个set方法可以注入桩件。
使用这种技术实现的测试代码可读性好,不同的类之间界限清晰,每个类各自负责不同的行为。
在上上文中,有一个全部代码的清单。上文没有,为了便于观看,本文给出全部代码。
注意,又多了一个工厂类,在源代码中,现在源代码4个文件,测试2个文件(这么多工作只是为了测试一句调用文件管理器的代码,但值得,后面会有用单元测试专门的mock类库来写桩件)。
注意到接口,和接口的两个实现代码完全不变。
源代码

(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下,工厂类,返回一个实现了上面的接口的对象,为了方便测试,可以被注入。
ExtensionManagerFactory.php
<?php
namespace app\index\controller;

/**
 * 静态工厂类,返回实现IExtensionManager接口的对象,
 * 分离代码的功能。
 */
class ExtensionManagerFactory
{
    /**
     * @var IExtensionManager
     */
    private static $manager = null;

    /**
     * 通过此方法,可以注入桩件或正常的对象
     * @param unknown $mgr
     */
    public static function setManager($mgr)
    {
        self::$manager = $mgr;
    }

    /**
     * 工厂方法,能看到有一个默认的实现
     * @return \app\index\controller\IExtensionManager
     */
    public static function create()
    {
        if (self::$manager) {
            return self::$manager;
        }
        return new FileExtensionManager();
    }
}

(4)t2\application\index\controller下被测类,日志分析器。使用了构造方法注入的方式来写代码,便于测试
LogAnalyzer.php
<?php
namespace app\index\controller;

/**
 * 日志分析器类,也是被测类
 * 
 * 注意,这是用静态工厂注入桩件的例子。
 */
class LogAnalyzer
{
    /**
     * @var IExtensionManager
     */
    private $manager;

    public function __construct()
    {
        // 在源代码中使用工厂类
        $this->manager = ExtensionManagerFactory::create();
    }

    /**
     * 判断文件名是否有效,调用另一个类来实现
     * @param string $filename
     */
    public function isValidLogFileName($filename)
    {
        return $this->manager->isValid($filename);
    }
}

测试代码
(5)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;
    }
}

(6)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; 
        \app\index\controller\ExtensionManagerFactory::setManager($myFakeManager);

        //开始创建被测类的对象,准备测试
        $analyzer = new \app\index\controller\LogAnalyzer();
        $result = $analyzer->isValidLogFileName("short.ext");
        $this->assertTrue($result);
    }
}

cmd下测试通过

上一篇:php单元测试进阶(8)- 核心技术 - 桩件(stub) - 属性注入桩件
下一篇:php单元测试进阶(10)- 核心技术 - 桩件(stub) - 调用方法注入桩件