如何在phpunit中模拟（mock）一个单例类

如何在phpunit中模拟（mock）一个单例类

一 Mock简介
当我们对A类进行单元测试时，A类可能依赖了B类，为了减少依赖，方便A类方法的测试，我们可以模拟一个B类，简单规定其各方法的返回值（而非真正实现具体逻辑）。
Phpunit中提供了一套模拟类的api，简单使用如下：

class StubTest extends PHPUnit_Framework_TestCase
{
public function testStub()
{
// Create a stub for the SomeClass class.
$stub = $this->getMock(‘SomeClass’);
// Configure the stub.
$stub->expects($this->any())
->method(‘doSomething’)
->will($this->returnValue(‘foo’));
// Calling $stub->doSomething() will now return ‘foo’.
$this->assertEquals(‘foo’, $stub->doSomething());
}
}

在这个例子中，我们得到了一个’SomeClass’的模拟，规定其可以被调用任意次，如果调用doSomething方法，将得到值foo。

二 问题
我们知道，对于一个单例类，其constructor方法为private，而getMock的实现，默认是要调用原类的constructor方法。
如果SomeClass为单例，phpunit将会提示
Call to private SomeClass::__construct() from context ‘PHPUnit_Framework_TestCase’

这时，我们的测试该如何进行呢？

三 解决
仍然使用getMock进行模拟。
只要将其第5个参数设为false即可。其含意是：不调用原对象的构造函数。
$stub = $this->getMock(‘SomeClass’, array(), array(), ”, false);

不得不说，这样使用有点复杂。

如果你使用的是phpunit3.5及以上版本, 那么有更易用的api。你可以这样禁掉对原有constructor方法的调用：

$stub=$this->getMockBuilder(‘SomeClass’)->disableOriginalConstructor()->getMock();

附：
对getMock的6个可选参数的详解，参见：http://www.phpunit.de/manual/3.6/en/test-doubles.html

手册中并未提及它们的默认值，经测试得到结果如下，贴出来方便大家使用。
array(), array(), ”, false, false, false
即
$stub=$this->getMockBuilder(‘SomeClass’)
等同于：
$stub=$this->getMockBuilder(‘SomeClass’，array(), array(), ”, true, false, false)