![](/img/trans.png)
[英]How do I assert an IOException message with JUnit Test annotation?
[英]How do I assert my exception message with JUnit Test annotation?
我已经用@Test
注释编写了一些 JUnit 测试。 如果我的测试方法抛出一个已检查的异常,并且我想断言消息和异常,有没有办法用 JUnit @Test
注释来做到这一点? AFAIK,JUnit 4.7 不提供此功能,但是否有任何未来版本提供? 我知道在 .NET 中你可以断言消息和异常类。 在 Java 世界中寻找类似的功能。
这就是我要的:
@Test (expected = RuntimeException.class, message = "Employee ID is null")
public void shouldThrowRuntimeExceptionWhenEmployeeIDisNull() {}
您可以将@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()
。
在 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;
...
我喜欢@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!");
}
你必须使用@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());
}
}
实际上,最好的用法是使用 try/catch。 为什么? 因为你可以控制你期望异常的地方。
考虑这个例子:
@Test (expected = RuntimeException.class)
public void someTest() {
// test preparation
// actual test
}
如果有一天代码被修改并且测试准备会抛出一个 RuntimeException 怎么办? 在这种情况下,甚至没有测试实际的测试,即使它没有抛出任何异常,测试也会通过。
这就是为什么使用 try/catch 比依赖注解要好得多的原因。
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"
}
我从不喜欢用 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");
}
如果使用@Rule,则异常集将应用于Test 类中的所有测试方法。
我喜欢 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 可以防止这种情况。
导入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()
)
);
为此,我更喜欢 AssertJ。
assertThatExceptionOfType(ExpectedException.class)
.isThrownBy(() -> {
// method call
}).withMessage("My message");
@Test (expectedExceptions = ValidationException.class, expectedExceptionsMessageRegExp = "This is not allowed")
public void testInvalidValidation() throws Exception{
//test code
}
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.