Wie können Sie sicherstellen, dass eine bestimmte Ausnahme in JUnit 4-Tests ausgelöst wird?

Question

Wie kann ich JUnit4 idiomatisch verwenden, um zu testen, dass ein Code eine Ausnahme auslöst?

Ich kann so etwas zwar durchaus machen:

@Test
public void testFooThrowsIndexOutOfBoundsException() {
  boolean thrown = false;

  try {
    foo.doStuff();
  } catch (IndexOutOfBoundsException e) {
    thrown = true;
  }

  assertTrue(thrown);
}

Ich erinnere mich, dass es eine Annotation oder eine Assert.xyz oder etwas die für diese Art von Situationen weit weniger plump und weit mehr im Geiste von JUnit ist.

Answer 1

Das hängt von der JUnit-Version ab und davon, welche Assert-Bibliotheken Sie verwenden.

• Für JUnit5 und 4.13 siehe Antwort https://stackoverflow.com/a/2935935/2986984
• Wenn Sie assertJ oder google-truth verwenden, siehe Antwort https://stackoverflow.com/a/41019785/2986984

Die ursprüngliche Antwort für JUnit <= 4.12 war:

@Test(expected = IndexOutOfBoundsException.class)
public void testIndexOutOfBoundsException() {

    ArrayList emptyList = new ArrayList();
    Object o = emptyList.get(0);

}

Obwohl die Antwort https://stackoverflow.com/a/31826781/2986984 hat mehr Optionen für JUnit <= 4.12.

Hinweis :

• JUnit Test-FAQ

Answer 2

Edit : Jetzt, da JUnit 5 und JUnit 4.13 veröffentlicht wurden, wäre die beste Option die Verwendung von Assertions.assertThrows() (für JUnit 5) und Assert.assertThrows() (für JUnit 4.13+). Siehe meine andere Antwort für Einzelheiten.

Wenn Sie nicht auf JUnit 5 migriert haben, aber JUnit 4.7 verwenden können, können Sie die ExpectedException Die Regel:

public class FooTest {
  @Rule
  public final ExpectedException exception = ExpectedException.none();

  @Test
  public void doStuffThrowsIndexOutOfBoundsException() {
    Foo foo = new Foo();

    exception.expect(IndexOutOfBoundsException.class);
    foo.doStuff();
  }
}

Dies ist viel besser als @Test(expected=IndexOutOfBoundsException.class) denn der Test wird fehlschlagen, wenn IndexOutOfBoundsException geworfen wird, bevor foo.doStuff()

Ver dieser Artikel für Einzelheiten.

Answer 3

Seien Sie vorsichtig bei der Verwendung der erwarteten Ausnahme, da diese nur behauptet, dass die Methode hat diese Ausnahme ausgelöst, nicht eine bestimmte Code-Zeile im Test.

Ich neige dazu, dies zum Testen der Parametervalidierung zu verwenden, da solche Methoden in der Regel sehr einfach sind, aber komplexere Tests sind vielleicht besser geeignet:

try {
    methodThatShouldThrow();
    fail( "My method didn't throw when I expected it to" );
} catch (MyException expectedException) {
}

Urteilsvermögen anwenden.

Answer 4

In Junit gibt es vier Möglichkeiten, Ausnahmen zu testen.

junit5.x

• für junit5.x können Sie verwenden assertThrows wie folgt

  @Test
  public void testFooThrowsIndexOutOfBoundsException() {
      Throwable exception = assertThrows(IndexOutOfBoundsException.class, () -> foo.doStuff());
      assertEquals("expected messages", exception.getMessage());
  }

junit4.x

• für junit4.x das optionale Attribut "expected" der Testanmeldung verwenden

  @Test(expected = IndexOutOfBoundsException.class)
  public void testFooThrowsIndexOutOfBoundsException() {
      foo.doStuff();
  }

• für junit4.x verwenden Sie die ExpectedException-Regel

  public class XxxTest {
      @Rule
      public ExpectedException thrown = ExpectedException.none();
  
      @Test
      public void testFooThrowsIndexOutOfBoundsException() {
          thrown.expect(IndexOutOfBoundsException.class)
          //you can test the exception message like
          thrown.expectMessage("expected messages");
          foo.doStuff();
      }
  }

• Sie können auch die klassische Try/Catch-Methode verwenden, die im Rahmen von Junit 3 weit verbreitet ist

  @Test
  public void testFooThrowsIndexOutOfBoundsException() {
      try {
          foo.doStuff();
          fail("expected exception was not occured.");
      } catch(IndexOutOfBoundsException e) {
          //if execution reaches here, 
          //it indicates this exception was occured.
          //so we need not handle it.
      }
  }

• also

  • Wenn Sie Junit 5 mögen, dann sollten Sie auch das 1.
  • die 2. Möglichkeit wird verwendet, wenn Sie nur die Art der Ausnahme testen wollen
  • die ersten beiden werden verwendet, wenn Sie eine weitere Testausnahmemeldung wünschen
  • wenn Sie Junit 3 verwenden, dann ist die 4.

• Für weitere Informationen können Sie lesen dieses Dokument y junit5-Benutzerhandbuch für Einzelheiten.

Answer 5

Wie bereits erwähnt, gibt es viele Möglichkeiten, mit Ausnahmen in JUnit umzugehen. Aber mit Java 8 gibt es eine weitere Möglichkeit: die Verwendung von Lambda-Ausdrücken. Mit Lambda-Ausdrücken können wir eine Syntax wie diese erreichen:

@Test
public void verifiesTypeAndMessage() {
    assertThrown(new DummyService()::someMethod)
            .isInstanceOf(RuntimeException.class)
            .hasMessage("Runtime exception occurred")
            .hasMessageStartingWith("Runtime")
            .hasMessageEndingWith("occurred")
            .hasMessageContaining("exception")
            .hasNoCause();
}

assertThrown akzeptiert eine funktionale Schnittstelle, deren Instanzen mit Lambda-Ausdrücken, Methodenreferenzen oder Konstruktorreferenzen erstellt werden können. assertThrown, das diese Schnittstelle akzeptiert, erwartet eine Ausnahme und ist bereit, diese zu behandeln.

Dies ist eine relativ einfache, aber wirkungsvolle Technik.

Schauen Sie sich diesen Blogbeitrag an, in dem diese Technik beschrieben wird: http://blog.codeleak.pl/2014/07/junit-testing-exception-with-java-8-and-lambda-expressions.html

Der Quellcode ist hier zu finden: https://github.com/kolorobot/unit-testing-demo/tree/master/src/test/java/com/github/kolorobot/exceptions/java8

Offenlegung: Ich bin der Autor des Blogs und des Projekts.