Junit 5：如何断言一个例外？

Question

是否有更好的方法可以断言一种方法在Junit 5中引发了例外？

当前，我必须使用@rule才能验证我的测试会引发异常，但是对于我期望多种方法在测试中引发异常的情况下，这不起作用。

Answer 1

您可以使用 assertthrows（） ，它允许您在同一测试中测试多个异常。在Java 8中支持Lambdas的支持下，这是测试Junit例外的规范方法。

per junit docs ：

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

Answer 2

在Java 8和Junit 5（木星）中，我们可以主张例外，如下所示。
使用org.junit.jupiter.api.assertions.assertthrows

公共静态＆lt; t可以扩展可投掷＆gt; t essertthrows（class＆lt; t＆gt; endiveptype，
可执行执行）

断言，所提供的可执行文件的执行会抛出ExpectyType的例外并返回例外。

如果抛出了任何例外，或者抛出了其他类型的例外，则此方法将失败。

如果您不想对异常实例执行其他检查，请忽略返回值。

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

该方法将在org.junit.jupiter.api中使用功能界面可执行。

请参阅：

• http://junit.org/junit.org/junit.org/junit5/docs/ current/user-guide/＃写作 - tests-assertions
• http://junit.org/junit5/docs/5.0.0.0.0.0.0.0.0.0.0-m2/api/org/junit/junit/jupiter/jupi/jupi/executable/executable.html
• ：//junit.org/junit5/docs/5.0.0.0.0-m4/api/org/junit/jupiter/jupiter/api/assertions.html#assertthrows-java.lang.lang.class.class-org.junit.junit.jupiter.jupiter.api.api.api.function.executable.executable. - “ rel =“ noreferrer”>http://junit.org/junit5/docs/5.0.0.0.0.0-m4/api/opi/junit/junit/jupiter/jupiter/api/api/assertions.html#assertthrows-jastertthrows-java.java.lang.class-orgrg。 junit.jupiter.api.function.ecutable-

Answer 3

tl; dr：如果您在Junit 5.8.0+版本上，则应使用AssertThrowSactly（）而不是assertthrows（）匹配确切的异常类型。

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

您可以使用assertthrows（），但是使用assertthrows即使抛出的例外是儿童类型，您的断言也会通过。

这是因为，junit 5通过调用class.isintance（..），class.isinstance（..）也将返回true，即使投掷异常是儿童类型。

解决方法是在课堂上断言：

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

Answer 4

他们在Junit 5中更改了它（预期：InvealArgumentException，实际：调用方法），并且代码看起来像这样：

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

Answer 5

现在，junit5提供了一种断言例外的方法，

您可以同时测试一般异常和定制异常

一个一般的例子：

greengegeneralexception.java

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

greengeneralexceptiontest.java.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;
    }
}

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

Answer 6

您可以使用assertthrows（）。我的示例取自docs http://junit.org/junit.org/junit5/junit5/junit5/docs/current5/current5 /用户指导/

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

Answer 7

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

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

呼叫get（）包含一个空arrayList的可选将抛出nosuchelementException。 Assertthrows声明了预期的异常并提供了lambda供应商（不需要参数并返回值）。

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

Answer 8

一个更简单的衬里。使用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()
}

Answer 9

我的解决方案：

    protected <T extends Throwable> void assertExpectedException(ThrowingRunnable methodExpectedToFail, Class<T> expectedThrowableClass,
        String expectedMessage) {
    T exception = assertThrows(expectedThrowableClass, methodExpectedToFail);
    assertEquals(expectedMessage, exception.getMessage());
}

您可以这样称呼：

    assertExpectedException(() -> {
        carService.findById(id);
    }, IllegalArgumentException.class, "invalid id");

Answer 10

这是我在测试时要做的，以确保已抛出异常

//when
final var tripConsumer = new BusTripConsumer(inputStream);
final Executable executable = () -> tripConsumer.deserialiseTripData();

//then
assertThrows(IllegalArgumentException.class, executable);

Answer 11

实际上，我认为该特定示例的文档中存在错误。预期的方法是

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

Answer 12

如 user1075613 ：

您可能有兴趣检查assertj是否比Junit5

更灵活。

，并且还会生成拟合错误消息。 示例：

  assertThatThrownBy(() -> someMethod(param1, param2))
        .isInstanceOf(NullPointerException.class);

Answer 13

这是一种简单的方法。

@Test
void exceptionTest() {

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

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

}

它只有在您期望抛出的例外情况下才能成功。