Zum Inhalt springen

Wordle 1: Bewerten und testen

Ab jetzt arbeiten wir neben den Kapiteln an einem Projekt: einem eigenen Wordle-Spiel. Wir beginnen mit dem Herzstück – der Bewertung eines Versuchs. Und wir lernen dabei ein Werkzeug kennen, das in jedem ernsthaften Java-Projekt dazugehört: automatische Tests.

  • erklären, was ein Unit-Test ist und wozu er dient
  • in Eclipse eine Testklasse mit JUnit anlegen und ausführen
  • einen fehlschlagenden Test lesen und die Ursache finden
  • die Funktion bewerte so schreiben, dass die ersten Tests bestehen

Gesucht ist ein Wort aus fünf Buchstaben. Man rät ein Wort und bekommt für jeden Buchstaben eine Rückmeldung:

Zeichen im Original Bedeutung
+ grün richtiger Buchstabe an der richtigen Stelle
? gelb Buchstabe kommt im Wort vor, aber an anderer Stelle
- grau Buchstabe kommt im Wort nicht vor

Ein Beispiel: Gesucht ist FEUER, geraten wird ADIEU.

Versuch: A D I E U
Lösung: F E U E R
Ergebnis: - - - + ?

A, D und I kommen nicht vor. Das E steht an der richtigen Stelle. Das U kommt vor, aber an anderer Stelle.

Unsere Funktion soll genau das berechnen:

public static String bewerte(String versuch, String loesung)
Wordle.bewerte("ADIEU", "FEUER") // liefert "---+?"

Beide Wörter sind vorerst immer gleich lang und in Großbuchstaben geschrieben.

  1. Lege in Eclipse das Projekt wordle an – wie in Arbeiten mit Eclipse beschrieben, also ohne module-info.java.

  2. Lege darin das Package de.drv.wordle und die Klasse Wordle an – ohne main-Methode.

  3. Schreibe die Methode, aber vorerst nur mit einem leeren Ergebnis:

    Wordle.java
    package de.drv.wordle;
    public class Wordle {
    public static String bewerte(String versuch, String loesung) {
    return "";
    }
    }

Natürlich ist das falsch. Aber das Programm lässt sich übersetzen – und gleich lassen wir einen Test feststellen, dass es falsch ist.

Bisher haben wir Programme geprüft, indem wir sie gestartet und die Ausgabe angeschaut haben. Das geht bei einem Beispiel. Bei zwanzig wird es mühsam – und nach jeder Änderung müsste man alles wieder von Hand prüfen.

Ein Unit-Test ist ein kleines Stück Code, das eine Methode mit festen Werten aufruft und das Ergebnis mit dem erwarteten Ergebnis vergleicht. Tests laufen auf Knopfdruck, alle auf einmal, in Sekunden. Das Werkzeug dafür heißt in Java JUnit, und Eclipse bringt es schon mit.

Tests gehören nicht zum eigentlichen Programm. Deshalb bekommen sie einen eigenen Quelltextordner.

  1. Klicke mit rechts auf das Projekt → New → Source Folder. Folder name: test → Finish.

  2. Klicke mit rechts auf Wordle.java → New → Other… → Java → JUnit → JUnit Test Case → Next.

  3. Prüfe die Angaben im Dialog:

    Feld Wert
    oben New JUnit Jupiter test
    Source folder wordle/test
    Package de.drv.wordle
    Name WordleTest
    Class under test de.drv.wordle.Wordle

    Klicke auf Finish.

  4. Eclipse fragt, ob die JUnit-Bibliothek zum Build Path hinzugefügt werden soll. Bestätige mit OK.

Die Testklasse liegt im selben Package wie Wordle, aber im Ordner test. So bleiben Programm und Tests getrennt.

Eclipse hat eine Testklasse mit einer Beispielmethode erzeugt, die nur fail("Not yet implemented") enthält. Ersetze den Inhalt durch den ersten richtigen Test:

WordleTest.java
package de.drv.wordle;
import static org.junit.jupiter.api.Assertions.assertEquals;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
class WordleTest {
@Test
@DisplayName("Alles richtig")
void allesRichtig() {
assertEquals("+++++", Wordle.bewerte("HALLO", "HALLO"));
}
}
  • @Test markiert eine Methode als Test. Eine main-Methode braucht es nicht – JUnit findet und startet die Tests selbst.
  • @DisplayName gibt dem Test einen lesbaren Namen für die Anzeige.
  • assertEquals(erwartet, tatsaechlich) vergleicht zwei Werte. Sind sie verschieden, schlägt der Test fehl.

Klicke mit rechts auf WordleTest.java → Run As → JUnit Test.

Links öffnet sich der Reiter JUnit – mit einem roten Balken. Der Test ist fehlgeschlagen. Klicke auf den Test und lies unten im Failure Trace:

Terminal-Fenster
org.opentest4j.AssertionFailedError: expected: <+++++> but was: <>

Erwartet war +++++, geliefert wurde ein leerer Text. Genau das sollte der Test herausfinden.

Für die Bewertung brauchst du drei Methoden von String, die wir im Kapitel Strings noch ausführlich behandeln:

Methode liefert Beispiel
text.length() Anzahl der Zeichen "HALLO".length() → 5
text.charAt(i) das Zeichen an Position i, gezählt ab 0 "HALLO".charAt(1) → 'A'
text.indexOf(c) erste Position von c im Text – oder -1 "HALLO".indexOf('L') → 2

Zwei Zeichen (char) vergleichst du mit ==.

Ergänze die Testklasse um drei weitere Tests:

Versuch Lösung erwartet Fall
BRIEF HALLO ----- kein Buchstabe kommt vor
ADIEU FEUER ---+? gemischt
REGAL LAGER ??+?? Anagramm: alle Buchstaben kommen vor

Schreibe dann bewerte so, dass alle vier Tests grün sind.

Lösung
WordleTest.java
package de.drv.wordle;
import static org.junit.jupiter.api.Assertions.assertEquals;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
class WordleTest {
@Test
@DisplayName("Alles richtig")
void allesRichtig() {
assertEquals("+++++", Wordle.bewerte("HALLO", "HALLO"));
}
@Test
@DisplayName("Kein Buchstabe kommt vor")
void nichtsGemeinsam() {
assertEquals("-----", Wordle.bewerte("BRIEF", "HALLO"));
}
@Test
@DisplayName("Treffer, Vorkommen und Fehlanzeigen gemischt")
void gemischt() {
assertEquals("---+?", Wordle.bewerte("ADIEU", "FEUER"));
}
@Test
@DisplayName("Anagramm: alle Buchstaben kommen vor")
void anagramm() {
assertEquals("??+??", Wordle.bewerte("REGAL", "LAGER"));
}
}
Lösung

Für jede Position: Steht dort derselbe Buchstabe, ist es ein Treffer. Sonst wird geprüft, ob der Buchstabe irgendwo in der Lösung vorkommt.

Diese Lösung ist für die Grundfälle richtig – aber noch nicht für alle Fälle. Wo sie versagt, finden wir im nächsten Teil heraus.

Wordle.java
package de.drv.wordle;
public class Wordle {
/**
* Bewertet einen Rateversuch gegen das gesuchte Wort.
*
* @param versuch das geratene Wort, in Großbuchstaben
* @param loesung das gesuchte Wort, gleich lang, in Großbuchstaben
* @return das Bewertungsmuster aus '+', '?' und '-'
*/
public static String bewerte(String versuch, String loesung) {
String ergebnis = "";
for (int i = 0; i < versuch.length(); i++) {
char buchstabe = versuch.charAt(i);
if (buchstabe == loesung.charAt(i)) {
ergebnis += "+";
} else if (loesung.indexOf(buchstabe) >= 0) {
ergebnis += "?";
} else {
ergebnis += "-";
}
}
return ergebnis;
}
}
Meldung bzw. Symptom Ursache
The import org.junit cannot be resolved JUnit-Bibliothek fehlt im Build Path – Rechtsklick auf das Projekt → Build Path → Add Libraries… → JUnit
Run As bietet kein JUnit Test an Die Klasse enthält keine Methode mit @Test – oder es wurde die falsche Datei angeklickt
Fehlermeldung beschreibt das Gegenteil Erwarteter und tatsächlicher Wert in assertEquals vertauscht
StringIndexOutOfBoundsException Schleife läuft mit <= statt < über das Wortende hinaus