PHPUnit : Assert a parameter when pass it to mock object

Question

For the code below,

$mockObject->expects($this->at(0))
           ->method('search')
           ->with($searchConfig)
           ->will($this->returnValue([]));

This line will automatic make a assertensure that when it call method search it must contain $searchConfig parameters. In this case, we have to provide totally matched $searchConfig but sometime it is hard if it is an array or an object.

Are there any possible way to let PHPUnit call to some specific method to assert that it contains arguments pass in a method as we want?

For example, I may create closure function to assert as below instead of using ->with() method

function ($config){
    $this->assertFalse(isset($config['shouldnothere']));
    $this->assertTrue($config['object']->isValidValue());
}

Schleis · Accepted Answer · 2014-01-17 21:01:54Z

62

You can use ->with($this->callback()) and pass in a closure to perform more complex assertions on the argument.

From the PHPUnit Docs

The callback() constraint can be used for more complex argument verification. This constraint takes a PHP callback as its only argument. The PHP callback will receive the argument to be verified as its only argument and should return TRUE if the argument passes verification and FALSE otherwise.

Example 10.13: More complex argument verification

getMock('Observer', array('reportError'));
    $observer->expects($this->once())
             ->method('reportError')
             ->with($this->greaterThan(0),
                    $this->stringContains('Something'),
                    $this->callback(function($subject){
                      return is_callable(array($subject, 'getName')) &&
                             $subject->getName() == 'My subject';
                    }));

    $subject = new Subject('My subject');
    $subject->attach($observer);

    // The doSomethingBad() method should report an error to the observer
    // via the reportError() method
    $subject->doSomethingBad();
} } ?>

So your test would become:

$mockObject->expects($this->at(0))
->method('search')
->with($this->callback(
    function ($config){
        if(!isset($config['shouldnothere']) && $config['object']->isValidValue()) {
            return true;
        }
        return false;
    })
->will($this->returnValue([]));

answered Jan 17, 2014 at 21:01

Schleis

44.2k8 gold badges73 silver badges90 bronze badges

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

3 Comments

Michiel Over a year ago

I always forget to use return true when validating multiple arguments.

Ali Alwash Over a year ago

Btw, if your function has more then 1 argument, then the this->callback() only applies for the first argument. So you need to define a callback for each argument

nbarth Over a year ago

Thanks for this, that on had me scratching my head for a bit.

Yevgeniy Afanasyev · Accepted Answer · 2020-10-07 01:14:47Z

3

You can use Mockery for it

Say I have a code

$productValidator = app(ProductValidator:class)->setProduct($productIn);

That would be the test code

use Mockery;

...

    $productValidator            
        ->shouldReceive('setProduct')->once()
        ->with(Mockery::type(Product::class))
        ->with(Mockery::on(function($productIn) use ($productId) {
                return $productIn->id === $productId;
            }))
        ->andReturn($productValidator);

Tested on phpunit "version": "8.5.8"

answered Oct 7, 2020 at 1:14

Yevgeniy Afanasyev

42k30 gold badges186 silver badges211 bronze badges

1 Comment

Fermin Arellano Over a year ago

$this->callback() was not working for me in a Laravel 10 project. This response worked for me.

Collectives™ on Stack Overflow

PHPUnit : Assert a parameter when pass it to mock object

2 Answers 2

3 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related