io.github.glytching.junit.extension.exception

Class ExpectedExceptionExtension

java.lang.Object

io.github.glytching.junit.extension.exception.ExpectedExceptionExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.TestExecutionExceptionHandler

public class ExpectedExceptionExtension
extends Object
implements org.junit.jupiter.api.extension.TestExecutionExceptionHandler

The expected exception extension allows the developer to express the expectations of an exception to be thrown by the code-under-test. This extension is engaged by adding the ExpectedException annotation to a test method.

Usage example:

 public class MyTest {

     @Test
     @ExpectedException(type = Exception.class, messageIs = "Boom!")
     public void canHandleAnException() throws Exception {
         // ...
         throw new Exception("Boom!");
     }


     @Test
     @ExpectedException(type = RuntimeException.class, messageStartsWith = "Bye")
     public void canHandleAnExceptionWithAMessageWhichStartsWith() {
         // ...
         throw new RuntimeException("Bye bye");
     }
 }
 

Since:

1.0.0

See Also:

JUnit 4 ExpectedException Rule

Constructor Summary

Constructors

Constructor and Description
ExpectedExceptionExtension()

Method Summary

Modifier and Type	Method and Description
void	handleTestExecutionException(org.junit.jupiter.api.extension.ExtensionContext extensionContext, Throwable throwable) Handle the supplied Throwable throwable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExpectedExceptionExtension

public ExpectedExceptionExtension()

Method Detail

handleTestExecutionException

public void handleTestExecutionException(org.junit.jupiter.api.extension.ExtensionContext extensionContext,
                                         Throwable throwable)
                                  throws Throwable

Handle the supplied Throwable throwable. If the extensionContext is annotated with ExpectedException and if the throwable matches the expectations expressed in the ExpectedException annotation then the supplied throwable is swallowed otherwise the supplied throwable is rethrown.

Specified by:

handleTestExecutionException in interface org.junit.jupiter.api.extension.TestExecutionExceptionHandler

Parameters:

extensionContext - the current extension context

throwable - the Throwable to handle

Throws:

Throwable