php单元测试进阶(12)- 核心技术 - mock对象

php单元测试进阶(12)- 核心技术 - mock对象

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

本系列文章根据php的语法与使用习惯做了改编。所有代码在本机测试通过。如转载请注明出处。
前面几节利用了桩件使得测试代码可以得到所需要的输入,独立的测试了代码的逻辑。

工作单元可能有三种最终结果,目前为止你编写过的测试只针对前两种:返回值(基于值的测试)和改变系统状态(基于状态的测试)。

现在我们要检验一个对象(被测对象)是否正确的调用了其他对象(被调用对象),即检验交互测试。被测试的对象可能不会返回任何结果,或者保存任何状态。而被调用的对象不受你的控制,或者不是被测试单元的一部分。之前的办法不适用。因为没有外部API可以检验被测对象内部是否发生了变化。这时我们需要用mock,即模拟对象。

交互测试

交互测试是对一个对象如何向其他对象发送消息(即调用其他对象)的测试。如果一个特定的工作单元的最终结果是调用另一个对象,你就需要进行交互测试。

请总是把交互测试作为最后的选择,优先使用前两种测试。交互测试很复杂。

模拟对象(mock对象)

模拟对象是系统中的伪对象,它可以验证被测对象是否按预期的定义调用了这个伪对象,因此导致单元测试通过或是失败。通常每个测试最多有一个模拟对象

伪对象

伪对象是通用的术语,可以描述一个桩件(stub)或者mock对象(手工或非手工编写),因为桩件和mock对象看上去都很象真实对象。一个伪对象究竟是桩件还是mock对象,取决于它在当前测试中的使用方式:如果这个伪对象用来检验一个交互测试(对其进行断言),它就是mock对象,否则就是桩件stub

mock对象和桩件的差别

桩件:被测类和桩件通信交互,测试类中对被测类断言,永远不会对桩件断言。
mock对象:被测类和mock对象通信交互,测试类中,对mock对象断言。

手工创建mock对象

创建和使用mock对象的方法和使用桩件类似,只是mock对象比桩件多做一件事:它保存通信交互的历史记录,这些记录之后用于预期验证(就是可以被断言)。

需求变更

为了学习mock对象技术,改变之前的源代码日志分析器LogAnalyzer类的代码功能。
其有一个方法,接收一个文件名参数,如果文件名长度小于8个字符,则向某web服务发送一个记录错误日志消息,或者说调用一个其他对象的记录错误日志方法。

因为这个web服务的代码还没写,因此,你需要重构设计,创建一个新接口,之后用这个接口创建mock对象。这个接口只包括你需要调用的web服务的记录错误日志方法(一个服务通常提供多个方法,这里暂且不管)。

源代码

以下给出学习mock对象的全部代码(原先的代码全部废止):
源代码2个文件,接口,被测类。
测试文件有2个文件,一个mock类,一个测试类。

首先要抽取一个接口。被测代码可以使用这个接口,而不是直接调用web服务,这个接口既可以用于创建桩件,也可以创建mock对象,避免一个无法控制的外部依赖。
(1)\t2\application\index\controller下
IWebService.php

<?php
namespace app\index\controller;

/**
 * 记录错误日志的接口,供mock对象和真正的对象实现
 * 
 */
interface IWebService
{
    /**
     * 记录错误日志
     * @param string $message
     */
    public function logError($message);
}

(2)被测类,实现需求的源代码
\t2\application\index\controller下
LogAnalyzer.php

<?php
namespace app\index\controller;
use app\index\controller\IWebService;
/**
 * 日志分析器类,也是被测类
 * 
 * 这是使用mock对象的例子。
 */
class LogAnalyzer
{
    /**
     * @var IWebService
     */
    private $service;
    
    /**
     * 构造方法注入服务
     * @param IWebService $service
     */
    public function __construct(IWebService $service)
    {
        $this->service = $service;
    }
    
    /**
     * 分析日志,省略无关功能,只检查文件名是否过短。
     * @param string $filename
     */
    public function analyze($filename)
    {
        if (strlen($filename) < 8 ) {
            $this->service->logError("Filename too short:{$filename}");
        }
        // 做一些其他的事情。
        // ... ...
    }
}

测试代码

(3)创建mock对象的类,这个对象看起来很象桩件,但是它包含了一点额外的代码,变成了一个mock对象。即有一个字段存储了状态信息。然后测试时可以对此字段的值进行断言,以此验证mock对象是否被正确调用。它现在还不是mock对象,只有当你在测试中把它作为mock对象使用并断言,它才成为mock对象。
因为是mock的,所以放在了测试文件夹下,\t2\tests\index\controller\下,
FakeWebService.php

<?php
namespace tests\index\controller;

/**
 * mock类
 */
class FakeWebService implements \app\index\controller\IWebService
{
    /**
     * @var string
     */
    public $lastError;
    
    /**
     * 记录错误日志,伪实现
     * @param string $message 
     */
    public function logError($message)
    {
        $this->lastError = $message;
    }
}

(4)测试类,\t2\tests\index\controller下,
LogAnalyzerTest.php

<?php
namespace tests\index\controller;

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

    /**
     * @test
     * 对mock对象断言
     * 注意,尽量使得测试的方法名称有意义,这非常重要,便于维护测试代码。有规律
     */
    public function analyze_TooShortFileName_CallsWebService()
    {
        //开始创建mock对象
        $mockService = new FakeWebService();
        
        // 创建被测类的对象,注入mock对象
        $analyzer = new \app\index\controller\LogAnalyzer($mockService);
        $tooShortFileName= 'abc.ext';
        
        //调用被测对象
        $analyzer->analyze($tooShortFileName);
        
        // 注意是对mock对象断言!!
        $this->assertEquals($mockService->lastError, "Filename too short:{$tooShortFileName}");
    }
}

cmd下测试通过。

注意断言不是写在mock对象内部,原因如下:

  1. 你希望其他测试用例能复用这个mock对象。
  2. 如果断言写在手工编写的伪造类内部,别人很难看到断言具体什么。这种做法对测试代码隐藏了关键信息,降低了测试代码的可读性与可维护性。

最后记住,一个测试有多个桩件完全可能,但是有多个mock对象会产生麻烦,因为多个mock对象说明你同时测试了多件事情,别这么做!可以拆分测试成多个。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容