In der Vergangenheit habe ich häufig Tests gesehen (und auch selber geschrieben), die schwer zu warten waren, da sie nicht klar formuliert waren. Nehmen wir beispielsweise folgenden (zugegebenermaßen noch recht einfachen) Test als Beispiel:
final Booking DOOR2DOOR_BOOKING = aBooking().withDefaultValues()
.withOriginLocation(aLocation().withDefaultDoorValues().build())
.withDestinationLocation(aLocation().withDefaultDoorValues().build())
.withIncoterm(IncotermType.CIP)
.withPackageDetails(aPackageDetails().withDefaultValues().build())
// ... hier werden noch viele weitere Felder gesetzt
.build();
@Test
public void shouldConvertTotalWeight() {
// when
final PackageDetailsComponent actual = converter.createPackageDetails(DOOR2DOOR_BOOKING);
// then
assertThat(actual.getTotalWeight()).isEqualTo(DOOR2DOOR_BOOKING.getTotalWeight());
}
// viele weitere Tests die auf DOOR2DOOR_BOOKING zugreifen
Der obige Test drückt sich nicht klar aus. Dadurch könnten selbst bei einem so einfachen Test folgende Fragen bei dem Leser des Tests aufkommen:
- Auf Grund des Namens
DOOR2DOOR_BOOKING
könnte sich der Leser fragen, warum ein Door to Door Booking benötigt wird, damit das Feld totalWeight
konvertiert werden kann.
- Wenn sich der Leser die Initialisierung von DOOR2DOOR_BOOKING ansieht, könnte er ziemlich verwirrt werden, da dieses Objekt auch noch von anderen Tests verwendet wird, die andere Felder von DOOR2DOOR_BOOKING wie bspw. das Feld
incoterm
benötigen. Er muss daher recherchieren, welche dieser Felder für den Test wichtig sind. Es könnte bspw. sein, dass das Feld totalWeight
nur in bestimmten Fällen kopiert wird. Das ist schwer offensichtlich wenn die wichtigen Felder, die für den Test gesetzt sein müssen, in der Masse der für den Test unwichtigen Felder (wie bspw. incoterm
), untergeht.
- Da das Objekt, das auf DOOR2DOOR_BOOKING zugewiesen wurde, von mehreren Tests verwendet wird, müsste man prüfen, ob es immutable ist. Wenn nein, so könnte es von anderen Tests verändert werden, was zu instabilen Tests führen kann und zusätzlich verwirrt.
- Auch würde er sich vielleicht fragen, ob der Test überhaupt etwas testet, da der Test auch durchlaufen würde, wenn das Feld
totalWeight
sowohl in actual
als auch in DOOR2DOOR_BOOKING
null
wären.
Für viele dieser Fragen würde man Vermutungen anstellen. Ich würde beispielsweise vermuten, dass das Feld einfach (unabhängig von irgendwelchen anderen Feldern) kopiert wird. Auch würde ich vermuten, dass das Feld totalWeight
mit einem Wert initialisiert ist und somit auch durch die Zeile assertThat(actual.getTotalWeight()).isEqualTo(DOOR2DOOR_BOOKING.getTotalWeight())
auch wirklich geprüft wird, dass ein Wert kopiert wird. Eventuell wird der Leser sogar in den Code abtauchen, um seine Vermutungen zu verifizieren. Das ist schlecht, denn eigentlich möchte man nicht, dass sich der Leser unnötige Fragen stellt. Stattdessen sollte jeder Test für den Leser offensichtlich sein. Er sollte die Tests einer Klasse überfliegen und sehr schnell darüber erfassen können, wie eine Klasse funktioniert.
Schreibt man den Test nun ein wenig um, so kommuniziert der Test deutlich klarer, was wichtig ist:
@Test
public void shouldConvertTotalWeight() {
// given
final PreciseAmount<Mass> weight = PreciseAmount.valueOf(120, SI.KILOGRAM);
final Booking booking = someBooking().withTotalWeight(weight).build();
// when
final PackageDetailsComponent actual = converter.createPackageDetails(booking);
// then
assertThat(actual.getTotalWeight()).isEqualTo(weight);
}
Der Leser sieht hier sofort, dass wir nur irgendein Booking benötigen, bei dem das Feld totalWeight
gefüllt ist. Dieses kommuniziert das Builder Pattern someBooking().withTotalWeight(weight).build()
. Die Methode someBooking()
baut irgendein Booking zusammen, so dass der Aufruf der Methode createPackageDetails(booking)
nicht zu einer Exception führt. Danach werden dann die Felder überschrieben, die für unseren Test wichtig sind. Im obigen Fall wird lediglich das Feld totalWeight
im Booking gesetzt. Damit wird an den Leser kommuniziert, dass nur dieses eine Feld für den Test wichtig ist. Er sieht also auf den ersten Blick, dass dieses eine Feld in diesem Test lediglich kopiert wird. Auch ist nun klar, dass das booking.totalWeight
ungleich null ist und somit auch wirklich kopiert wird. Weiter erzeugt sich nun jeder Test ein neues Booking-Objekt so dass kein anderer Test es verschmutzen kann selbst wenn es mutable ist.
Das war nun noch eine ziemlich einfache Methode, die nur ein Feld kopiert. Wird die Methode die getestet wird und der zugehörige Tests komplizierter, ist es noch wichtiger drauf zu achten, dass der Test verständlich ausgedrückt ist. Ansonsten muss man später bei Anpassungen am Produktionscode zusätzliche Zeit aufwenden, um überhaupt erst einmal die Tests zu verstehen und zu refaktorisieren.