如何使用 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

您可以使用 @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 2

在 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< /a> 但具有不同的导入：

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

...

Answer 3

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

您必须使用@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 5

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

考虑这个例子：

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

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

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

Answer 6

我从来不喜欢使用 Junit 断言异常的方式。如果我在注释中使用“预期”，从我的角度来看，我们似乎违反了“给定、何时、然后”模式，因为“然后”被放置在测试定义的顶部。

另外，如果我们使用“@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 7

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 8

假设我们在 FooService 类中有一个方法 doStuff。当参数中传递 null 标志时，此方法可能会引发 NullPointerException。

public class FooService {

  public void doStuff(Boolean flag) {
    try{
      if(flag){
        // do stuff
      }
    }catch (Exception e){
      throw new RuntimeException("Unexpected error occurred", e);
    }
  }
}

使用 Junit 5

Junit 5 assertThrows 返回异常，可用于断言异常消息，如下例所示： -

import static org.junit.jupiter.api.Assertions.*;

@Test
public void doStuff_testThrownException(){   
    // null is passed, expected NullPointerException
    Throwable exception = assertThrows(RuntimeException.class, () -> fooService.doStuff(null)); 

    assertEquals("Unexpected error occurred", exception.getMessage());
}

使用 AssertJ

AssertJ 有各种断言来测试异常，其中之一是 assertThatRuntimeException 可以与 withMessage 链接来测试异常消息

import static org.assertj.core.api.Assertions.*;

@Test
public void doStuff_testThrownException(){
  // null is passed, expected NullPointerException
  assertThatRuntimeException().isThrownBy(() -> fooService.doStuff(null))
          .withMessage("Unexpected error occurred");
}

来源：CodingNConcepts

Answer 9

我更喜欢 AssertJ 。

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

Answer 10

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

Answer 11

我喜欢 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 块中保留“fail”语句会导致相关的断言异常被捕获；在 catch 语句中使用 return 可以防止这种情况发生。

Answer 12

导入 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 13

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