Teil 4: Testing

KI-gestützte Übersetzung - mehr erfahren & Verbesserungen vorschlagen

Plugins sind eigenständige Software, der Pipeline-Entwickler*innen vertrauen müssen. Jedes Feature unabhängig zu testen – außerhalb einer Pipeline – stellt sicher, dass das Plugin korrekt funktioniert, bevor es jemand in einen Workflow integriert. In diesem Abschnitt schreibst und führst du Tests mit dem Spock-Testing-Framework aus.

Hier eingestiegen?

Wenn du mit diesem Teil beginnst, kopiere die Lösung aus Teil 3 als Ausgangspunkt:

cp -r solutions/3-custom-functions/* .

Wechsle dann in das Plugin-Verzeichnis:

cd nf-greeting

Stelle sicher, dass du dich im Plugin-Verzeichnis befindest:

cd nf-greeting

---

1. Warum testen?

Ein erfolgreicher Build bedeutet, dass der Code kompiliert – aber nicht, dass er wie erwartet funktioniert. Unit-Tests sind kleine Code-Stücke, die automatisch prüfen, ob deine Funktionen für eine bestimmte Eingabe die richtige Ausgabe liefern. Ein Test könnte zum Beispiel prüfen, dass reverseGreeting("Hello") den Wert "olleH" zurückgibt.

Tests sind wertvoll, weil sie:

• Fehler finden, bevor Nutzer*innen sie entdecken
• dir die Sicherheit geben, Änderungen vorzunehmen, ohne etwas kaputtzumachen
• als Dokumentation dienen und zeigen, wie Funktionen verwendet werden sollen

---

2. Spock-Tests verstehen

Das Plugin-Template verwendet Spock, ein Testing-Framework für Groovy. Spock ist bereits im Projekt konfiguriert (über build.gradle), du musst also nichts hinzufügen.

Wenn du bereits Testing-Tools kennst (wie pytest in Python oder testthat in R), erfüllt Spock dieselbe Rolle: Du schreibst kleine Funktionen, die deinen Code mit bekannten Eingaben aufrufen und die Ausgaben prüfen. Der Unterschied ist, dass Spock beschriftete Blöcke verwendet (given:, expect:, when:, then:), die einem Nextflow-Prozess oder -Workflow ähneln.

Hier ist die grundlegende Struktur:

def 'should reverse a greeting'() {   // (1)!
    given:                             // (2)!
    def ext = new GreetingExtension()

    expect:                            // (3)!
    ext.reverseGreeting('Hello') == 'olleH'
}

1. Testname in Anführungszeichen: Beschreibt, was der Test prüft. Verwende klares Englisch.
2. given:-Block: Richte alles ein, was du für den Test brauchst (Objekte erstellen, Daten vorbereiten)
3. expect:-Block: Die eigentlichen Prüfungen. Jede Zeile muss true sein, damit der Test besteht

Diese Struktur macht Tests lesbar: „Gegeben ein Extension-Objekt, erwarte, dass reverseGreeting('Hello') gleich 'olleH' ist."

---

3. Tests schreiben

Schreibe Tests für die beiden Funktionen, die du in Teil 3 erstellt hast: reverseGreeting und decorateGreeting.

3.1. Die Test-Klasse erstellen

touch src/test/groovy/training/plugin/GreetingExtensionTest.groovy

Öffne die Datei in deinem Editor und füge das leere Test-Klassen-Gerüst hinzu:

package training.plugin

import spock.lang.Specification

/**
 * Tests für die Greeting-Extension-Funktionen
 */
class GreetingExtensionTest extends Specification {  // (1)!

}

1. Alle Spock-Test-Klassen erweitern Specification. Das ist der Ausgangspunkt für jede Spock-Testdatei.

3.2. reverseGreeting testen

Füge eine Testmethode innerhalb des Klassen-Rumpfs hinzu. Der given:-Block erstellt eine GreetingExtension-Instanz, und der expect:-Block prüft, dass reverseGreeting zwei verschiedene Eingaben korrekt umkehrt. Damit wird die Funktion direkt getestet, ohne eine Pipeline auszuführen.

DanachVorher

package training.plugin

import spock.lang.Specification

/**
 * Tests für die Greeting-Extension-Funktionen
 */
class GreetingExtensionTest extends Specification {

    def 'should reverse a greeting'() {
        given:
        def ext = new GreetingExtension()            // (1)!

        expect:
        ext.reverseGreeting('Hello') == 'olleH'     // (2)!
        ext.reverseGreeting('Bonjour') == 'ruojnoB'
    }
}

1. Erstelle eine Instanz deiner Extension, um sie direkt zu testen – ohne eine Pipeline auszuführen
2. Jede Zeile in expect: ist eine Assertion; der Test besteht nur, wenn alle true sind

package training.plugin

import spock.lang.Specification

/**
 * Tests für die Greeting-Extension-Funktionen
 */
class GreetingExtensionTest extends Specification {

}

3.3. decorateGreeting testen

Füge eine zweite Testmethode nach der ersten hinzu. Diese prüft, dass decorateGreeting den Eingabe-String auf jeder Seite mit *** umschließt.

DanachVorher

package training.plugin

import spock.lang.Specification

/**
 * Tests für die Greeting-Extension-Funktionen
 */
class GreetingExtensionTest extends Specification {

    def 'should reverse a greeting'() {
        given:
        def ext = new GreetingExtension()

        expect:
        ext.reverseGreeting('Hello') == 'olleH'
        ext.reverseGreeting('Bonjour') == 'ruojnoB'
    }

    def 'should decorate a greeting'() {
        given:
        def ext = new GreetingExtension()

        expect:
        ext.decorateGreeting('Hello') == '*** Hello ***'
    }
}

package training.plugin

import spock.lang.Specification

/**
 * Tests für die Greeting-Extension-Funktionen
 */
class GreetingExtensionTest extends Specification {

    def 'should reverse a greeting'() {
        given:
        def ext = new GreetingExtension()

        expect:
        ext.reverseGreeting('Hello') == 'olleH'
        ext.reverseGreeting('Bonjour') == 'ruojnoB'
    }
}

---

4. Tests ausführen

make test

Test-Ausgabe

BUILD SUCCESSFUL in 5s
6 actionable tasks: 6 executed

Wo sind die Testergebnisse? Gradle blendet die detaillierte Ausgabe aus, wenn alle Tests bestehen. „BUILD SUCCESSFUL" bedeutet, dass alles funktioniert hat. Schlägt ein Test fehl, werden detaillierte Fehlermeldungen angezeigt.

Einen Edge-Case-Test hinzufügen

Füge einen Test hinzu, der prüft, ob reverseGreeting einen leeren String verarbeitet. Was sollte reverseGreeting('') zurückgeben? Füge den Test hinzu, führe make test aus und überprüfe, ob er besteht.

Lösung

Füge diese Testmethode zu GreetingExtensionTest.groovy hinzu:

def 'should handle empty string'() {
    given:
    def ext = new GreetingExtension()

    expect:
    ext.reverseGreeting('') == ''
}

Ein leerer String bleibt auch nach dem Umkehren ein leerer String.

---

5. Den Testbericht anzeigen

Gradle erstellt einen HTML-Testbericht mit detaillierten Ergebnissen für jeden Test. Starte einen Webserver im Berichtsverzeichnis:

pushd build/reports/tests/test
python -m http.server

VS Code fordert dich auf, die Anwendung in deinem Browser zu öffnen. Klicke dich zu deiner Test-Klasse durch, um die einzelnen Testergebnisse zu sehen:

Der Bericht zeigt jede Testmethode und ob sie bestanden hat oder fehlgeschlagen ist.

Drücke Ctrl+C, um den Server zu stoppen, und kehre dann zum vorherigen Verzeichnis zurück:

popd

Wechsle zurück in das Hauptprojektverzeichnis:

cd ..

---

Fazit

Du hast gelernt, dass:

• Spock-Tests eine lesbare given:/expect:-Struktur verwenden
• du mit make test Tests ausführst und den HTML-Bericht unter build/reports/tests/test/ findest
• Tests das Verhalten prüfen und als Dokumentation dienen, die zeigt, wie Funktionen verwendet werden sollen

---

Wie geht es weiter?

Bisher fügt dein Plugin benutzerdefinierte Funktionen hinzu, die Pipelines aufrufen können. Plugins können auch auf Workflow-Ereignisse reagieren (eine abgeschlossene Aufgabe, eine veröffentlichte Datei, das Ende der Pipeline) – mithilfe von Trace-Observern. Im nächsten Abschnitt baust du einen Observer, der abgeschlossene Aufgaben zählt und am Ende der Pipeline eine Zusammenfassung ausgibt.

Weiter zu Teil 5