Tutoriel précédent : Developing Discourse Plugins - Part 5 - Add an admin interface
Saviez-vous que Discourse dispose de deux grandes suites de tests pour sa base de code ? Du côté serveur, notre code Ruby utilise une suite de tests basée sur rspec. Pour l’application web, nous disposons d’une suite qunit qui inclut ember-testing.
En supposant que vous avez configuré un environnement de développement, si vous visitez l’URL http://localhost:3000/tests, vous démarrerez l’exécution de la suite de tests JavaScript dans votre navigateur. Un aspect amusant est que vous pouvez voir l’application être testée dans une petite fenêtre en bas à droite de l’écran :
L’application Discourse est construite avec beaucoup de tests qui commencent à s’exécuter lorsque vous visitez l’URL /tests. Il peut donc être utile de filtrer vos tests par le plugin sur lequel vous travaillez. Vous pouvez le faire dans l’interface en cliquant sur le menu déroulant Plugin et en sélectionnant votre plugin :
Ajouter un test d’acceptance dans votre plugin
Tout d’abord, assurez-vous d’utiliser la dernière version de Discourse. La possibilité d’exécuter des tests d’acceptance depuis des plugins est une fonctionnalité relativement récente, et si vous n’utilisez pas la dernière version, vos tests n’apparaîtront pas.
Dans cet article, je vais écrire un test d’acceptance pour le plugin purple-tentacle que nous avons créé dans la partie 5 de cette série.
Ajouter un test d’acceptance est aussi simple que d’ajouter un fichier à votre plugin. Créez le fichier suivant :
test/javascripts/acceptance/purple-tentacle-test.js
import { acceptance, exists } from "discourse/tests/helpers/qunit-helpers";
import { click, visit } from "@ember/test-helpers";
import { test } from "qunit";
acceptance("Purple Tentacle", function (needs) {
needs.settings({ purple_tentacle_enabled: true });
needs.user();
test("Le bouton Purple Tentacle fonctionne", async function (assert) {
await visit("/admin/plugins/purple-tentacle");
assert.ok(exists("#show-tentacle"), "le bouton Purple Tentacle s'affiche");
assert.ok(!exists(".tentacle"), "le tentacule n'est pas encore affiché");
await click("#show-tentacle");
assert.ok(exists(".tentacle"), "le tentacule veut conquérir le monde !");
});
});
J’ai essayé d’écrire le test de manière claire, mais il pourrait être un peu déroutant si vous n’avez jamais écrit de test d’acceptance auparavant. Je vous recommande vivement de lire la documentation d’Ember sur les tests d’acceptance, car elle contient beaucoup d’informations utiles.
Dans chaque test que nous écrivons, nous devons vérifier (assert) quelque chose. Dans notre test, nous voulons effectuer quelques vérifications pour déterminer si le tentacule est masqué initialement, puis affiché uniquement après un clic sur le bouton.
Nous voulons définir une série d’actions à effectuer avant une vérification. Pour cela, nous utilisons le mot-clé await. En utilisant ce mot-clé, nous attendons que chaque helper asynchrone finisse de s’exécuter avant de continuer.
Notre première action importante est : await visit("/admin/plugins/purple-tentacle");. Cela indique à notre test de naviguer vers cette URL dans notre application. Cette URL est celle qui affiche le tentacule.
Après avoir visité la page où le bouton Purple Tentacle apparaît, nous voulons vérifier si le bouton existe sur la page et que l’image du tentacule n’existe pas encore.
Cela est fait par les vérifications suivantes :
assert.ok(exists("#show-tentacle"), "le bouton Purple Tentacle s'affiche");
assert.ok(!exists(".tentacle"), "le tentacule n'est pas encore affiché");
P.S. La version précédente du plugin purple-tentacle n’avait pas l’identifiant #show-tentacle dans le modèle Handlebars. Consultez la dernière version pour suivre cet exemple !
Une fois ces tests réussis, il est temps de tester l’interaction.
La commande suivante est await click('#show-tentacle');, qui indique à notre framework de test que nous voulons cliquer sur le bouton et afficher le tentacule.
Après avoir simulé un clic sur le bouton, nous pouvons vérifier si le tentacule apparaît en effectuant la vérification suivante :
assert.ok(exists(".tentacle"), "le tentacule veut conquérir le monde !");
Ce n’est pas si compliqué, non ? Vous pouvez essayer le test vous-même en visitant http://localhost:3000/tests?target=purple-tentacle sur votre machine de développement. Vous verrez très rapidement apparaître le tentacule violet et tous les tests réussirent.
Si vous souhaitez exécuter les tests qunit du plugin depuis la ligne de commande, vous pouvez lancer
bin/qunit --target purple-tentacle
(ajoutez --standalone si votre serveur de développement n’est pas en cours d’exécution)
(où purple-tentacle est le nom du dossier de votre plugin)
Déboguer vos tests
En écrivant vos plugins, vos tests peuvent vous aider à identifier des problèmes. Lors du développement de vos tests ou si vous apportez des modifications au code de votre plugin, les tests peuvent échouer. Pour comprendre pourquoi, Ember fournit des helpers pratiques : pauseTest() et resumeTest().
Pour les utiliser, ajoutez await pauseTest() dans le code de votre test à l’endroit où vous souhaitez que le test s’arrête. Désormais, lorsque vous exécutez votre test dans le navigateur, le test s’arrêtera automatiquement au point où vous avez ajouté pauseTest(). Cela vous donnera la possibilité d’inspecter la page ou de voir les erreurs afin de déboguer les problèmes.
Où aller ensuite
Je n’aime pas me répéter, mais la documentation d’Ember sur les tests est excellente. Vous pourriez aussi vouloir voir comment Discourse teste différentes fonctionnalités en parcourant les tests dans notre répertoire de tests JavaScript. Il y a beaucoup d’exemples à y trouver pour apprendre.
Bons tests !
Plus dans la série
Partie 1 : Bases des plugins
Partie 2 : Sorties de plugin
Partie 3 : Paramètres du site
Partie 4 : Configuration git
Partie 5 : Interfaces d’administration
Partie 6 : Ce sujet
Partie 7 : Publier votre plugin
Ce document est sous contrôle de version - suggérez des modifications sur GitHub.


