PHPUnit: How to Mock Multiple Calls to the Same Method

Question

I was looking to get different return values for the same method while calling it multiple times. I tried many things but did not get an exact answer for this.

$mock = $this->getMockBuilder('Test')
                ->disableOriginalConstructor()
                ->setMethods(array('testMethod'))
                ->getMock();
$mock->expects($this->once())->method('testMethod')->will($this->returnValue(true));
$mock->expects($this->second())->method('testMethod')->will($this->returnValue(false));

TIGER · Accepted Answer · 2018-04-02 07:35:52Z

14

You can use willReturnOnConsecutiveCalls method

$mock
    ->expects($this->exactly(2))
    ->method('testMethod')
    ->willReturnOnConsecutiveCalls(true, false);

Alternative (for phpunit < 4):

$mock
    ->expects($this->exactly(2))
    ->method('testMethod')
    ->will($this->onConsecutiveCalls(true, false));

edited Apr 2, 2018 at 7:35

TIGER

2,9055 gold badges38 silver badges46 bronze badges

answered Apr 2, 2018 at 6:36

Nikita U.

3,6381 gold badge31 silver badges38 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

neuquen Over a year ago

Checking the source code, it looks like willReturn() can also handle multiple arguments to allow for consecutive calls.

TIGER · Accepted Answer · 2018-04-02 06:51:01Z

4

I found this link which helps me to get it done using at($index) method. It returns a matcher that matches when the method it is evaluated for is invoked at the given $index.

The $index parameter for the at() matcher refers to the index, starting at zero, in all method invocations for a given mock object. Exercise caution when using this matcher as it can lead to brittle tests which are too closely tied to specific implementation details. More Details

$mock = $this->getMockBuilder('Test')
                ->disableOriginalConstructor()
                ->setMethods(array('testMethod'))
                ->getMock();
$mock->expects($this->at(0))->method('testMethod')->will($this->returnValue(true));
$mock->expects($this->at(1))->method('testMethod')->will($this->returnValue(false));

edited Apr 2, 2018 at 6:51

answered Apr 2, 2018 at 5:44

TIGER

2,9055 gold badges38 silver badges46 bronze badges

3 Comments

Xavi Montero Over a year ago

Great trick if you receive the expectations in an array. You can loop the array and iterate on adding each expectation.

TIGER Over a year ago

@XaviMontero I used at here because the method was being multiple time in a loop so I want to return a different result on the index when the function was called.

Ben Y Over a year ago

n.b. at() is deprecated in PHPUnit 9 and will be removed in version 10

Collectives™ on Stack Overflow

PHPUnit: How to Mock Multiple Calls to the Same Method

2 Answers 2

1 Comment

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related