mitmario.dev

node:test

Node.js Sandbox 5 Min Lesezeit 3 BeispieleLektion 1 von 6

Ob eine Funktion nach einer Änderung noch stimmt, lässt sich von Hand prüfen. Man startet das Programm, liest die Ausgabe und vergleicht sie im Kopf mit dem, was herauskommen soll. Beim dritten Mal geht das gut, beim zwanzigsten liest niemand mehr genau hin. Jede Aufgabe dieses Kurses hat dafür eine Prüfliste. Für deinen eigenen Code schreibst du dir so eine Liste selbst, und die heißt dann Tests.

Kein Paket nötig

Node bringt einen Testläufer (englisch test runner) mit, und um ihn zu benutzen, reichen zwei Importe.

Drei Tests, einer davon rot
import test from "node:test";
import assert from "node:assert/strict";

function summe(zahlen) {
  return zahlen.reduce((summe, zahl) => summe + zahl, 0);
}

test("addiert mehrere Zahlen", () => {
  assert.equal(summe([1, 2, 3]), 6);
});

test("gibt bei einer leeren Liste 0 zurück", () => {
  assert.equal(summe([]), 0);
});

test("dieser hier stimmt absichtlich nicht", () => {
  assert.equal(summe([1, 1]), 3);
});

process.on("exit", (code) => console.log(`Exit-Code: ${code}`));

test() nimmt einen Namen und eine Funktion. Wirft die Funktion, ist der Test rot, läuft sie durch, ist er grün. Mehr steckt nicht dahinter. assert ist einfach die Funktion, die im richtigen Moment wirft.

Am Ende steht eine Bilanz mit pass und fail, darunter noch einmal jeder gescheiterte Test mit dem Vergleich, an dem es lag. Im Beispiel ist das 2 !== 3, links der Wert, den summe geliefert hat, rechts der erwartete. Der gelieferte Wert ist oft schon die halbe Diagnose.

Die letzte Zeile kommt nicht vom Testläufer, sondern aus dem Beispiel selbst, und zeigt den Exit-Code. Ein roter Test setzt ihn auf 1. Sind alle grün, bleibt er bei 0. Es ist derselbe Exit-Code wie bei jedem anderen Programm, und an ihm hängt, ob Tests überhaupt etwas bewirken. Eine Pipeline liest keine Ausgabe, sie liest diese eine Zahl und bricht ab, wenn sie nicht null ist.

Eine Datei oder alle

node --test durchsucht das Projekt nach Dateien, die wie Tests heißen, und führt jede in einem eigenen Prozess aus. Als Test gilt unter anderem, was auf .test.js endet oder in einem Ordner test liegt. Eingetragen wird das nirgends, allein der Name entscheidet.

node rabatt.test.js führt genau eine Datei aus, im selben Prozess. Das reicht, solange du an einer einzigen Datei arbeitest. Die Aufgaben in diesem Abschnitt laufen so.

Liegt die Aufgabe dieser Lektion vorn, steht rabatt.test.js im Arbeitsverzeichnis. In der Befehlsleiste liegen dann beide Wege. Bei einer Datei unterscheiden sich die Ausgaben nur in den Zeitangaben. Ab zwei Dateien zählt die Bilanz über alle zusammen, und die Namen der Tests stehen flach untereinander, ohne Hinweis, aus welcher Datei sie kommen.

Zwei Stellen am roten Test

Im Block failing tests: unter der Bilanz steht jeder rote Test noch einmal, mit zwei Stellen. test at drei-tests.js:16:1 ist die Zeile, in der test( steht, also der Test als Ganzes. Bei mehreren Dateien erfährt man erst hier, aus welcher ein roter Test kommt.

Die Zeile mit at TestContext.<anonymous> darunter zeigt auf den assert-Aufruf, der nicht gestimmt hat, hier drei-tests.js:17:10. Sie ist eine Fundstelle und setzt den Editor auf das assert. Die obere hat nur den Dateinamen ohne Pfad und ist deshalb keine. Am Test siehst du, was nicht mehr stimmt, am assert-Aufruf, wo du nachsehen musst.

node:assert/strict vergleicht streng

node:assert gibt es in zwei Fassungen, und sie unterscheiden sich im Vergleich.

assert mit und ohne strict
import lose from "node:assert";
import streng from "node:assert/strict";

function probiere(beschreibung, pruefung) {
  try {
    pruefung();
    console.log(`${beschreibung.padEnd(42)} besteht`);
  } catch (fehler) {
    console.log(`${beschreibung.padEnd(42)} scheitert`);
  }
}

probiere('assert.equal("3", 3)', () => lose.equal("3", 3));
probiere('assert/strict.equal("3", 3)', () => streng.equal("3", 3));
probiere("assert.equal(0, false)", () => lose.equal(0, false));
probiere("assert/strict.equal(0, false)", () => streng.equal(0, false));
probiere('assert.deepEqual({ a: 1 }, { a: "1" })', () => lose.deepEqual({ a: 1 }, { a: "1" }));
probiere('assert/strict.deepEqual({ a: 1 }, { a: "1" })', () => streng.deepEqual({ a: 1 }, { a: "1" }));

node:assert vergleicht mit ==. Damit ist der Text "3" gleich der Zahl 3, die Null gleich false und ein Objekt mit dem Wert 1 gleich einem mit dem Wert "1". In einem Test ist das ein Loch. Gerade an solchen Stellen stolpert ein Programm später, und der Test meldet trotzdem „alles in Ordnung“.

node:assert/strict vergleicht mit Object.is, und das ist bis auf NaN und die negative Null dasselbe wie ===. Für deepEqual gilt derselbe strenge Maßstab. Die Funktionen heißen gleich, nur der Pfad im Import ist ein anderer.

Für den Anfang reichen drei davon. assert.equal für einzelne Werte, assert.deepEqual für Objekte und Listen und assert.throws für den Fall, dass etwas scheitern soll.

Tests in Gruppen

Ab etwa zehn Tests wird eine flache Liste unübersichtlich.

Tests in Gruppen
import { describe, test } from "node:test";
import assert from "node:assert/strict";

function kuerze(text, laenge) {
  return text.length <= laenge ? text : `${text.slice(0, laenge - 1)}…`;
}

describe("kuerze", () => {
  test("lässt kurzen Text in Ruhe", () => {
    assert.equal(kuerze("Hallo", 10), "Hallo");
  });

  test("kürzt langen Text und hängt Auslassungspunkte an", () => {
    assert.equal(kuerze("Programmieren mit Mario", 10), "Programmi…");
  });

  describe("Ränder", () => {
    test("kommt mit leerem Text klar", () => {
      assert.equal(kuerze("", 5), "");
    });

    test("kürzt auch, wenn der Text genau ein Zeichen zu lang ist", () => {
      assert.equal(kuerze("abcdef", 5), "abcd…");
    });
  });
});

describe fasst Tests zu einer Gruppe zusammen, und darin stehen gewöhnliche test-Aufrufe. Gruppen lassen sich verschachteln, die Ausgabe rückt dann mit ein. In der Bilanz stehen die Gruppen getrennt unter suites, bei tests und pass zählen nur die Tests. In fremdem Code steht statt test oft it, das ist dieselbe Funktion unter anderem Namen.

Heißt eine Gruppe kuerze, müssen die Tests darin den Namen nicht wiederholen. Aus kuerze und kürzt langen Text wird beim Lesen ein Satz. Wie ein guter Testname aussieht, kommt in der nächsten Lektion.

Wann doch ein Paket

Der eingebaute Testläufer kann inzwischen das meiste, was man von einem Testpaket erwartet. Er fährt Testdateien parallel, filtert über --test-name-pattern, startet mit --watch bei jeder Änderung neu und misst mit --experimental-test-coverage die Testabdeckung (englisch coverage). Mit mock baut er Attrappen (englisch mocks), Ersatz für eine Abhängigkeit, den der Test selbst steuert.

Zwei davon liegen in der Befehlsleiste der Aufgabe. Der Filter nimmt einen regulären Ausdruck und fährt nur die Tests, deren Name passt. Die anderen fehlen in der Ausgabe ganz, auch in der Bilanz. So behältst du einen roten Test im Blick, ohne dass jedes Mal die ganze Datei durchläuft.

Mit der Testabdeckung hängt unter der Bilanz eine Tabelle, und für rabatt.js steht dort 83.33 | 80.00 | 100.00 | 4-5. Die letzte Spalte nennt die Zeilen, die beim Lauf nie ausgeführt wurden. 4 und 5 sind der throw new TypeError, also die Prüfung auf den Preis, und bei keinem der vier Tests kommt der Preis falsch herein. Die Zahl zeigt damit auf einen Fall, den noch niemand geschrieben hat. Wo sie hoch ist, sagt sie erstaunlich wenig, und warum, steht in Lektion 17.5.

--watch fehlt in der Befehlsleiste mit Absicht. Es wartet darauf, dass jemand die Datei von außen ändert, und warum das in der Sandbox nicht passiert, steht in Lektion 18.3.

Für Vitest oder Jest gibt es in größeren Projekten trotzdem Gründe, etwa eine Browser-Umgebung im selben Testläufer oder ein Projekt, das seit Jahren so gebaut ist. Auf die Aufgaben in diesem Kurs trifft keiner davon zu.

In der Aufgabe testest du rabatt an seinen Grenzen, bei null Prozent, bei hundert und darüber.

Zum Mitnehmen

Eine Datei, die test aus node:test importiert, ist schon ein Testbestand, und der Exit-Code sagt am Ende, ob er durchgelaufen ist. Ein Paket braucht es dafür nicht.

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.