Qui a bouchonné mon Redis ?

Photo Credit: Sam Howzit

Qui a bouchonné mon Redis ?

Les tests fonctionnels tiennent un rôle majeur dans la réussite et la pérennité d’un projet web, d’autant plus s’il est déployé continuellement. Nous nous étions donc déjà intéressés à cette problématique dans le cas d’un service proposant une API REST et utilisant MySQL et Doctrine. Mais nous développons aussi des services du même type utilisant d’autres systèmes de stockage de données comme Redis.

Afin de tester fonctionnellement ces services, nous avons d’abord eu l’idée d’installer une instance Redis sur nos serveurs de tests. Mais nous allions inéluctablement retomber sur les mêmes obstacles qu’avec MySQL :

  • il n’est pas toujours possible de monter une instance Redis dédiée aux tests,
  • mais surtout une telle architecture n’est pas viable dans un système de tests concurrentiels.

La librairie RedisMock

Nous nous sommes alors penchés sur la possibilité de bouchonner Redis, chose qui parait au premier abord plus aisée que de bouchonner Doctrine : Redis propose une API simple et bien documenté (même si abondante). Nous pensions trouver une librairie PHP déjà existante mais nos recherches sont restées vaines.

Nous avons donc créé la librairie RedisMock qui reprend simplement les commandes de l’API de Redis et simule leur comportement grâce aux fonctions natives de PHP. Évidemment, toutes les commandes Redis n’ont pas encore été implémentées, seules celles qui sont utilisées dans nos tests sont présentes. Vous pouvez nous proposer l’implémentation de nouvelles fonctions Redis, selon vos besoins, via des Pull Requests sur le projet.

Toutes les commandes exposées par le mock sont testées unitairement via atoum en reprenant pour chaque cas les spécifications énoncées dans la documentation Redis.

Utiliser RedisMock dans vos tests sur Symfony

Tout d’abord, il faut rajouter la dépendance à la librairie dans le composer.json et mettre à jour les vendors :

L’utilisation du mock reste très simple dans un projet Symfony. Chez M6Web, nous utilisons notre propre composant Redis, lui même basé sur Predis. Afin que le mock puisse complètement se faire passer pour la librairie Redis lors de l’execution des tests, nous avons implémenté une factory qui crée à la volée un adapteur héritant de la classe à bouchonner. La méthode getAdpaterClass permet de récupérer le nom de la classe à instancier.

Pour simplifier la création de l’adapteur et son injection dans l’application via le fichier config_test.yml, on peut utiliser la méthode getAdapter qui instancie directement l’objet sans paramètre. Il nous suffit alors de modifier la définition du service Redis dans l’environnement de test.

Et voilà, le tour est joué ! Les tests utilisent maintenant le mock à la place du véritable Redis. Attention cependant, si votre librairie utilise des fonctionnalités non implémentées dans RedisMock, vous pourriez faire face à des comportements aléatoires indésirables.

RedisMock est disponible en open-source sur le compte GitHub de M6Web.

Enjoy !


En passant, si vous avez trouvé une faute de frappe, vous pouvez forker et éditer ce post. Merci beaucoup !