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

我喜欢这个@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());
}

这也适用于JUnit 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

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 7

假设我们的doStuff类中有一个方法FooService。当参数中传递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 5assertThrows返回异常，可用于断言异常消息，如下例所示：-

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 8

我从不喜欢用 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");
}