mitmario.dev

Eine Route testen

Node.js Sandbox 3 Min Lesezeit 3 BeispieleLektion 4 von 6

Eine Route prüfst du am ehrlichsten über HTTP, mit einer echten Anfrage an einen laufenden Server. Dafür muss der Test den Server selbst starten und wieder schließen können. Eine server.js, die schon beim Laden zuhört, lässt ihm diese Wahl nicht.

Erst die Trennung, dann der Test

Die server.js der Bücher-API hat bisher beides getan, die Anwendung aufgebaut und den Server gestartet. Für den Betrieb ist das in Ordnung, für einen Test ist es das Ende.

Eine Datei, die beim Import schon losläuft
// Der Import allein startet schon einen Server auf Port 3000.
import "./gemischt.js";

console.log("Der Import ist durch, und ein Server hört bereits auf 3000.");
console.log("Ein Test könnte sich hier keinen freien Port geben lassen,");
console.log("er käme an den Server gar nicht heran, und enden würde er nie.");

// Nur damit dieses Beispiel ueberhaupt aufhoert. Genau das ist das Problem.
setTimeout(() => process.exit(0), 100);

Ein Test muss die Anwendung importieren, sonst kann er sie nicht anfragen. Beim Import läuft app.listen mit, und ab da hängt ein Server auf Port 3000, den der Test weder schließen noch gegen einen auf einem freien Port tauschen kann. Er hält den Testprozess am Leben, bis ihn jemand abbricht.

Nach der Trennung baut app.js die Anwendung und gibt sie zurück. server.js importiert sie und ruft listen auf. Im Betrieb wird server.js gestartet, der Test importiert app.js. Die Anwendung kann dazu ihre Datenbank als Parameter bekommen (baueApp(db)), statt sie selbst zu öffnen. Dann schiebt ihr der Test eine eigene unter, eine für jeden Test.

Ein Test von Anfang bis Ende

Ein Routen-Test von Anfang bis Ende
import test from "node:test";
import assert from "node:assert/strict";
import { baueApp } from "./getrennt.js";

test("antwortet auf der Startseite", async () => {
  // Port 0 heisst: such dir einen freien.
  const server = baueApp().listen(0);
  await new Promise((fertig) => server.once("listening", fertig));

  const adresse = `http://127.0.0.1:${server.address().port}`;
  console.log(`Der Test hat sich einen freien Port geben lassen: ${server.address().port > 0}`);

  const antwort = await fetch(adresse);
  assert.equal(antwort.status, 200);
  assert.equal(await antwort.text(), "ok");

  await new Promise((fertig) => server.close(fertig));
});

Der Test im Beispiel braucht vier Schritte und kein Paket.

  1. listen(0) lässt das Betriebssystem einen freien Port suchen, und server.address().port sagt danach, welcher es geworden ist. So kommen sich beliebig viele Testdateien nicht in die Quere, auch wenn node --test sie gleichzeitig fährt.
  2. Er wartet auf listening. listen ist laut Dokumentation asynchron, und vorher verspricht server.address() keine Adresse. Hier ging es in 200 Versuchen auch ohne Warten, verlassen würde ich mich darauf nicht.
  3. Er fragt mit fetch an, derselben Funktion wie im Browser, seit Node 18 eingebaut. Für einen POST kommen method, headers und body dazu.
  4. Er schließt den Server am Ende, sonst hält der den Prozess offen, und der Testlauf endet nicht. Auch server.close ist asynchron und ruft seinen Callback erst, wenn wirklich alles zu ist.

Jeder Test bringt seine eigene Datenbank mit

Eine Datenbank für alle gegen eine je Test
import { describe, test, beforeEach } from "node:test";
import assert from "node:assert/strict";
import { DatabaseSync } from "node:sqlite";

function baueDatenbank() {
  const db = new DatabaseSync(":memory:");
  db.exec("CREATE TABLE buecher (id INTEGER PRIMARY KEY, titel TEXT NOT NULL)");
  db.prepare("INSERT INTO buecher (titel) VALUES (?)").run("Node in der Praxis");
  return db;
}

describe("eine Datenbank für alle Tests", () => {
  const db = baueDatenbank();

  test("legt ein Buch an", () => {
    db.prepare("INSERT INTO buecher (titel) VALUES (?)").run("Testen ohne Angst");
    assert.equal(db.prepare("SELECT count(*) AS n FROM buecher").get().n, 2);
  });

  test("fängt mit genau einem Buch an", () => {
    assert.equal(db.prepare("SELECT count(*) AS n FROM buecher").get().n, 1);
  });
});

describe("eine frische je Test", () => {
  let db;

  beforeEach(() => {
    db = baueDatenbank();
  });

  test("legt ein Buch an", () => {
    db.prepare("INSERT INTO buecher (titel) VALUES (?)").run("Testen ohne Angst");
    assert.equal(db.prepare("SELECT count(*) AS n FROM buecher").get().n, 2);
  });

  test("fängt mit genau einem Buch an", () => {
    assert.equal(db.prepare("SELECT count(*) AS n FROM buecher").get().n, 1);
  });
});

Hier steckt dieselbe Falle wie beim geteilten Zustand in Lektion 17.2, nur mit einer Datenbank. Die erste Gruppe teilt sich eine. Der erste Test legt ein Buch an, der zweite zählt zwei statt einem und wird mit 2 !== 1 rot. Den Grund dafür hat der Test davor gelegt.

beforeEach läuft vor jedem Test der Gruppe, before einmal vor allen. Alles, was ein Test verändern kann, gehört in beforeEach. Für teure Dinge, die niemand anfasst, reicht before. Dasselbe gilt für afterEach und after beim Aufräumen, und dort gehört das Schließen von Server und Datenbank hin.

Mit :memory: entsteht die Datenbank im Arbeitsspeicher, ist sofort fertig und mit dem Prozess wieder weg. Braucht ein Test eine Datei, dann eine im temporären Verzeichnis mit eindeutigem Namen. Die echte Datenbank der Anwendung fasst ein Test nie an, sonst räumt der erste Test, der aufräumt, echte Bücher weg.

Die Reihenfolgefalle

Tests, die aufeinander aufbauen, sind verführerisch. Der erste legt an, der zweite ändert, der dritte löscht, und das liest sich wie eine Geschichte und spart Vorbereitung.

Nur hängt dann jeder Test am vorigen. Wird der zweite rot, laufen der dritte und alle weiteren ins Leere und melden Fehler, die es gar nicht gibt. Läuft einer davon allein, scheitert er, obwohl der Code stimmt. Was ihm fehlt, gehört in ein beforeEach. Von sich aus fährt Node die Tests einer Datei der Reihe nach. Mit --test-randomize (seit Node 24.16) mischt es sie, und solche Ketten fallen dann um.

In der Aufgabe fragen fünf Tests die Bücher-API über HTTP an, vom Anlegen bis zum unbekannten Buch.

Zum Mitnehmen

Die Anwendung steht in einer Datei, das Zuhören in einer anderen. Dann holt sich ein Test einen freien Port und eine eigene Datenbank, wartet auf listening und räumt am Ende alles wieder weg.

Jetzt du

Basis Konto, kostenlos

Zu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

In diesem Kurs läuft dein Code auf einem Server. Dafür hat das Basis Konto 1 Stunde im Monat, mehr Zeit gibt es mit dem Premium Konto.

Was in dieser Lektion steckt

  • Artikel mit 3 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.