Как подтвердить сообщение об исключении с помощью аннотации 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...
    System.out.println("=======Starting Exception process=======");
    throw new NullPointerException("Employee ID is null");
}

Обратите внимание, что пример в ExpectedException docs (на данный момент) неверна – открытого конструктора нет, поэтому вам придется использовать 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());
}

Это также работает в Юнит 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

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

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

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

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

Answer 8

Мне нравится ответ пользователя 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 приводит к перехвату соответствующего исключения утверждения;использование return внутри оператора catch предотвращает это.

Answer 9

Импортируйте перехват исключения библиотеку и используйте ее.Это намного чище, чем 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()
  )
);

Answer 10

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