如何模拟对象工厂

Question

我经常使用工厂（请参阅http://www.php.net/manual/en/language.oop5.patterns.php 了解模式）来提高代码的可测试性。一个简单的工厂可能如下所示：

class Factory
{
    public function getInstanceFor($type)
    {
        switch ($type) {
            case 'foo':
                return new Foo();
            case 'bar':
                return new Bar();
        }
    }
}

这是一个使用该工厂的示例类：

class Sample
{
    protected $_factory;

    public function __construct(Factory $factory)
    {
        $this->_factory = $factory;
    }

    public function doSomething()
    {
        $foo = $this->_factory->getInstanceFor('foo');
        $bar = $this->_factory->getInstanceFor('bar');
        /* more stuff done here */
        /* ... */
    }
}

现在，为了进行正确的单元测试，我需要模拟将为类返回存根的对象，这就是我卡住的地方。我认为可以这样做：

class SampleTest extends PHPUnit_Framework_TestCase
{
    public function testAClassUsingObjectFactory()
    {
        $fooStub = $this->getMock('Foo');
        $barStub = $this->getMock('Bar');

        $factoryMock = $this->getMock('Factory');

        $factoryMock->expects($this->any())
            ->method('getInstanceFor')
            ->with('foo')
            ->will($this->returnValue($fooStub));

        $factoryMock->expects($this->any())
            ->method('getInstanceFor')
            ->with('bar')
            ->will($this->returnValue($barStub));
    }
}

但是当我运行测试时，我得到的是：

F

Time: 0 seconds, Memory: 5.25Mb

There was 1 failure:

1) SampleTest::testDoSomething
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-bar
+foo

FAILURES!
Tests: 1, Assertions: 0, Failures: 1.

所以显然不可能让模拟对象以这种方式根据传递的方法参数返回不同的值。

如何做到这一点？

Answer 1

问题是 PHPUnit Mocking 不允许你这样做：

$factoryMock->expects($this->any())
        ->method('getInstanceFor')
        ->with('foo')
        ->will($this->returnValue($fooStub));

$factoryMock->expects($this->any())
        ->method('getInstanceFor')
        ->with('bar')
        ->will($this->returnValue($barStub));

每个->method(); 只能有一个expects。它不知道->with()的参数不同！

所以你只需用第二个覆盖第一个->expects()。这就是这些断言的实现方式，而不是人们所期望的。但是有一些解决方法。

---

您需要用行为/返回值定义一个期望！

见：Mock in PHPUnit - multiple configuration of the same method with different arguments

当根据您的问题调整示例时，它可能如下所示：

$fooStub = $this->getMock('Foo');
$barStub = $this->getMock('Bar');

$factoryMock->expects($this->exactly(2))
       ->method('getInstanceFor')
       ->with($this->logicalOr(
                 $this->equalTo('foo'), 
                 $this->equalTo('bar')
        ))
       ->will($this->returnCallback(
            function($param) use ($fooStub, $barStub) {
                if($param == 'foo') return $fooStub;
                return $barStub;
            }
       ));

Answer 2

创建一个简单的存根工厂类，其构造函数采用它应该返回的实例。

class StubFactory extends Factory
{
    private $items;

    public function __construct(array $items)
    {
        $this->items = $items;
    }

    public function getInstanceFor($type)
    {
        if (!isset($this->items[$type])) {
            throw new InvalidArgumentException("Object for $type not found.");
        }
        return $this->items[$type];
    }
}

你可以在任何单元测试中重用这个类。

class SampleTest extends PHPUnit_Framework_TestCase
{
    public function testAClassUsingObjectFactory()
    {
        $fooStub = $this->getMock('Foo');
        $barStub = $this->getMock('Bar');

        $factory = new StubFactory(array(
            'foo' => $fooStub,
            'bar' => $barStub,
        ));

        ...no need to set expectations on $factory...
    }
}

为了完整起见，如果您不介意编写脆弱的测试，您可以在原始代码中使用 at($index) 而不是 any()。 如果被测系统更改了调用工厂的顺序或次数，这将中断，但它很容易编写。

$factoryMock->expects($this->at(0))
        ->method('getInstanceFor')
        ->with('foo')
        ->will($this->returnValue($fooStub));

$factoryMock->expects($this->at(1))
        ->method('getInstanceFor')
        ->with('bar')
        ->will($this->returnValue($barStub));

Answer 3

你应该改变你的“业务逻辑”......我的意思是你不必将 Factory 传递给 Sample 构造函数，你必须传递你需要的确切参数