Como afirmo minha mensagem de exceção com a anotação JUnit Test?

Eu escrevi alguns testes JUnit com @Testanotação. Se meu método de teste gerar uma exceção marcada e se eu desejar afirmar a mensagem junto com a exceção, existe uma maneira de fazer isso com a @Testanotação JUnit ? AFAIK, JUnit 4.7 não fornece esse recurso, mas alguma versão futura o fornece? Eu sei que no .NET você pode afirmar a mensagem e a classe de exceção. Procurando por um recurso semelhante no mundo Java.

É isso que eu quero:

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

Você pode usar a @Ruleanotação com ExpectedException, assim:

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

Observe que o exemplo nos ExpectedExceptiondocumentos está (atualmente) errado - não há construtor público, então você deve usar ExpectedException.none().

Eu gosto da @Ruleresposta. No entanto, se por algum motivo você não quiser usar regras. Existe uma terceira opção.

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

Você tem que usar @Test(expected=SomeException.class)? Quando temos que afirmar a mensagem real da exceção, é isso que fazemos.

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

No JUnit 4.13, você pode fazer:

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

Isso também funciona no JUnit 5, mas com diferentes importações:

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

...

Na verdade, o melhor uso é com try / catch. Por quê? Porque você pode controlar o local onde espera a exceção.

Considere este exemplo:

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

E se um dia o código for modificado e a preparação do teste gerar uma RuntimeException? Nesse caso, o teste real nem sequer é testado e, mesmo que não gere nenhuma exceção, o teste será aprovado.

É por isso que é muito melhor usar try / catch do que confiar na anotação.

Raystorm teve uma boa resposta. Também não sou muito fã de regras. Faço algo semelhante, exceto que eu crio a seguinte classe de utilitário para ajudar a legibilidade e usabilidade, que é uma das grandes vantagens das anotações em primeiro lugar.

Adicione esta classe de utilitário:

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

}

Então, para o meu teste de unidade, tudo o que preciso é deste código:

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

Se você estiver usando o @Rule, o conjunto de exceções será aplicado a todos os métodos de teste na classe Test.

Eu nunca gostei da maneira de afirmar exceções com Junit. Se eu usar o "esperado" na anotação, parece do meu ponto de vista que estamos violando o padrão "dado, quando, então" porque o "então" é colocado na parte superior da definição de teste.

Além disso, se usarmos "@Rule", teremos que lidar com muito código de clichê. Portanto, se você pode instalar novas bibliotecas para seus testes, sugiro dar uma olhada no AssertJ (essa biblioteca agora vem com o SpringBoot)

Em seguida, um teste que não está violando os princípios "dado / quando / então" e é feito usando o AssertJ para verificar:

1 - A exceção é o que estamos esperando. 2 - Tem também uma mensagem esperada

Ficará assim:

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

Eu gosto da resposta do user64141, mas achei que poderia ser mais generalizado. Aqui está a minha opinião:

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

}

Observe que deixar a instrução "fail" dentro do bloco try faz com que a exceção de asserção relacionada seja capturada; o uso de return dentro da instrução catch evita isso.

Importe a biblioteca de exceção-captura e use-a. É muito mais limpo que a ExpectedExceptionregra ou a try-catch.

Exemplo dos documentos:

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
}