web-dev-qa-db-ja.com

パラメーターに基づいて異なる値を返すようにPHPUnit MockObjectsを取得するにはどうすればよいですか？

引数に関係なく_'return value'_を返すPHPUnitモックオブジェクトがあります。

_// From inside a test...
$mock = $this->getMock('myObject', 'methodToMock');
$mock->expects($this->any))
     ->method('methodToMock')
     ->will($this->returnValue('return value'));
_

私ができるようにしたいのは、モックメソッドに渡された引数に基づいて異なる値を返すことです。私は次のようなものを試しました：

_$mock = $this->getMock('myObject', 'methodToMock');

// methodToMock('one')
$mock->expects($this->any))
     ->method('methodToMock')
     ->with($this->equalTo('one'))
     ->will($this->returnValue('method called with argument "one"'));

// methodToMock('two')
$mock->expects($this->any))
     ->method('methodToMock')
     ->with($this->equalTo('two'))
     ->will($this->returnValue('method called with argument "two"'));
_

しかし、これにより、引数_'two'_でモックが呼び出されない場合にPHPUnitが文句を言うので、methodToMock('two')の定義が最初の定義を上書きすると仮定します。

だから私の質問は：引数に基づいて異なる値を返すPHPUnitモックオブジェクトを取得する方法はありますか？もしそうなら、どのように？

phpunit-testingmockingphpunit
126
Ben Dowling

コールバックを使用します。例えば（PHPUnitドキュメントから直接）：

<?php
class StubTest extends PHPUnit_Framework_TestCase
{
    public function testReturnCallbackStub()
    {
        $stub = $this->getMock(
          'SomeClass', array('doSomething')
        );

        $stub->expects($this->any())
             ->method('doSomething')
             ->will($this->returnCallback('callback'));

        // $stub->doSomething() returns callback(...)
    }
}

function callback() {
    $args = func_get_args();
    // ...
}
?>

Callback（）で必要な処理を行い、必要に応じて$ argsに基づいて結果を返します。

113
Howard Sandford

最新のphpUnitドキュメントから：「スタブメソッドは、事前定義された引数のリストに応じて異なる値を返す場合があります。 returnValueMap（） を使用して、引数を対応する戻り値に関連付けるマップを作成できます。」

$mock->expects($this->any())
    ->method('getConfigValue')
    ->will(
        $this->returnValueMap(
            array(
                array('firstparam', 'secondparam', 'retval'),
                array('modes', 'foo', array('Array', 'of', 'modes'))
            )
        )
    );
102
Nikola Ivancevic

同様の問題がありました（わずかに異なりますが、引数に基づいて異なる戻り値は必要ありませんでしたが、2つの引数セットが同じ関数に渡されることを確認するためにテストする必要がありました）。私はこのようなものを使用してつまずいた：

$mock = $this->getMock();
$mock->expects($this->at(0))
    ->method('foo')
    ->with(...)
    ->will($this->returnValue(...));

$mock->expects($this->at(1))
    ->method('foo')
    ->with(...)
    ->will($this->returnValue(...));

Foo（）の2つの呼び出しの順序がわかっている必要があるため、完全ではありませんが、実際にはおそらくこれはtoo badではありません。

45
Adam

おそらく、コールバックをOOPのように実行したいでしょう：

<?php
class StubTest extends PHPUnit_Framework_TestCase
{
    public function testReturnAction()
    {
        $object = $this->getMock('class_name', array('method_to_mock'));
        $object->expects($this->any())
            ->method('method_to_mock')
            ->will($this->returnCallback(array($this, 'returnCallback'));

        $object->returnAction('param1');
        // assert what param1 should return here

        $object->returnAction('param2');
        // assert what param2 should return here
    }

    public function returnCallback()
    {
        $args = func_get_args();

        // process $args[0] here and return the data you want to mock
        return 'The parameter was ' . $args[0];
    }
}
?>
26
Francis Lewis

正確にあなたが尋ねるものではありませんが、場合によっては役立つことがあります：

$mock->expects( $this->any() ) )
 ->method( 'methodToMock' )
 ->will( $this->onConsecutiveCalls( 'one', 'two' ) );

onConsecutiveCalls -指定された順序で値のリストを返します

14
Prokhor Sednev

2レベルの配列を渡します。各要素は次の配列です。

  • 最初はメソッドのパラメーターで、最小は戻り値です。

例：

->willReturnMap([
    ['firstArg', 'secondArg', 'returnValue']
])
3
antonmarin

次のように引数を返すこともできます。

_$stub = $this->getMock(
  'SomeClass', array('doSomething')
);

$stub->expects($this->any())
     ->method('doSomething')
     ->will($this->returnArgument(0));
_

Mocking documentation でわかるように、メソッドreturnValue($index)は指定された引数を返すことができます。

2
Gabriel Gcia Fdez

私も同様の問題を抱えていましたが、うまくいきませんでした（PHPUnitについては驚くほど少ない情報があります）。私の場合、各テストを別々のテスト（既知の入力と既知の出力）にしました。私は、万能のモックオブジェクトを作成する必要はなく、特定のテスト用に特定のオブジェクトのみが必要であることに気付きました。単位。これがあなたに当てはまるかどうかはわかりませんが、それはテストする必要があるものです。

0
JamShady

このような意味ですか？

public function TestSomeCondition($condition){
  $mockObj = $this->getMockObject();
  $mockObj->setReturnValue('yourMethod',$condition);
}
0
eddy147