java - JUnit 5：如何断言抛出异常？

Question

有没有更好的方法来断言方法在 JUnit 5 中引发异常？

目前，我必须使用@Rule 来验证我的测试是否引发了异常，但这不适用于我希望多个方法在我的测试中引发异常的情况。

score 610 · Accepted Answer

您可以使用assertThrows()，它允许您在同一个测试中测试多个异常。在 Java 8 中支持 lambda，这是在 JUnit 中测试异常的规范方法。

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

@Test
void exceptionTesting() {
    MyException thrown = assertThrows(
           MyException.class,
           () -> myObject.doThing(),
           "Expected doThing() to throw, but it didn't"
    );

    assertTrue(thrown.getMessage().contains("Stuff"));
}

score 122 · Accepted Answer

在 Java 8 和 JUnit 5 (Jupiter) 中，我们可以断言异常如下。使用org.junit.jupiter.api.Assertions.assertThrows

public static < T extends Throwable > T assertThrows(Class< T > expectedType, Executable executable)

断言提供的可执行文件的执行引发了预期类型的异常并返回该异常。

如果没有抛出异常，或者抛出了不同类型的异常，则此方法将失败。

如果您不想对异常实例执行额外检查，只需忽略返回值。

@Test
public void itShouldThrowNullPointerExceptionWhenBlahBlah() {
    assertThrows(NullPointerException.class,
            ()->{
            //do whatever you want to do here
            //ex : objectName.thisMethodShoulThrowNullPointerExceptionForNullParameter(null);
            });
}

该方法将使用Executable.org.junit.jupiter.api

参考：

score 34 · Accepted Answer

他们在 JUnit 5 中对其进行了更改（预期：InvalidArgumentException，实际：调用方法），代码如下所示：

@Test
public void wrongInput() {
    Throwable exception = assertThrows(InvalidArgumentException.class,
            ()->{objectName.yourMethod("WRONG");} );
}

score 27 · Accepted Answer

现在 Junit5 提供了一种断言异常的方法

您可以测试一般异常和自定义异常

一般异常情况：

ExpectGeneralException.java

public void validateParameters(Integer param ) {
    if (param == null) {
        throw new NullPointerException("Null parameters are not allowed");
    }
}

ExpectGeneralExceptionTest.java

@Test
@DisplayName("Test assert NullPointerException")
void testGeneralException(TestInfo testInfo) {
    final ExpectGeneralException generalEx = new ExpectGeneralException();

     NullPointerException exception = assertThrows(NullPointerException.class, () -> {
            generalEx.validateParameters(null);
        });
    assertEquals("Null parameters are not allowed", exception.getMessage());
}

您可以在此处找到测试 CustomException 的示例：断言异常代码示例

ExpectCustomException.java

public String constructErrorMessage(String... args) throws InvalidParameterCountException {
    if(args.length!=3) {
        throw new InvalidParameterCountException("Invalid parametercount: expected=3, passed="+args.length);
    }else {
        String message = "";
        for(String arg: args) {
            message += arg;
        }
        return message;
    }
}

ExpectCustomExceptionTest.java

@Test
@DisplayName("Test assert exception")
void testCustomException(TestInfo testInfo) {
    final ExpectCustomException expectEx = new ExpectCustomException();

     InvalidParameterCountException exception = assertThrows(InvalidParameterCountException.class, () -> {
            expectEx.constructErrorMessage("sample ","error");
        });
    assertEquals("Invalid parametercount: expected=3, passed=2", exception.getMessage());
}

score 17 · Accepted Answer

您可以使用assertThrows(). 我的示例取自文档http://junit.org/junit5/docs/current/user-guide/

import org.junit.jupiter.api.Test;

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

....

@Test
void exceptionTesting() {
    Throwable exception = assertThrows(IllegalArgumentException.class, () -> {
        throw new IllegalArgumentException("a message");
    });
    assertEquals("a message", exception.getMessage());
}

score 15 · Accepted Answer

TL;DR：如果您使用的是 JUnit 5.8.0+ 版本，则可以使用assertThrowsExactly()来匹配确切的异常类型。

assertThrowsExactly(FileNotFoundException.class, () -> service.blah());

您可以使用assertThrows(), 但是assertThrows即使抛出的异常是子类型，您的断言也会通过。

这是因为，JUnit 5 通过调用检查异常类型Class.isIntance(..)，Class.isInstance(..)即使抛出的异常是子类型也会返回 true。

解决方法是在 Class 上断言：

Throwable throwable =  assertThrows(Throwable.class, () -> {
    service.readFile("sampleFile.txt");
});
assertEquals(FileNotFoundException.class, throwable.getClass());

score 10 · Accepted Answer

我认为这是一个更简单的例子

List<String> emptyList = new ArrayList<>();
Optional<String> opt2 = emptyList.stream().findFirst();
assertThrows(NoSuchElementException.class, () -> opt2.get());

调用get()包含空的可选项ArrayList将抛出NoSuchElementException. assertThrows声明预期的异常并提供一个 lambda 供应商（不接受任何参数并返回一个值）。

感谢@prime 的回答，我希望能详细说明。

score 4 · Accepted Answer

一个更简单的班轮。此示例使用 Java 8 和 JUnit 5 不需要 lambda 表达式或花括号

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

@Test
void exceptionTesting() {

    assertThrows(MyException.class, myStackObject::doStackAction, "custom message if assertion fails..."); 

// note, no parenthesis on doStackAction ex ::pop NOT ::pop()
}

score 1 · Accepted Answer

实际上，我认为此特定示例的文档中有错误。预期的方法是 expectThrows

public static void assertThrows(
public static <T extends Throwable> T expectThrows(

score -9 · Accepted Answer

这是一个简单的方法。

@Test
void exceptionTest() {

   try{
        model.someMethod("invalidInput");
        fail("Exception Expected!");
   }
   catch(SpecificException e){

        assertTrue(true);
   }
   catch(Exception e){
        fail("wrong exception thrown");
   }

}

只有当您期望的异常被抛出时，它才会成功。

java - JUnit 5：如何断言抛出异常？

10 回答 10

Related

Reference