如何使用PHPUnit模拟实现Iterator接口的类?

时间:2013-04-09 16:19:42

标签: php iterator mocking phpunit

如何以强大的方式模拟实现Iterator接口的类的依赖项?

3 个答案:

答案 0 :(得分:20)

已经有一些现有的解决方案可以解决这个问题,但我见过的所有解决方案都有类似的弱点:它们依赖于->expects($this->at(n))。 PHPUnit中的'expected at'函数有一些奇怪的行为,因为计数器用于模拟的每个方法调用。这意味着如果您在直接foreach之外调用迭代器,则必须调整迭代器模拟。

解决方案是创建一个包含基本迭代器数据(源数组和位置)的对象,并将其传递到returnCallback闭包中。因为它是通过引用传递的,所以对象在调用之间保持最新,所以我们可以模拟每个方法来模拟一个简单的迭代器。现在我们可以正常使用迭代器模拟,而不必担心严格的调用顺序。

下面的示例方法,您可以使用它来设置迭代器模拟:

/**
 * Setup methods required to mock an iterator
 *
 * @param PHPUnit_Framework_MockObject_MockObject $iteratorMock The mock to attach the iterator methods to
 * @param array $items The mock data we're going to use with the iterator
 * @return PHPUnit_Framework_MockObject_MockObject The iterator mock
 */
public function mockIterator(PHPUnit_Framework_MockObject_MockObject $iteratorMock, array $items)
{
    $iteratorData = new \stdClass();
    $iteratorData->array = $items;
    $iteratorData->position = 0;

    $iteratorMock->expects($this->any())
                 ->method('rewind')
                 ->will(
                     $this->returnCallback(
                         function() use ($iteratorData) {
                             $iteratorData->position = 0;
                         }
                     )
                 );

    $iteratorMock->expects($this->any())
                 ->method('current')
                 ->will(
                     $this->returnCallback(
                         function() use ($iteratorData) {
                             return $iteratorData->array[$iteratorData->position];
                         }
                     )
                 );

    $iteratorMock->expects($this->any())
                 ->method('key')
                 ->will(
                     $this->returnCallback(
                         function() use ($iteratorData) {
                             return $iteratorData->position;
                         }
                     )
                 );

    $iteratorMock->expects($this->any())
                 ->method('next')
                 ->will(
                     $this->returnCallback(
                         function() use ($iteratorData) {
                             $iteratorData->position++;
                         }
                     )
                 );

    $iteratorMock->expects($this->any())
                 ->method('valid')
                 ->will(
                     $this->returnCallback(
                         function() use ($iteratorData) {
                             return isset($iteratorData->array[$iteratorData->position]);
                         }
                     )
                 );

    $iteratorMock->expects($this->any())
                 ->method('count')
                 ->will(
                     $this->returnCallback(
                         function() use ($iteratorData) {
                             return sizeof($iteratorData->array);
                         }
                     )
                 );

    return $iteratorMock;
}

答案 1 :(得分:5)

如果您只需要针对通用迭代器进行测试,那么PHP(在SPL扩展中 - 无法在PHP> 5.3中关闭)内置了实现Iterable的数组包装:SPL Iterators。 e.g。

$mock_iterator = new \ArrayIterator($items);
$test_class->methodExpectingGenericIterator($mock_iterator);
$resulting_data = $mock_iterator->getArrayCopy();

答案 2 :(得分:2)

这是一个结合了两全其美的解决方案,内部使用WordDelimiterFilterFactory

ArrayIterator