Einheit testet eine Klasse mit einem Java 8 Uhr

Question

Java 8 eingeführt java.time.Clock, die als Argument für viele andere java.time Objekte verwendet werden können, so dass Sie eine echte oder gefälschte Uhr in sie injizieren können. Zum Beispiel, ich weiß, dass Sie eine Clock.fixed() erstellen und dann Instant.now(clock) anrufen können und es wird die feste Instant zurückgeben, die Sie zur Verfügung gestellt haben. Das klingt perfekt für Unit-Tests!

Allerdings habe ich Probleme herauszufinden, wie man das am besten nutzt. Ich habe eine Klasse, ähnlich der folgenden:

public class MyClass { 
    private Clock clock = Clock.systemUTC(); 

    public void method1() { 
     Instant now = Instant.now(clock); 
     // Do something with 'now' 
    } 
} 

Jetzt möchte ich diesen Code Einheit testen. Ich muss clock einstellen können, um feste Zeiten zu produzieren, damit ich method() zu verschiedenen Zeiten testen kann. Natürlich könnte ich Reflektion verwenden, um das Element clock auf bestimmte Werte zu setzen, aber es wäre schön, wenn ich nicht auf Reflexion zurückgreifen müsste. Ich könnte eine öffentliche setClock() Methode erstellen, aber das fühlt sich falsch an. Ich möchte kein Argument Clock zu der Methode hinzufügen, da der echte Code nicht mit dem Übergeben einer Uhr betroffen sein sollte.

Was ist der beste Ansatz für die Handhabung? Das ist neuer Code, damit ich die Klasse reorganisieren kann.

Edit: Um zu verdeutlichen, muss ich in der Lage sein, ein einzelnes MyClass Objekt zu konstruieren, aber in der Lage zu sein, dass ein Objekt zwei verschiedene Uhrwerte sehen kann (als ob es eine reguläre Systemuhr wäre). Daher kann ich keine feste Uhr in den Konstruktor übergeben.

Answer 1

Lassen Sie mich Jon Skeet Antwort setzen und die Kommentare in den Code ein:

Klasse im Test:

public class Foo { 
    private final Clock clock; 
    public Foo(Clock clock) { 
     this.clock = clock; 
    } 

    public void someMethod() { 
     Instant now = clock.instant(); // this is changed to make test easier 
     System.out.println(now); // Do something with 'now' 
    } 
} 

Unit-Test:

public class FooTest() { 

    private Foo foo; 
    private Clock mock; 

    @Before 
    public void setUp() { 
     mock = mock(Clock.class); 
     foo = new Foo(mock); 
    } 

    @Test 
    public void ensureDifferentValuesWhenMockIsCalled() { 
     Instant first = Instant.now();     // e.g. 12:00:00 
     Instant second = first.plusSeconds(1);   // 12:00:01 
     Instant thirdAndAfter = second.plusSeconds(1); // 12:00:02 

     when(mock.instant()).thenReturn(first, second, thirdAndAfter); 

     foo.someMethod(); // string of first 
     foo.someMethod(); // string of second 
     foo.someMethod(); // string of thirdAndAfter 
     foo.someMethod(); // string of thirdAndAfter 
    } 
} 

Answer 2

Ich möchte kein Clock-Argument zu der Methode hinzufügen, weil der echte Code nicht mit dem Übergeben einer Uhr befassen sollte.

Nein ... aber man könnte es als Konstruktor Parameter zu betrachten. Im Grunde sagst du, dass deine Klasse eine Uhr braucht, mit der man arbeiten kann ... also ist das eine Abhängigkeit. Behandle sie wie jede andere Abhängigkeit und injiziere sie entweder in einem Konstruktor oder über eine Methode. (Ich persönlich bevorzuge Konstruktor Injektion, aber YMMV.)

Sobald Sie aufhören, es als etwas zu denken, können Sie sich leicht konstruieren, und fangen an, es als "nur eine andere Abhängigkeit" zu denken, dann können Sie vertraute Techniken verwenden. (Ich nehme an, Sie sind mit der Abhängigkeitsinjektion im Allgemeinen wohl, zugegeben.)

Answer 3

Sie geben entweder MyClass eine Uhr, Schein Clock, orretrieve eine Uhr – gibt es nicht viel mehr Optionen.

Sie müssen nicht die Reflexion selbst tun, verwenden Sie eine Mocking-Bibliothek.

Meinungen variieren, was der "richtige" Ansatz ist.

Answer 4

Ich bin ein bisschen spät zum Spiel hier, aber zu den anderen Antworten hinzuzufügen, die vorschlagen, eine Uhr zu verwenden - das funktioniert definitiv, und von uns Mit Mockitos DoAnswer können Sie eine Uhr erstellen, die Sie dynamisch an Ihre Fortschritte anpassen können.

Nehmen Sie diese Klasse an, die geändert wurde, um eine Uhr im Konstruktor zu nehmen, und auf die Uhr auf Instant.now(clock) Aufrufe verweisen.

public class TimePrinter() { 
    private final Clock clock; // init in constructor 

    // ... 

    public void printTheTime() { 
     System.out.println(Instant.now(clock)); 
    } 
} 

Dann in Ihrem Testaufbau:

private Instant currentTime; 
private TimePrinter timePrinter; 

public void setup() { 
    currentTime = Instant.EPOCH; // or Instant.now() or whatever 

    // create a mock clock which returns currentTime 
    final Clock clock = mock(Clock.class); 
    when(clock.instant()).doAnswer((invocation) -> currentTime); 

    timePrinter = new TimePrinter(clock); 
} 

Später im Test:

@Test 
public void myTest() { 
    myObjectUnderTest.printTheTime(); // 1970-01-01T00:00:00Z 

    // go forward in time a year 
    currentTime = currentTime.plus(1, ChronoUnit.YEARS); 

    myObjectUnderTest.printTheTime(); // 1971-01-01T00:00:00Z 
} 

Sie sagen Mockito immer eine Funktion ausführen, die den aktuellen Wert von current zurück Wann immer sofort() aufgerufen wird. Instant.now(clock) wird clock.instant() anrufen. Jetzt können Sie schneller vorspulen, zurückspulen und im Allgemeinen Zeitreisen besser als ein DeLorean.