php单元测试进阶（11）- 核心技术 - 桩件(stub) - 不使用桩件

php单元测试进阶（11）- 核心技术 - 桩件(stub) - 不使用桩件

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

本系列文章根据php的语法与使用习惯做了改编。所有代码在本机测试通过。如转载请注明出处。
上文介绍了通过创建一个局部的方法调用返回桩件，然后测试时用派生的子类来进行测试。
但是对于本文的示例来说，还有更简单的办法，不用桩件，也不用接口。
在被测类中，不是添加返回桩件的方法，而是添加直接返回计算结果的方法，然后在子类中覆盖这个方法，以此来回避对文件系统等外部依赖的调用。
因为这个方法最简单，所以可以优先考虑使用。

来对比一下上文的代码：需要去除接口，去除测试类中的接口实现。保留文件管理器类，保留被测类。修改被测类子类，修改被测类。
上文是源代码3个文件，测试代码3个文件。
现在是源代码2个文件，测试代码2个文件。
下面是全部代码：(所有的代码都有改动)

源代码

（1）t2\application\index\controller下文件管理器类，实现了上面的接口，但是实际被排除在单元测试之外，不测它。应该使用集成测试来测试此类。
FileExtensionManager.php

<?php
namespace app\index\controller;

/**
 * 文件管理器类
 *
 */
class FileExtensionManager 
{
    /**
     * 根据某个配置文件的内容判断文件名是否有效
     * @param string $filename
     */
    public function isValid($filename)
    {
        // 会使用file_get_contents函数读取某个文件的内容
        // 这里为了简略不写，因为不是重点。
        return true;
    }
}

（2）t2\application\index\controller下被测类，日志分析器。使用了调用直接返回计算结果的方式来写代码，便于派生类覆盖，然后测试
LogAnalyzer.php

<?php
namespace app\index\controller;

/**
 * 日志分析器类，也是被测类
 * 
 * 注意，这是不用桩件和接口的例子。
 */
class LogAnalyzer
{
    /**
     * 判断文件名是否有效，调用另一个类来实现
     * @param string $filename
     */
    public function isValidLogFileName($filename)
    {
        return $this->isValid($filename);
    }

    /**
     * @param string $filename
     * @return boolean
     */
    protected function isValid($filename)
    {
        return (new FileExtensionManager())->isValid($filename);
    }
}

测试代码

（3）t2\tests\index\controller\下，被测试类的子类，用于覆盖直接返回计算结果的方法，便于测试。因为这个子类测试专用，所以当然放在测试文件夹下。
LogAnalyzerExtend.php

<?php
namespace tests\index\controller;

/**
 * 测试辅助类，是源代码被测类的子类。用于覆盖原被测类的方法，便于测试。
 * 这里还允许外部注入属性，以便于控制方法返回的结果。
 */
class LogAnalyzerExtend extends \app\index\controller\LogAnalyzer
{
    /**
     * @var boolean
     */
    public $isSupported;

    /**
     * 覆盖原方法，便于测试
     * @return boolean
     */
    protected function isValid($filename)
    {
        return $this->isSupported;
    }
}

（4）t2\tests\index\controller\下，最后是测试类，但不是测试被测试类，而是测试被测试类的子类。和上文不同的是，覆盖的是直接返回计算结果的方法。上文覆盖返回产生桩件的方法。
LogAnalyzerTest.php

<?php
namespace tests\index\controller;

/**
 * 测试用的类
 */
class LogAnalyzerTest extends \think\testing\TestCase
{

    /**
     * @test
     * 使用覆盖父类的直接返回计算结果的方法 进行测试
     * 注意，尽量使得测试的方法名称有意义，这非常重要，便于维护测试代码。有规律
     */
    public function isValidFileName_NameSupportedExtension_ReturnTrue()
    {
        //开始创建被测类的子类的对象，并注入控制的结果到字段里
        $analyzer = new LogAnalyzerExtend();
        $analyzer->isSupported = true;

        //调用并断言
        $result = $analyzer->isValidLogFileName("short.ext");
        $this->assertTrue($result);
    }
}

cmd下测试通过。

上一篇：php单元测试进阶（10）- 核心技术 - 桩件(stub) - 调用方法注入桩件
下一篇：php单元测试进阶（12）- 核心技术 - mock对象