Tutorial precedente: Developing Discourse Plugins - Part 5 - Add an admin interface
Sapevi che Discourse dispone di due grandi suite di test per il suo codice sorgente? Sul lato server, il nostro codice Ruby utilizza una suite di test basata su rspec. Per l’applicazione browser, abbiamo una suite qunit che include ember-testing.
Presupponendo di aver configurato un ambiente di sviluppo, se visiti l’URL http://localhost:3000/tests inizierai a eseguire la suite di test JavaScript nel tuo browser. Un aspetto divertente è che puoi vederla testare l’applicazione in una finestra in miniatura nell’angolo in basso a destra:
L’applicazione Discourse è costruita con molti test che inizieranno a essere eseguiti quando visiti l’URL /tests. Quindi, potrebbe essere utile filtrare i test in base al plugin su cui stai lavorando. Puoi farlo nell’interfaccia facendo clic sul menu a discesa Plugin e selezionando il tuo plugin:
Aggiungere un Test di Accettazione nel tuo Plugin
Innanzitutto, assicurati di avere l’ultima versione di Discourse selezionata. La possibilità di eseguire test di accettazione dai plugin è una funzione relativamente nuova e, se non selezioni l’ultima versione, i tuoi test non verranno visualizzati.
Per questo articolo, scriverò un test di accettazione per il plugin purple-tentacle che abbiamo creato nella parte 5 di questa serie.
Aggiungere un test di accettazione è semplice come aggiungere un file al tuo plugin. Crea il seguente:
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("Purple tentacle button works", async function (assert) {
await visit("/admin/plugins/purple-tentacle");
assert.ok(exists("#show-tentacle"), "it shows the purple tentacle button");
assert.ok(!exists(".tentacle"), "the tentacle is not shown yet");
await click("#show-tentacle");
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
});
});
Ho provato a scrivere il test in modo che fosse chiaro, ma potrebbe essere un po’ confuso se non hai mai scritto un test di accettazione prima. Raccomando vivamente di leggere la documentazione di Ember sui test di accettazione, poiché contiene molte informazioni utili.
In ogni test che scriviamo, dobbiamo assertare qualcosa. Nel nostro test, vogliamo fare alcune asserzioni per verificare se il tentacolo è inizialmente nascosto e poi mostrato solo dopo aver fatto clic sul pulsante.
Vogliamo definire un insieme di azioni da intraprendere prima che venga fatta un’asserzione. Per farlo, utilizziamo la parola chiave await. Utilizzando quella parola chiave, aspettiamo che l’esecuzione di ogni helper asincrono termini prima di proseguire.
La nostra prima azione importante è: await visit("/admin/plugins/purple-tentacle");. Questo dice al nostro test di navigare verso quell’URL nella nostra applicazione. Quell’URL è quello che mostra il tentacolo.
Dopo aver visitato la pagina in cui appare il pulsante del tentacolo viola, vogliamo controllare se possiamo vedere che il pulsante esiste nella pagina e che l’immagine del tentacolo non esiste ancora.
Ciò viene fatto dalle seguenti asserzioni:
assert.ok(exists("#show-tentacle"), "it shows the purple tentacle button");
assert.ok(!exists(".tentacle"), "the tentacle is not shown yet");
P.S. La versione precedente del plugin purple-tentacle non aveva l’id dell’elemento #show-tentacle nel template Handlebars. Controlla l’ultima versione per seguire la guida!
Una volta superati questi test, è il momento di testare l’interazione.
Il comando successivo è await click('#show-tentacle'); che dice al nostro framework di test che vogliamo fare clic sul pulsante e mostrare il tentacolo.
Dopo aver simulato un clic sul pulsante, possiamo controllare se il tentacolo appare affermando:
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
Non così male, vero? Puoi provare il test tu stesso visitando http://localhost:3000/tests?target=purple-tentacle sulla tua macchina di sviluppo. Dovresti vedere apparire molto rapidamente il tentacolo viola e tutti i test passeranno.
Se vuoi eseguire i test qunit del plugin dalla riga di comando, puoi lanciare
bin/qunit --target purple-tentacle
(aggiungi --standalone se il tuo server di sviluppo non è in esecuzione)
(dove purple-tentacle è il nome della cartella del tuo plugin)
Eseguire il Debug dei tuoi test
Mentre scrivi i tuoi plugin, i tuoi test possono aiutarti a identificare i problemi nel plugin. Quando stai sviluppando i tuoi test o se apporti modifiche al codice del tuo plugin, i test potrebbero fallire. Per aiutare a capire perché, Ember ha alcuni comodi helper: pauseTest() e resumeTest().
Per utilizzarli, aggiungi await pauseTest() all’interno del codice del tuo test dove desideri che il test si metta in pausa. Ora, quando esegui il tuo test nel browser, il test si metterà automaticamente in pausa nel punto in cui hai aggiunto `pauseTest(). Questo ti darà la possibilità di ispezionare la pagina o di visualizzare eventuali errori per aiutarti a eseguire il debug dei problemi.
Dove andare da qui
Detesto sembrare un disco rotto, ma la documentazione di Ember sui test è eccellente. Potresti anche voler vedere come Discourse testa varie funzionalità esplorando i test nella nostra directory dei test javascript. Ci sono diversi esempi in cui puoi imparare.
Buon testing!
Altro nella serie
Parte 1: Fondamenti dei Plugin
Parte 2: Outlet dei Plugin
Parte 3: Impostazioni del Sito
Parte 4: Configurazione di git
Parte 5: Interfacce di amministrazione
Parte 6: Questo argomento
Parte 7: Pubblica il tuo plugin
Questo documento è controllato in versione - suggerisci modifiche su github.


