Mock in PHPUnit – multiple configuration of the same method with different arguments

by

Sadly this is not possible with the default PHPUnit Mock API.

I can see two options that can get you close to something like this:

Using ->at($x)

$context = $this->getMockBuilder('Context')
   ->getMock();

$context->expects($this->at(0))
   ->method('offsetGet')
   ->with('Matcher')
   ->will($this->returnValue(new Matcher()));

$context->expects($this->at(1))
   ->method('offsetGet')
   ->with('Logger')
   ->will($this->returnValue(new Logger()));

This will work fine but you are testing more than you should (mainly that it gets called with matcher first, and that is an implementation detail).

Also this will fail if you have more than one call to each of of the functions!

Accepting both parameters and using returnCallBack

This is more work but works nicer since you don’t depend on the order of the calls:

Working example:

<?php

class FooTest extends PHPUnit_Framework_TestCase {


    public function testX() {

        $context = $this->getMockBuilder('Context')
           ->getMock();

        $context->expects($this->exactly(2))
           ->method('offsetGet')
           ->with($this->logicalOr(
                     $this->equalTo('Matcher'), 
                     $this->equalTo('Logger')
            ))
           ->will($this->returnCallback(
                function($param) {
                    var_dump(func_get_args());
                    // The first arg will be Matcher or Logger
                    // so something like "return new $param" should work here
                }
           ));

        $context->offsetGet("Matcher");
        $context->offsetGet("Logger");


    }

}

class Context {

    public function offsetGet() { echo "org"; }
}

This will output:

/*
$ phpunit footest.php
PHPUnit 3.5.11 by Sebastian Bergmann.

array(1) {
  [0]=>
  string(7) "Matcher"
}
array(1) {
  [0]=>
  string(6) "Logger"
}
.
Time: 0 seconds, Memory: 3.00Mb

OK (1 test, 1 assertion)

I’ve used $this->exactly(2) in the matcher to show that this does also work with counting the invocations. If you don’t need that swapping it out for $this->any() will, of course, work.

More Related Contents:

  1. Mock private method with PHPUnit
  2. PHPUnit Mock Objects and Static Methods
  3. PHPUnit assert that an exception was thrown?
  4. Best practices to test protected methods with PHPUnit
  5. Autoloading classes in PHPUnit using Composer and autoload.php
  6. Can I “Mock” time in PHPUnit?
  7. Can’t install PHPUnit via PEAR, requires PEAR Installer >= 1.9.2, can’t upgrade PEAR from 1.9.0
  8. How to run single test method with phpunit?
  9. unit testing and Static methods
  10. SimpleTest vs PHPunit
  11. Test PHP headers with PHPUnit
  12. How to install an older version of PHPUnit through PEAR?
  13. Run PHPUnit Tests in Certain Order
  14. Installing PHPUnit via PEAR
  15. “Web interface” to PHPUnit tests?
  16. Unit Testing with items that need to send headers
  17. How do you use PHPUnit to test a function if that function is supposed to kill PHP?
  18. What unit testing in PHP to start [duplicate]
  19. How to output in CLI during execution of PHP Unit tests?
  20. The best way passing value from jQuery to PHP
  21. Tagging systems [closed]
  22. How do I compare two DateTime objects in PHP 5.2.8?
  23. Removing array item by value [duplicate]
  24. How to run array_filter recursively in a PHP array?
  25. format xml string
  26. PHP: add seconds to a date
  27. PHP sending variables to file_get_contents()
  28. Xdebug for remote server not connecting
  29. Upload DOC or PDF using PHP
  30. How can I redirect a 404 Error in a custom 404 page using Codeigniter?

Leave a Comment