java - unitaria - ¿Cómo afirmo mi mensaje de excepción con la anotación de prueba JUnit?

pruebas unitarias

Question

He escrito algunas pruebas de JUnit con la anotación @Test . Si mi método de prueba arroja una excepción marcada y quiero afirmar el mensaje junto con la excepción, ¿hay alguna forma de hacerlo con la anotación JUnit @Test ? AFAIK, JUnit 4.7 no proporciona esta función, pero ¿alguna versión futura la proporciona? Sé que en .NET puede hacer valer el mensaje y la clase de excepción. Buscando características similares en el mundo de Java.

Esto es lo que quiero:

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

Answer 1

¿Tiene que usar @Test(expected=SomeException.class) ? Cuando tenemos que hacer valer el mensaje real de la excepción, esto es lo que hacemos.

@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 2

En JUnit 4.13 (una vez lanzado) puedes hacer:

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

...

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

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

Esto también funciona en JUnit 5 pero con diferentes importaciones:

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

...

Answer 3

En realidad, el mejor uso es con try / catch. ¿Por qué? Porque puedes controlar el lugar donde esperas la excepción.

Considera este ejemplo:

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

¿Qué sucede si un día se modifica el código y la preparación de la prueba arrojará una excepción RuntimeException? En ese caso, la prueba real ni siquiera se prueba e incluso si no arroja ninguna excepción, la prueba pasará.

Es por eso que es mucho mejor usar try / catch que confiar en la anotación.

Answer 4

Importe la biblioteca de catch-exception , y use eso. Es mucho más limpio que la regla ExpectedException o un try-catch .

Ejemplo de formar sus 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()
  )
);

Answer 5

Me gusta la respuesta @Rule . Sin embargo, si por alguna razón no quieres usar reglas. Hay una tercera opción.

@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 6

Me gusta la respuesta del usuario 64141 pero encontré que podría ser más generalizada. Aquí está mi opinión:

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

}

Tenga en cuenta que dejar la declaración "fail" dentro del bloque try hace que se detecte la excepción de aserción relacionada; el uso de return dentro de la instrucción catch lo impide.

Answer 7

Podría usar la anotación @Rule con ExpectedException , como esto:

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

Tenga en cuenta que el ejemplo en los documentos ExpectedException es (actualmente) incorrecto: no hay un constructor público, por lo que tiene que usar ExpectedException.none() .

Answer 8

Raystorm tuvo una buena respuesta. Tampoco soy un gran fan de las Reglas. Hago algo similar, excepto que creo la siguiente clase de utilidad para facilitar la legibilidad y la facilidad de uso, que es una de las grandes ventajas de las anotaciones en primer lugar.

Agrega esta clase de utilidad:

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

}

Entonces para mi prueba de unidad, todo lo que necesito es este 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"
}

Answer 9

Si usa @Rule, el conjunto de excepciones se aplica a todos los métodos de prueba en la clase de Prueba.