Akzeptanztests für Ember-Code in Discourse schreiben

Automatisierte Tests sind eine hervorragende Möglichkeit, deinen Code vor zukünftigen Regressionen zu schützen. Viele wissen bereits, wie man dies in unserer Rails-Codebasis mit rspec umsetzt, aber die JavaScript-Seite kann für manche etwas rätselhaft sein.

Glücklicherweise ist es heutzutage recht einfach, grundlegende Tests zu deinem Ember-Code hinzuzufügen!

Für Komponententests siehe Komponententests.

Akzeptanztests

Akzeptanztests sind oft leichter zu schreiben und können mächtiger als Komponententests sein, da sie deine Anwendung auf dieselbe Weise testen, wie ein Nutzer sie im Browser verwenden würde. Ich beginne oft mit Akzeptanztests, und wenn ich eine komplexe Komponente erstelle, füge ich auch dafür Tests hinzu.

So können wir einen Akzeptanztest schreiben, der die Route /admin/snack aufruft und bestätigt, dass der Snack gerendert wurde:

test/javascripts/acceptance/snack-test.js

import { acceptance } from "helpers/qunit-helpers";
acceptance("Snack");

test("Visit Page", function (assert) {
  visit("/admin/snack");
  andThen(() => {
    assert.ok(exists(".fancy-snack-title"), "the snack title is present");
  });
});

Der test()-Aufruf liest sich in diesem Fall fast wie Englisch! Der erste Befehl besagt, die URL /admin/snack aufzurufen. Danach folgt eine andThen()-Methode. Diese Methode ist erforderlich, um sicherzustellen, dass alle Hintergrundarbeiten abgeschlossen sind, bevor die Tests fortgesetzt werden. Da JavaScript- und Ember-Code asynchron ist, müssen wir sicherstellen, dass Ember alles erledigt hat, was es tun muss, bevor unsere Assertions ausgeführt werden. Schließlich wird überprüft, ob das Element .fancy-snack-title vorhanden ist.

Wenn du diesen Test jedoch ausführst, indem du /qunit?module=Acceptance%3A%20Snack aufrufst, wirst du feststellen, dass der Test aufgrund eines AJAX-Fehlers fehlschlägt.

Wie du dich erinnerst, enthält unser Code sowohl eine Rails-Seite als auch eine JavaScript-Seite, die eine AJAX-Anfrage durchführte, um ihre Daten abzurufen. Der Akzeptanztest hat die JavaScript-Seite ausgeführt, wusste aber nicht, wie er die Daten von Rails abrufen sollte.

Um dies zu beheben, müssen wir eine simulierte Antwort (Fake Response) hinzufügen, wobei wir die hervorragende pretender-Bibliothek nutzen. Öffne die Datei test/javascripts/helpers/create-pretender.js und suche die Zeile:

this.get("/admin/plugins", () => response({ plugins: [] }));

Füge direkt darunter eine Zeile hinzu, um ein simuliertes Snack-Objekt zurückzugeben, mit dem unser Akzeptanztest arbeiten kann:

this.get("/admin/snack.json", () => {
  return response({ name: "snack name", description: "snack description" });
});

Du kannst den obigen Code als „für jede Anfrage an /admin/snack.json, antworte mit der folgenden response“ lesen.

Wenn du die URL /qunit?module=Acceptance%3A%20Snack aktualisierst, sollte dein Akzeptanztest seine Daten über pretender abrufen, und die Tests sollten bestehen.

Wie geht es weiter?

Du könntest versuchen, eine kleine Funktion zu entwickeln und Tests hinzuzufügen, um sicherzustellen, dass sie funktioniert. Du könntest sogar TDD (Testgetriebene Entwicklung) ausprobieren, indem du Tests erstellst, bevor du Code im Frontend schreibst. Je nachdem, woran du arbeitest, und je nach deinen persönlichen Vorlieben, findest du dies vielleicht eine angenehmere Herangehensweise. Viel Erfolg und gutes Programmieren :slight_smile:


Dieses Dokument ist versionskontrolliert – schlage Änderungen auf GitHub vor.

15 „Gefällt mir“

My prior experience in writing qunit tests was based on the other howto

i.e. “acceptance” was simply

acceptance("Purple Tentacle", { loggedIn: true });

I have seen in other plugins where the test code contained “fake” JSON to test against. I wasn’t sure if that would be as good as testing against “real” data, so I wanted to avoid doing it that way.

The six tests passed, but I got a couple of rather angry looking “unhandled request” errors.

After finding an example of some “setup” code, I tried it and it solved the errors.

It works, but I’m not really sure why, nor why it’s needed for some but not for the majority of plugins I’ve seen that have qunit tests.

3 „Gefällt mir“

For a long time we weren’t great with testing plugins, so not many people followed our example and added tests.

You are right to add a response using pretender to handle AJAX calls.

4 „Gefällt mir“

Nur zur Information: Der Pfad /qunit ist veraltet. Es ist jetzt /tests. Ich habe eine Weile gebraucht, um das herauszufinden :slight_smile:

1 „Gefällt mir“