Vorheriges Tutorial: Developing Discourse Plugins - Part 5 - Add an admin interface
Wusstest du, dass Discourse zwei große Test-Suites für seine Codebasis hat? Auf der Serverseite hat unser Ruby-Code eine Test-Suite, die rspec verwendet. Für die Browser-Anwendung haben wir eine qunit-Suite, die ember-testing enthält.
Angenommen, du hast eine Entwicklungsumgebung eingerichtet. Wenn du die URL http://localhost:3000/tests besuchst, startest du die Ausführung der JavaScript-Test-Suite in deinem Browser. Eine nette Eigenschaft ist, dass du sehen kannst, wie die Anwendung in einem Miniaturfenster in der rechten unteren Ecke getestet wird:
Die Discourse-Anwendung wird mit einer Menge Tests erstellt, die ausgeführt werden, sobald du die /tests-URL besuchst. Es kann daher hilfreich sein, deine Tests nach dem Plugin zu filtern, an dem du arbeitest. Das kannst du in der Oberfläche tun, indem du auf das Dropdown-Menü Plugin klickst und dein Plugin auswählst:
Einen Abnahmetest (Acceptance Test) in deinem Plugin hinzufügen
Stelle zuerst sicher, dass du die neueste Version von Discourse ausgecheckt hast. Die Möglichkeit, Abnahmetests (Acceptance Tests) aus Plugins heraus auszuführen, ist eine relativ neue Funktion. Wenn du nicht die neueste Version auscheckst, werden deine Tests nicht angezeigt.
Für diesen Artikel werde ich einen Abnahmetest für das purple-tentacle-Plugin schreiben, das wir in Teil 5 dieser Serie erstellt haben.
Das Hinzufügen eines Abnahmetests ist so einfach wie das Hinzufügen einer Datei zu deinem Plugin. Erstelle Folgendes:
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!");
});
});
Ich habe versucht, den Test so zu schreiben, dass er klar ist, aber er könnte etwas verwirrend sein, wenn du noch nie einen Abnahmetest geschrieben hast. Ich empfehle dringend, dass du die Ember-Dokumentation zum Abnahmetest liest, da sie viele hilfreiche Informationen enthält.
In jedem Test, den wir schreiben, müssen wir etwas mit assert prüfen. In unserem Test möchten wir einige Assertions durchführen, um zu überprüfen, ob der Tentakel zunächst ausgeblendet ist und nur nach dem Klick auf die Schaltfläche angezeigt wird.
Wir möchten eine Reihe von Aktionen definieren, die ausgeführt werden, bevor eine Assertion gemacht wird. Dafür verwenden wir das Schlüsselwort await. Durch die Verwendung dieses Schlüsselworts warten wir darauf, dass die Ausführung jeder asynchronen Helper-Funktion zuerst abgeschlossen ist.
Unsere erste wichtige Aktion ist: await visit("/admin/plugins/purple-tentacle");. Dies weist unseren Test an, zu dieser URL in unserer Anwendung zu navigieren. Diese URL war diejenige, die den Tentakel anzeigt.
Nachdem wir die Seite besucht haben, auf der die purple-tentacle-Schaltfläche erscheint, möchten wir prüfen, ob wir die Schaltfläche auf der Seite sehen können und ob das Tentakel-Bild noch nicht existiert.
Dies geschieht durch die folgenden Assertions:
assert.ok(exists("#show-tentacle"), "it shows the purple tentacle button");
assert.ok(!exists(".tentacle"), "the tentacle is not shown yet");
P.S. Die vorherige Version des purple-tentacle-Plugins hatte die #show-tentacle Element-ID im Handlebars-Template nicht. Sieh dir die neueste Version an, um folgen zu können!
Sobald diese Tests bestanden sind, ist es an der Zeit, die Interaktion zu testen.
Der nächste Befehl ist await click('#show-tentacle');, der unserem Testframework mitteilt, dass wir die Schaltfläche anklicken und den Tentakel anzeigen möchten.
Nachdem wir einen Klick auf die Schaltfläche simuliert haben, können wir prüfen, ob der Tentakel erscheint, indem wir folgendes asserten:
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
Gar nicht so schlimm, oder? Du kannst den Test selbst ausprobieren, indem du auf deiner Entwicklungsmaschine http://localhost:3000/tests?target=purple-tentacle besuchst. Du solltest sehr schnell sehen, wie der violette Tentakel erscheint, und alle Tests werden bestanden.
Wenn du die qunit-Tests des Plugins in der Befehlszeile ausführen möchtest, kannst du folgendes ausführen:
bin/qunit --target purple-tentacle
(füge --standalone hinzu, wenn dein Entwicklungsserver nicht läuft)
(wobei purple-tentacle der Ordnername deines Plugins ist)
Debugging deiner Tests
Beim Schreiben deiner Plugins können deine Tests dir helfen, Probleme im Plugin zu identifizieren. Wenn du deine Tests entwickelst oder Änderungen am Code deines Plugins vornimmst, können die Tests fehlschlagen. Um zu verstehen, warum, bietet Ember einige hilfreiche Funktionen: pauseTest() und resumeTest().
Um sie zu nutzen, füge await pauseTest() in deinen Testcode ein, an der Stelle, an der der Test pausieren soll. Wenn du deinen Test jetzt im Browser ausführst, pausiert der Test automatisch an der Stelle, an der du pauseTest() hinzugefügt hast. Das gibt dir die Möglichkeit, die Seite zu inspizieren oder Fehler anzuzeigen, um bei der Fehlersuche zu unterstützen.
Wo geht es von hier aus weiter
Ich möchte mich nicht wiederholen, aber die Ember-Dokumentation zum Testen ist ausgezeichnet. Du möchtest vielleicht auch sehen, wie Discourse verschiedene Funktionen testet, indem du die Tests in unserem JavaScript-Test-Verzeichnis durchstöberst. Wir haben dort einige Beispiele, aus denen du lernen kannst.
Viel Spaß beim Testen!
Mehr aus der Serie
Teil 1: Plugin Basics
Teil 2: Plugin Outlets
Teil 3: Site Settings
Teil 4: git setup
Teil 5: Admin interfaces
Teil 6: Dieses Thema
Teil 7: Publish your plugin
Dieses Dokument wird versionskontrolliert - schlage Änderungen auf github vor.


