如何使用 JUnit Test 注释断言我的异常消息？

Question

我已经编写了一些带有 @Test 注释的 JUnit 测试。如果我的测试方法抛出一个已检查的异常，并且如果我想将消息与异常一起断言，有没有办法使用 JUnit @Test 注释来做到这一点？ AFAIK，JUnit 4.7 不提供此功能，但是否有任何未来版本提供它？我知道在.NET 中你可以断言消息和异常类。在 Java 世界中寻找类似的功能。

这就是我想要的：

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

Answer 1

你必须使用@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 2

您可以将@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 文档中的示例（当前）是错误的 - 没有公共构造函数，因此您必须使用 ExpectedException.none()。

Answer 3

如果使用@Rule，异常集将应用于Test类中的所有测试方法。

Answer 4

我喜欢@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 5

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 6

实际上，最好的用法是使用 try/catch。为什么？因为你可以控制你期望异常的地方。

考虑这个例子：

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

如果有一天代码被修改并且测试准备会抛出 RuntimeException 怎么办？在这种情况下，实际测试甚至没有经过测试，即使它没有抛出任何异常，测试也会通过。

这就是为什么使用 try/catch 比依赖注解要好得多。

Answer 7

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

Answer 8

我喜欢 user64141 的回答，但发现它可以更概括。这是我的看法：

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

}

请注意，将“失败”语句留在 try 块中会导致相关的断言异常被捕获；在 catch 语句中使用 return 可以防止这种情况发生。

Answer 9

在 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 10

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

Answer 11

我从不喜欢使用 Junit 断言异常的方式。如果我在注释中使用“expected”，从我的角度来看，我们似乎违反了“given, when, then”模式，因为“then”位于测试定义的顶部。

另外，如果我们使用“@Rule”，我们必须处理这么多样板代码。因此，如果您可以为测试安装新库，我建议您查看 AssertJ（该库现在随 SpringBoot 提供）

然后是不违反“given/when/then”原则的测试，使用 AssertJ 进行验证：

1 - 例外是我们所期望的。 2 - 它还有一条预期的消息

看起来像这样：

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

Answer 12

我更喜欢 AssertJ。

        assertThatExceptionOfType(ExpectedException.class)
        .isThrownBy(() -> {
            // method call
        }).withMessage("My message");