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

How do I assert my exception message with JUnit Test annotation?

我用@Test注释编写了一些JUnit测试。如果我的测试方法抛出了一个检查过的异常，并且我想要将消息与异常一起断言，那么有没有一种方法可以使用junit @Test注释这样做？Afaik，Junit 4.7不提供此功能，但将来的版本是否提供此功能？我知道在.NET中，您可以断言消息和异常类。在Java世界中寻找相似的特性。

这就是我想要的：

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

相关讨论

您可以将@Rule注释与ExpectedException一起使用，如下所示：

1
2
3
4
5
6
7
8
9

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

请注意，ExpectedException文档中的示例(当前)是错误的-没有公共构造函数，因此必须使用ExpectedException.none()。

相关讨论

我喜欢@Rule的回答。但是，如果出于某种原因您不想使用规则。还有第三种选择。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

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

相关讨论

你必须使用@Test(expected=SomeException.class)吗？当我们必须断言异常的实际消息时，这就是我们要做的。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

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

相关讨论

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

考虑这个例子：

1
2
3
4
5

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

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

这就是为什么使用Try/Catch比依赖注释要好得多的原因。

相关讨论

在Junit 4.13(发布后)中，您可以执行以下操作：

1
2
3
4
5
6
7
8
9
10
11
12
13
14

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

这也适用于6月5日，但有不同的进口：

1
2
3
4

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

...

雷斯托姆的回答很好。我也不太喜欢规则。我做了类似的事情，只是我创建了以下实用程序类来帮助可读性和可用性，这是注释的一大优点。

添加此实用程序类：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

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

}

然后，对于我的单元测试，我只需要以下代码：

1
2
3
4
5
6
7
8
9

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

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

相关讨论

我喜欢用户64141的答案，但发现它可以更广义化。这是我的拿手好戏：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

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

}

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

导入catch异常库，并使用它。它比ExpectedException规则或try-catch规则干净得多。

文档示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

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