Jak potwierdzić komunikat o wyjątku za pomocą adnotacji testu JUnit?

Napisałem kilka testów JUnit z @Testadnotacjami. Jeśli moja metoda testowa zgłasza sprawdzony wyjątek i jeśli chcę potwierdzić komunikat wraz z wyjątkiem, czy istnieje sposób, aby to zrobić za pomocą @Testadnotacji JUnit ? AFAIK, JUnit 4.7 nie udostępnia tej funkcji, ale czy są dostępne w przyszłych wersjach? Wiem, że w .NET możesz potwierdzić komunikat i klasę wyjątku. Szukasz podobnej funkcji w świecie Java.

To jest to czego chcę:

@Test (expected = RuntimeException.class, message = "Employee ID is null")
public void shouldThrowRuntimeExceptionWhenEmployeeIDisNull() {}

Możesz użyć @Ruleadnotacji w ExpectedExceptionnastępujący sposób:

@Rule
public ExpectedException expectedEx = ExpectedException.none();

@Test
public void shouldThrowRuntimeExceptionWhenEmployeeIDisNull() throws Exception {
    expectedEx.expect(RuntimeException.class);
    expectedEx.expectMessage("Employee ID is null");

    // do something that should throw the exception...
    System.out.println("=======Starting Exception process=======");
    throw new NullPointerException("Employee ID is null");
}

Zauważ, że przykład w ExpectedExceptiondokumentacji jest (obecnie) zły - nie ma publicznego konstruktora, więc musisz użyć ExpectedException.none().

Podoba mi się @Ruleodpowiedź. Jeśli jednak z jakiegoś powodu nie chcesz używać reguł. Istnieje trzecia opcja.

@Test (expected = RuntimeException.class)
public void myTestMethod()
{
   try
   {
      //Run exception throwing operation here
   }
   catch(RuntimeException re)
   {
      String message = "Employee ID is null";
      assertEquals(message, re.getMessage());
      throw re;
    }
    fail("Employee Id Null exception did not throw!");
  }

Czy musisz użyć @Test(expected=SomeException.class)? Kiedy musimy potwierdzić faktyczny komunikat wyjątku, robimy to.

@Test
public void myTestMethod()
{
  try
  {
    final Integer employeeId = null;
    new Employee(employeeId);
    fail("Should have thrown SomeException but did not!");
  }
  catch( final SomeException e )
  {
    final String msg = "Employee ID is null";
    assertEquals(msg, e.getMessage());
  }
}

W JUnit 4.13 możesz:

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThrows;

...

@Test
void exceptionTesting() {
  IllegalArgumentException exception = assertThrows(
    IllegalArgumentException.class, 
    () -> { throw new IllegalArgumentException("a message"); }
  );

  assertEquals("a message", exception.getMessage());
}

Działa to również w JUnit 5, ale z różnymi importami:

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

...

W rzeczywistości najlepsze użycie to try / catch. Dlaczego? Ponieważ możesz kontrolować miejsce, w którym oczekujesz wyjątku.

Rozważ ten przykład:

@Test (expected = RuntimeException.class)
public void someTest() {
   // test preparation
   // actual test
}

Co się stanie, jeśli pewnego dnia kod zostanie zmodyfikowany, a przygotowanie do testu zgłosi wyjątek RuntimeException? W takim przypadku rzeczywisty test nie jest nawet testowany, a nawet jeśli nie zgłosi żadnego wyjątku, test zostanie zaliczony.

Dlatego o wiele lepiej jest użyć try / catch niż polegać na adnotacji.

Raystorm miał dobrą odpowiedź. Nie jestem też wielkim fanem zasad. Robię coś podobnego, z wyjątkiem tego, że tworzę następującą klasę użyteczności, aby zwiększyć czytelność i użyteczność, co jest jednym z największych plusów adnotacji.

Dodaj tę klasę narzędzi:

import org.junit.Assert;

public abstract class ExpectedRuntimeExceptionAsserter {

    private String expectedExceptionMessage;

    public ExpectedRuntimeExceptionAsserter(String expectedExceptionMessage) {
        this.expectedExceptionMessage = expectedExceptionMessage;
    }

    public final void run(){
        try{
            expectException();
            Assert.fail(String.format("Expected a RuntimeException '%s'", expectedExceptionMessage));
        } catch (RuntimeException e){
            Assert.assertEquals("RuntimeException caught, but unexpected message", expectedExceptionMessage, e.getMessage());
        }
    }

    protected abstract void expectException();

}

Następnie do mojego testu jednostkowego potrzebuję tylko tego kodu:

@Test
public void verifyAnonymousUserCantAccessPrivilegedResourceTest(){
    new ExpectedRuntimeExceptionAsserter("anonymous user can't access privileged resource"){
        @Override
        protected void expectException() {
            throw new RuntimeException("anonymous user can't access privileged resource");
        }
    }.run(); //passes test; expected exception is caught, and this @Test returns normally as "Passed"
}

Jeśli używana jest reguła @, zestaw wyjątków jest stosowany do wszystkich metod testowych w klasie Test.

Nigdy nie podobało mi się, że w Junit można znaleźć wyjątki. Jeśli użyję słowa „oczekiwany” w adnotacji, z mojego punktu widzenia wydaje się, że naruszamy „dany, kiedy, to” wzorzec, ponieważ „wtedy” znajduje się na górze definicji testu.

Ponadto, jeśli użyjemy „@Rule”, będziemy musieli poradzić sobie z tak dużą liczbą kodów źródłowych. Więc jeśli możesz zainstalować nowe biblioteki do swoich testów, sugeruję zajrzeć do AssertJ (ta biblioteka jest teraz dostarczana z SpringBoot)

Następnie test, który nie narusza zasad „dany / kiedy / wtedy” i jest wykonywany przy użyciu AssertJ w celu weryfikacji:

1 - Spodziewamy się wyjątku. 2 - Ma również oczekiwany komunikat

Będzie wyglądać tak:

 @Test
void should_throwIllegalUse_when_idNotGiven() {

    //when
    final Throwable raisedException = catchThrowable(() -> getUserDAO.byId(null));

    //then
    assertThat(raisedException).isInstanceOf(IllegalArgumentException.class)
            .hasMessageContaining("Id to fetch is mandatory");
}

Podoba mi się odpowiedź user64141, ale stwierdziłem, że można ją bardziej uogólnić. Oto moje zdanie:

public abstract class ExpectedThrowableAsserter implements Runnable {

    private final Class<? extends Throwable> throwableClass;
    private final String expectedExceptionMessage;

    protected ExpectedThrowableAsserter(Class<? extends Throwable> throwableClass, String expectedExceptionMessage) {
        this.throwableClass = throwableClass;
        this.expectedExceptionMessage = expectedExceptionMessage;
    }

    public final void run() {
        try {
            expectException();
        } catch (Throwable e) {
            assertTrue(String.format("Caught unexpected %s", e.getClass().getSimpleName()), throwableClass.isInstance(e));
            assertEquals(String.format("%s caught, but unexpected message", throwableClass.getSimpleName()), expectedExceptionMessage, e.getMessage());
            return;
        }
        fail(String.format("Expected %s, but no exception was thrown.", throwableClass.getSimpleName()));
    }

    protected abstract void expectException();

}

Zauważ, że pozostawienie instrukcji „fail” w bloku try powoduje przechwycenie powiązanego wyjątku asercji; zapobiega temu przez użycie return w instrukcji catch.

Zaimportuj bibliotekę wyjątków przechwytywania i użyj jej. Jest znacznie czystszy niż ExpectedExceptionreguła lub try-catch.

Przykład z ich dokumentów:

import static com.googlecode.catchexception.CatchException.*;
import static com.googlecode.catchexception.apis.CatchExceptionHamcrestMatchers.*;

// given: an empty list
List myList = new ArrayList();

// when: we try to get the first element of the list
catchException(myList).get(1);

// then: we expect an IndexOutOfBoundsException with message "Index: 1, Size: 0"
assertThat(caughtException(),
  allOf(
    instanceOf(IndexOutOfBoundsException.class),
    hasMessage("Index: 1, Size: 0"),
    hasNoCause()
  )
);

@Test (expectedExceptions = ValidationException.class, expectedExceptionsMessageRegExp = "This is not allowed")
public void testInvalidValidation() throws Exception{
     //test code
}