Package org.junit.jupiter.migrationsupport.rules

Class TestRuleSupport

java.lang.Object

org.junit.jupiter.migrationsupport.rules.TestRuleSupport

All Implemented Interfaces:

AfterEachCallback, BeforeEachCallback, Extension, TestExecutionExceptionHandler

class TestRuleSupport
extends Object
implements BeforeEachCallback, TestExecutionExceptionHandler, AfterEachCallback

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	TestRuleSupport.AdviceInvoker

Field Summary

Fields

Modifier and Type	Field	Description
private final Function<TestRuleAnnotatedMember,AbstractTestRuleAdapter>	adapterGenerator
private final Class<? extends org.junit.rules.TestRule>	ruleType

Constructor Summary

Constructors

Constructor	Description
TestRuleSupport(Function<TestRuleAnnotatedMember,AbstractTestRuleAdapter> adapterGenerator, Class<? extends org.junit.rules.TestRule> ruleType)

Method Summary

Modifier and Type	Method	Description
void	afterEach(ExtensionContext context)	Callback that is invoked after an individual test and any user-defined teardown methods for that test have been executed.
void	beforeEach(ExtensionContext context)	Callback that is invoked before an individual test and any user-defined setup methods for that test have been executed.
private List<Field>	findAnnotatedFields(Object testInstance)
private List<Method>	findAnnotatedMethods(Object testInstance)
private List<TestRuleAnnotatedMember>	findRuleAnnotatedMembers(Object testInstance)
private List<TestRuleAnnotatedMember>	getRuleAnnotatedMembers(ExtensionContext context)
void	handleTestExecutionException(ExtensionContext context, Throwable throwable)	Handle the supplied throwable.
private int	invokeAppropriateMethodOnRuleAnnotatedMembers(ExtensionContext context, boolean reverseOrder, TestRuleSupport.AdviceInvoker adviceInvoker)

Methods inherited from class java.lang.Object

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

Field Details

ruleType

private final Class<? extends org.junit.rules.TestRule> ruleType

adapterGenerator

private final Function<TestRuleAnnotatedMember,AbstractTestRuleAdapter> adapterGenerator

Constructor Details

TestRuleSupport

TestRuleSupport(Function<TestRuleAnnotatedMember,AbstractTestRuleAdapter> adapterGenerator,
 Class<? extends org.junit.rules.TestRule> ruleType)

Method Details

findRuleAnnotatedMembers

private List<TestRuleAnnotatedMember> findRuleAnnotatedMembers(Object testInstance)

See Also:

• BlockJUnit4ClassRunner.withRules(org.junit.runners.model.FrameworkMethod, java.lang.Object, org.junit.runners.model.Statement)
• RunRules

findAnnotatedMethods

private List<Method> findAnnotatedMethods(Object testInstance)

findAnnotatedFields

private List<Field> findAnnotatedFields(Object testInstance)

beforeEach

public void beforeEach(ExtensionContext context)

Description copied from interface: BeforeEachCallback

Callback that is invoked before an individual test and any user-defined setup methods for that test have been executed.

Specified by:

beforeEach in interface BeforeEachCallback

Parameters:

context - the current extension context; never null

handleTestExecutionException

public void handleTestExecutionException(ExtensionContext context,
 Throwable throwable)
                                  throws Throwable

Description copied from interface: TestExecutionExceptionHandler

Handle the supplied throwable.

Implementors must perform one of the following.

1. Swallow the supplied throwable, thereby preventing propagation.
2. Rethrow the supplied throwable as is.
3. Throw a new exception, potentially wrapping the supplied throwable.

If the supplied throwable is swallowed, subsequent TestExecutionExceptionHandlers will not be invoked; otherwise, the next registered TestExecutionExceptionHandler (if there is one) will be invoked with any Throwable thrown by this handler.

Note that the execution exception in the supplied ExtensionContext will not contain the Throwable thrown during invocation of the corresponding @Test method.

Specified by:

handleTestExecutionException in interface TestExecutionExceptionHandler

Parameters:

context - the current extension context; never null

throwable - the Throwable to handle; never null

Throws:

Throwable

afterEach

public void afterEach(ExtensionContext context)

Description copied from interface: AfterEachCallback

Callback that is invoked after an individual test and any user-defined teardown methods for that test have been executed.

Specified by:

afterEach in interface AfterEachCallback

Parameters:

context - the current extension context; never null

invokeAppropriateMethodOnRuleAnnotatedMembers

private int invokeAppropriateMethodOnRuleAnnotatedMembers(ExtensionContext context,
 boolean reverseOrder,
 TestRuleSupport.AdviceInvoker adviceInvoker)

Returns:

the number of appropriate rule-annotated members that were discovered

getRuleAnnotatedMembers

private List<TestRuleAnnotatedMember> getRuleAnnotatedMembers(ExtensionContext context)

Returns:

a modifiable copy of the list of rule-annotated members