Vigo, le fléau des Carpates

Photo Credit: Columbia Pictures

Vigo, le fléau des Carpates

CasperJS permet d’écrire des scripts javascript qui vont automatiser des tests fonctionnels de pages web. Il exécute ces tests dans une instance de PhantomJS qui est un navigateur scriptable et sans interface graphique (“Headless” dit-on dans le milieu).

Afin de mieux structurer nos tests, de faciliter leur écriture et de pouvoir les lancer avec une commande unique, nous avons créé VigoJS, une surcouche pour CasperJS.

Fonctionnalités

Toutes les fonctionnalités de base de CasperJS sont accessibles. Nous y avons simplement ajouté un mécanisme de configuration contenant plusieurs paramètres de base dont l’URL de test par défaut, l’authentification HTTP éventuelle ou encore la taille de l’écran virtuel. Il est également possible de spécifier des environnements (dev, preprod, prod…) pour différencier les comportements de certains tests. Ainsi, en fonction de l’environnement demandé dans la ligne de commande, les tests peuvent être joués sur des URL différentes avec la bonne authentification HTTP.

Quelques fonctions utilitaires sont aussi disponibles pour réaliser rapidement certaines vérifications récurrentes et ainsi faciliter le développement des tests. On peut, par exemple, rechercher aisément la présence d’erreurs ou warnings PHP dans une page. Il est aussi possible de faire un retry lorsqu’un test a échoué afin d’être certain que ce n’est pas une erreur du type “MySql server has gone away” qui peut se produire de temps en temps sur les serveurs de tests. Par ailleurs, quand un test échoue, VigoJS exporte une capture d’écran qui s’avère très pratique pour comprendre ce qu’il s’est passé !

Tous les paramètres ajoutés à la ligne de commande et dans la configuration sont injectés et accessibles dans la classe de test. On garde, de cette manière, une certaine flexibilité. Cela peut permettre, par exemple, de découper les tests avec de la pagination :

Affichage dans le terminal

Nous avons aussi amélioré l’affichage des résultats des tests. Il est ainsi possible de préciser pour chaque test : un titre et une description personnalisés afin de rendre les comptes-rendus plus compréhensible pour les utilisateurs. De même des commentaires utilisateurs peuvent être ajoutés plus simplement dans le déroulement des tests.

Affichage dans le terminal

Intégration continue

CasperJS génère nativement des rapports xUnit. VigoJS intègre donc cette fonctionnalité pour être utilisé sur une plateforme d’intégration continue comme Jenkins. Il est aussi possible de modifier le paramètre classPath dans le fichier xUnit pour améliorer la lisibilité des résultats :

Affichage des résultats des tests dans Jenkins

Le chemin dans lequel est généré le rapport est configurable par l’option –buildPath (ou dans la configuration) :

Il suffit ensuite de configurer le job Jenkins pour qu’il récupère le rapport de test dans ce dossier. Sans oublier de faire un job pour tester les Pull Requests de votre projet.

VigoJS 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 !