Как мне подтвердить сообщение об исключении с помощью аннотации JUnit Test?

Question

Я написал несколько тестов JUnit с аннотацией @Test. Если мой метод тестирования выдает проверенное исключение и если я хочу подтвердить сообщение вместе с исключением, есть ли способ сделать это с помощью аннотации JUnit @Test? AFAIK, JUnit 4.7 не предоставляет эту функцию, но есть ли в будущих версиях ее? Я знаю, что в .NET вы можете утверждать сообщение и класс исключений. Ищете похожую функцию в мире Java.

Вот что я хочу:

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

Answer 1

Вы можете использовать аннотацию @Rule с ExpectedException, например:

@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...
}

Обратите внимание, что пример в ExpectedException документах (на данный момент) неверен - открытого конструктора нет, поэтому вам нужно использовать ExpectedException.none().

Answer 2

Мне нравится ответ @Rule. Однако, если по какой-то причине вы не хотите использовать правила. Есть третий вариант.

@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!");
  }

Answer 3

Вы должны использовать @Test(expected=SomeException.class)? Когда мы должны подтвердить фактическое сообщение об исключении, это то, что мы делаем.

@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());
  }
}

Answer 4

В JUnit 4.13 (после выпуска) вы можете сделать:

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());
}

Это также работает в JUnit 5 , но с другим импортом:

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

...

Answer 5

На самом деле, лучше всего использовать try / catch. Зачем? Потому что вы можете контролировать место, где вы ожидаете исключения.

Рассмотрим этот пример:

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

Что если однажды код будет изменен и подготовка к тесту вызовет исключение RuntimeException? В этом случае реальный тест даже не тестируется, и даже если он не выдает никаких исключений, тест пройдет успешно.

Вот почему гораздо лучше использовать try / catch, чем полагаться на аннотацию.

Answer 6

Raystorm получил хороший ответ. Я тоже не большой поклонник правил. Я делаю нечто подобное, за исключением того, что создаю следующий вспомогательный класс, чтобы улучшить читаемость и удобство использования, что является одним из главных плюсов аннотаций.

Добавить этот служебный класс:

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();

}

Тогда для моего модульного теста мне нужен только этот код:

@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"
}

Answer 7

Мне нравится ответ пользователя 64141, но я обнаружил, что он может быть более обобщенным. Вот мой дубль:

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();

}

Обратите внимание, что оставление оператора "fail" в блоке try приводит к перехвату связанного исключения подтверждения; использование возврата в операторе catch предотвращает это.

Answer 8

При использовании @Rule набор исключений применяется ко всем методам тестирования в классе Test.

Answer 9

Импортируйте библиотеку catch-exception и используйте ее. Это намного чище, чем правило ExpectedException или try-catch.

Пример формы их документов:

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()
  )
);