在PHPUnit中测试可迭代项

在PHPUnit中,很容易断言两个数组包含相同的值：

 $this->assertEquals( [1, 2, 3], [1, 2, 3] );

PHP的最新版本使Iterators和Generators的使用更具吸引力,PHP 7.1引入了the iterable pseudo-type.这意味着我可以编写函数以接受和返回Iterable,而不必绑定到我正在使用普通旧数组或使用惰性Generator的事实.

我如何断言返回可迭代函数的返回值？理想情况下,我可以做类似的事情

 $this->assertIterablesEqual( ['expected', 'values'], $iterable );

有这样的功能吗？或者,是否有一种明智的测试方法,而无需在我的测试中添加大量的“除点外”命令式代码？

解决方法:

我认为您需要先包装Iterable.例如,可以在名为ForeachIterator的Iterator Garden中找到Iterable的装饰器,它是decorating anything foreach-able作为Traversable：

$iterator = new ForeachIterator($iterable);
$this->assertEquals( [1, 2, 3], itarator_to_array($iterator));

请注意细节,该细节还将考虑该测试中的对象Iterable,对于正确的测试而言,该对象不够严格.

但是,这应该很容易在测试中转换为私有帮助器方法,以便仅将数组和可遍历对象(而非不可遍历对象)转换为迭代器/数组并应用断言：

private function assertIterablesEqual(array $expected, iterable $actual, $message = '')
{
    $array = is_array($actual) ? $actual : iterator_to_array($actual);
    $this->assertEquals($expected, $array, $message);
}

可以进一步为extracted into an assertion class to extend Phpunit itself.

请注意,iterator_to_array将用重复键替换条目,从而产生具有重复键的最后迭代值的数组.如果还需要声明迭代键,则可能有必要修饰或更改遍历方法.