我如何断言我的异常消息与JUnit测试注释?

我已经用@Test注释写了一些JUnit测试。如果我的测试方法抛出一个检查异常，如果我想断言消息与异常一起，是否有一种方法可以用JUnit @Test注释来做到这一点?AFAIK, JUnit 4.7不提供这个功能，但是将来的版本会提供吗?我知道在。net中你可以断言消息和异常类。在Java世界中寻找类似的特性。

这就是我想要的:

@Test (expected = RuntimeException.class, message = "Employee ID is null")
public void shouldThrowRuntimeExceptionWhenEmployeeIDisNull() {}
306525 次浏览
小开

你必须使用@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());
}
}
小开
最佳答案

你可以在ExpectedException中使用@Rule注释，就像这样:

@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()。

小开

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

小开

我喜欢@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!");
}
小开

雷斯托姆给出了一个很好的答案。我也不太喜欢《规则》。我做了类似的事情，除了创建下面的实用工具类来提高可读性和可用性，这首先是注释的一大优点。

添加这个实用程序类:

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"
}
小开

实际上，最好的用法是try/catch。为什么?因为您可以控制异常发生的位置。

想想这个例子:

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

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

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

小开

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

我喜欢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可以防止这种情况。

小开

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


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

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

同样，如果我们使用“@Rule”，我们必须处理大量的样板代码。所以，如果你可以为你的测试安装新的库，我建议你看看AssertJ(这个库现在随SpringBoot一起来了)

然后是一个不违反“给定/当/然后”原则的测试，并使用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");
}
小开

我更喜欢使用AssertJ。

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

提交答案