PHPUnit 的 returnValueMap 未产生预期结果

2022-08-30 11:07:05

我正在尝试使用PHPUnit的returnValueMap()来存根读取的结果。它不会产生预期的结果,但等效的 returnCallback() 会。我已经提供了我的测试用例,如果你想自己检查它。

returnValueMap()

$enterprise = $this->getMock('Enterprise', array('field'));
$enterprise->expects($this->any())
    ->method('field')
    ->will($this->returnValueMap(array(
        array('subscription_id', null),
        array('name', 'Monday Farms')
    )));
$enterprise->subscribe('basic');

结果:

Subscription ID: NULL
Name: NULL

returnCallback()

$enterprise = $this->getMock('Enterprise', array('field'));
$enterprise->expects($this->any())
    ->method('field')
    ->will($this->returnCallback(function ($arg) {
        $map = array(
            'subscription_id' => null,
            'name' => 'Monday Farms'
        );
        return $map[$arg];
    }));
$enterprise->subscribe('basic');

结果:

Subscription ID: NULL
Name: string(12) "Monday Farms"

企业::订阅

public function subscribe() {
    echo 'Subscription ID: ';
    var_dump($this->field('subscription_id'));
    echo 'Name: ';
    var_dump($this->field('name'));
}

为什么 returnValueMap() 不能按预期工作?我到底错过了什么?


答案 1

我遇到了同样的问题,最终发现 returnValueMap() 必须映射函数的所有参数,包括可选参数,然后是所需的返回值。

来自Zend Framework的示例函数:

public function getParam($key, $default = null)
{
    $key = (string) $key;
    if (isset($this->_params[$key])) {
        return $this->_params[$key];
    }

    return $default;
}

必须像这样映射:

$request->expects($this->any())
        ->method('getParam')
        ->will($this->returnValueMap(array(array($param, null, $value))));

如果没有中间的 null,它将不起作用。


答案 2

我一直在寻找同样的问题,最终出于绝望,通过Framework/MockObject/Stub/ReturnValueMap.php和Framework/MockObject/InvocationMocker.php[在方法InvocationMocker::invoke(PHPUnit_Framework_MockObject_Invocation $invocation)]中,我观察到以下几点:

  1. 调用 stubbed 函数时,您提供的 map 数组中的值不仅必须与预期参数相同,而且它们必须具有相同的类型。这是因为在 Framework/MockObject/Stub/ReturnValueMap.php ReturnValueMap::invoke() 方法中,提供参数和预期参数之间的比较在第 75 行进行比较,如下所示:

    if ($invocation->parameters === $map) {
    

    因此,预期的结果

    $mock->myStubbedMethod( "1", "2" )
    

    使用映射数组

    array(
        array( 1, 1, 500 ),
        array( 1, 2, 700 )
    )
    

    会失望。相反,结果将为 NULL。

  2. 在一个更微妙的点上,您可能已经使用两种不同的模拟场景来顽固该方法(就像我所做的那样 - 是的,愚蠢的我!

    因此,为了阐明,第一个模拟存根可以包含

    $mock->expects( $this->any() )
           ->method('myStubbedMethod')
           ->will( $this->returnValue(750) );
    

    然后,在相同的单元测试方法中,它可以包含

    $arrMap = array(
        array( 1, 1, 500 ),
        array( 1, 2, 700 ),
        array( 2, 3, 1500 ),
    );
    $mock->expects( $this->any() )
            ->method('myStubbedMethod')
            ->will( $this->returnValueMap($arrMap) );
    

    调用 stubbed 方法时,将实现映射数组版本。这是显而易见和不言而喻的,但是,在当下的热潮中编码,并且在开发过程中将脑海中的不同代码行为分开时,它很容易被忽视。


推荐