Mock dans PHPUnit - configuration multiple de la même méthode avec des arguments différents

Question

Est-il possible de configurer le mock PHPUnit de cette manière ?

$context = $this->getMockBuilder('Context')
   ->getMock();
$context->expects($this->any())
   ->method('offsetGet')
   ->with('Matcher')
   ->will($this->returnValue(new Matcher()));
$context->expects($this->any())
   ->method('offsetGet')
   ->with('Logger')
   ->will($this->returnValue(new Logger()));

J'utilise PHPUnit 3.5.10 et cela échoue lorsque je demande Matcher car il attend l'argument "Logger". C'est comme si la deuxième attente réécrivait la première, mais quand je fais un dump du mock, tout semble correct.

Answer 1

Malheureusement, cela n'est pas possible avec l'API de simulation par défaut de PHPUnit.

Je peux voir deux options qui peuvent vous rapprocher de quelque chose de similaire :

Utiliser -> 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()));

Cela fonctionnera bien, mais vous testez plus que ce que vous devriez (principalement qu'il est appelé avec le matcher en premier, ce qui est un détail d'implémentation).

Aussi, cela échouera si vous avez plus d'un appel à chacune des fonctions !

---

Accepter les deux paramètres et utiliser returnCallBack

C'est plus de travail mais fonctionne mieux car vous ne dépendez pas de l'ordre des appels :

Exemple de travail :

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());
                    // Le premier argument sera Matcher ou Logger
                    // donc quelque chose comme "return new $param" devrait fonctionner ici
                }
           ));

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

    }

}

class Context {

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

Cela produira la sortie suivante :

/*
$ phpunit footest.php
PHPUnit 3.5.11 par 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)

J'ai utilisé $this->exactly(2) dans le matcher pour montrer que cela fonctionne également en comptant les invocations. Si vous n'avez pas besoin de cela, le remplacer par $this->any() fonctionnera bien sûr.

Answer 2

Dès PHPUnit 3.6, il existe $this->returnValueMap() qui peut être utilisé pour retourner différentes valeurs en fonction des paramètres donnés à la méthode stub.

Answer 3

Vous pouvez y parvenir avec un rappel :

class MockTest extends PHPUnit_Framework_TestCase
{
    /**
     * @dataProvider provideExpectedInstance
     */
    public function testMockReturnsInstance($expectedInstance)
    {
        $context = $this->getMock('Context');

        $context->expects($this->any())
           ->method('offsetGet')
           // Accept any of "Matcher" or "Logger" for first argument
           ->with($this->logicalOr(
                $this->equalTo('Matcher'),
                $this->equalTo('Logger')
           ))
           // Return what was passed to offsetGet as a new instance
           ->will($this->returnCallback(
               function($arg1) {
                   return new $arg1;
               }
           ));

       $this->assertInstanceOf(
           $expectedInstance,
           $context->offsetGet($expectedInstance)
       );
    }
    public function provideExpectedInstance()
    {
        return array_chunk(array('Matcher', 'Logger'), 1);
    }
}

Devrait passer pour des arguments "Logger" ou "Matcher" passés à la méthode offsetGet du Mock de Context :

F:\Work\code\gordon\sandbox>phpunit NewFileTest.php
PHPUnit 3.5.13 by Sebastian Bergmann.

..

Time: 0 seconds, Memory: 3.25Mb

OK (2 tests, 4 assertions)

Comme vous pouvez le voir, PHPUnit a exécuté deux tests. Un pour chaque valeur de dataProvider. Et dans chacun de ces tests, il a fait l'assertion pour with() et celle pour instanceOf, d'où quatre assertions.

Answer 4

Suite à la réponse de @edorian et aux commentaires (@MarijnHuizendveld) concernant le fait de s'assurer que la méthode est appelée à la fois avec Matcher et Logger, et non simplement deux fois avec Matcher ou Logger, voici un exemple.

$expectedArguments = array('Matcher', 'Logger');
$context->expects($this->exactly(2))
       ->method('offsetGet')
       ->with($this->logicalOr(
                 $this->equalTo('Matcher'), 
                 $this->equalTo('Logger')
        ))
       ->will($this->returnCallback(
            function($param) use (&$expectedArguments){
                if(($key = array_search($param, $expectedArguments)) !== false) {
                    // remove called argument from list
                    unset($expectedArguments[$key]);
                }
                // Le premier paramètre sera Matcher ou Logger
                // donc quelque chose comme "return new $param" devrait fonctionner ici
            }
       ));

// réaliser des actions...

// vérifier que tous les arguments ont été supprimés
$this->assertEquals(array(), $expectedArguments, 'La méthode offsetGet n\'a pas été appelée avec tous les arguments requis');

Ceci est avec PHPUnit 3.7.

Si la méthode que vous testez ne retourne en fait rien, et que vous devez simplement tester si elle est appelée avec les bons arguments, la même approche s'applique. Pour ce scénario, j'ai également essayé de le faire en utilisant une fonction de rappel pour $this->callback comme argument du with, plutôt que returnCallback dans le will. Cela échoue, car PHPUnit appelle la fonction de rappel deux fois dans le processus de vérification du callback de l'argument. Cela signifie que l'approche échoue car lors du deuxième appel, cet argument a déjà été supprimé du tableau des arguments attendus. Je ne sais pas pourquoi PHPUnit l'appelle deux fois (cela semble être un gaspillage inutile), et je suppose que vous pourriez contourner cela en ne le supprimant que lors du deuxième appel, mais je n'étais pas assez confiant que cela soit intentionnel et un comportement cohérent de PHPUnit pour me fier à cela.

Answer 5

Je viens de tomber sur cette extension PHP pour simuler des objets: https://github.com/etsy/phpunit-extensions/wiki/Mock-Object