Méthode privée fantaisie avec PHPUnit

Question

J'ai une question sur l'utilisation de PHPUnit pour simuler une méthode privée dans une classe. Laissez-moi vous présenter un exemple :

class A {
  public function b() { 
    // some code
    $this->c(); 
    // some more code
  }

  private function c(){ 
    // some code
  }
}

Comment puis-je stub le résultat de la méthode privée pour tester la un peu plus de code une partie de la fonction publique.

Résolu : lecture partielle aquí

Answer 1

En général, on ne teste pas ou on ne simule pas directement les méthodes privées et protégées.

Ce que vous voulez tester, c'est le public API de votre classe. Tout le reste est un détail d'implémentation pour votre classe et ne devrait pas "casser" vos tests si vous le changez.

Cela vous aide également lorsque vous constatez que vous "ne pouvez pas obtenir une couverture de code à 100 %", car votre classe contient peut-être du code que vous ne pouvez pas exécuter en appelant l'API publique.

---

Vous ne voulez généralement pas faire ça

Mais si votre classe ressemble à ça :

class a {

    public function b() {
        return 5 + $this->c();
    }

    private function c() {
        return mt_rand(1,3);
    }
}

je peux comprendre la nécessité de vouloir faire un simulacre de c() puisque la fonction "random" est un état global et que vous ne pouvez pas le tester.

La solution "propre?/verbeuse?/surcompliquée-peut-être?/j'aime-autant-que-comme-c'est-habituel

class a {

    public function __construct(RandomGenerator $foo) {
        $this->foo = $foo;
    }

    public function b() {
        return 5 + $this->c();
    }

    private function c() {
        return $this->foo->rand(1,3);
    }
}

maintenant il n'y a plus besoin de simuler "c()" puisqu'il ne contient pas de globales et que vous pouvez tester gentiment.

---

Si vous ne voulez pas ou ne pouvez pas supprimer l'état global de votre fonction privée (mauvaise chose, mauvaise réalité ou votre définition de mauvais peut être différente), vous pouvez puede test contre la maquette.

// maybe set the function protected for this to work
$testMe = $this->getMock("a", array("c"));
$testMe->expects($this->once())->method("c")->will($this->returnValue(123123));

et exécutez vos tests contre ce simulacre puisque la seule fonction que vous retirez ou simulez est "c()".

---

Pour citer le livre "Pragmatic Unit Testing" :

"En général, vous ne voulez pas rompre l'encapsulation pour le plaisir de tester (ou comme maman le disait, "n'exposez pas vos parties intimes !"). La plupart du temps, vous devriez être en mesure de tester une classe en exerçant ses méthodes publiques. Si une fonctionnalité importante est cachée derrière un accès privé ou protégé, cela peut être un signe d'alerte qu'il y a une autre classe à l'intérieur qui se bat pour sortir."

---

Un peu plus : Why you don't want test private methods.

Answer 2

Vous pouvez utiliser réflexion y setAccessible() dans vos tests pour vous permettre de définir l'état interne de votre objet de manière à ce qu'il renvoie ce que vous voulez de la méthode privée. Vous devez être en PHP 5.3.2.

$fixture = new MyClass(...);
$reflector = new ReflectionProperty('MyClass', 'myPrivateProperty');
$reflector->setAccessible(true);
$reflector->setValue($fixture, 'value');
// test $fixture ...

Answer 3

Vous pouvez tester les méthodes privées mais vous ne pouvez pas simuler (mock) l'exécution de ces méthodes.

En outre, la réflexion ne permet pas de convertir une méthode privée en une méthode protégée ou publique. setAccessible permet uniquement d'invoquer la méthode originale.

Alternativement, vous pouvez utiliser runkit pour renommer les méthodes privées et inclure une "nouvelle implémentation". Toutefois, ces fonctionnalités sont expérimentales et leur utilisation n'est pas recommandée.

Answer 4

Voici une variante des autres réponses qui peuvent être utilisées pour faire de tels appels sur une seule ligne :

public function callPrivateMethod($object, $methodName)
{
    $reflectionClass = new \ReflectionClass($object);
    $reflectionMethod = $reflectionClass->getMethod($methodName);
    $reflectionMethod->setAccessible(true);

    $params = array_slice(func_get_args(), 2); //get all the parameters after $methodName
    return $reflectionMethod->invokeArgs($object, $params);
}

Answer 5

Une option serait de faire c() protected au lieu de private et ensuite sous-classez et surchargez c() . Puis testez avec votre sous-classe. Une autre option serait de remanier c() dans une classe différente que vous pouvez injecter dans A (c'est ce qu'on appelle l'injection de dépendances). Et ensuite, injectez une instance de test avec une implémentation fantaisie de c() dans votre test unitaire.