Package com.karuslabs.elementary.junit

Class ToolsExtension

java.lang.Object

com.karuslabs.elementary.junit.ToolsExtension

All Implemented Interfaces:

Consumer<LabelSource>, AfterAllCallback, Extension, InvocationInterceptor, ParameterResolver, TestInstanceFactory, ArgumentsProvider, AnnotationConsumer<LabelSource>

public class ToolsExtension
extends Object
implements ArgumentsProvider, AnnotationConsumer<LabelSource>, ParameterResolver

A JUnit extension that provides an annotation processing environment in which to execute tests. The annotation processing utilities can be accessed either via Tools or injected through the test class's constructor or test method's parameters.

Java source files may be included for compilation by annotating the test class with @Classpath, @Inline, @Introspect or @Resource.

Elements can be used in parameterized tests using @LabelSource.

Nested Class Summary

Nested classes/interfaces inherited from interface org.junit.jupiter.api.extension.InvocationInterceptor

InvocationInterceptor.Invocation<T extends Object>

Constructor Summary

Constructors

Constructor	Description
ToolsExtension()

Method Summary

Modifier and Type	Method	Description
void	accept(LabelSource source)
void	afterAll(ExtensionContext context)	Tears down the compiler.
Object	createTestInstance(TestInstanceFactoryContext factory, ExtensionContext context)	Starts the compiler and creates an instance of the test class if it has only 1 constructor with supported parameters.
void	interceptTestMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> method, ExtensionContext context)	Intercepts a test method invocation to determine if it is annotated with Classpath, @Resource or @Inline.
Stream<? extends Arguments>	provideArguments(ExtensionContext context)
Object	resolveParameter(ParameterContext parameter, ExtensionContext context)
boolean	supportsParameter(ParameterContext parameter, ExtensionContext context)	Tests if a parameter is supported.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.junit.jupiter.api.extension.InvocationInterceptor

interceptAfterAllMethod, interceptAfterEachMethod, interceptBeforeAllMethod, interceptBeforeEachMethod, interceptDynamicTest, interceptDynamicTest, interceptTestClassConstructor, interceptTestFactoryMethod, interceptTestTemplateMethod

Constructor Details

ToolsExtension

public ToolsExtension()

Method Details

accept

public void accept(LabelSource source)

Specified by:

accept in interface Consumer<LabelSource>

provideArguments

public Stream<? extends Arguments> provideArguments(ExtensionContext context)
                                             throws Exception

Specified by:

provideArguments in interface ArgumentsProvider

Throws:

Exception

resolveParameter

public Object resolveParameter(ParameterContext parameter,
 ExtensionContext context)
                        throws ParameterResolutionException

Specified by:

resolveParameter in interface ParameterResolver

Throws:

ParameterResolutionException

supportsParameter

public boolean supportsParameter(ParameterContext parameter,
 ExtensionContext context)

Tests if a parameter is supported. All types returned by the methods in Tools are supported.

Specified by:

supportsParameter in interface ParameterResolver

Parameters:

parameter - the parmaeter's context

context - this extension's context

Returns:

true if the parameter is supported; otherwise false

createTestInstance

public Object createTestInstance(TestInstanceFactoryContext factory,
 ExtensionContext context)
                          throws TestInstantiationException

Starts the compiler and creates an instance of the test class if it has only 1 constructor with supported parameters.

Specified by:

createTestInstance in interface TestInstanceFactory

Parameters:

factory - the factory

context - the extension context

Returns:

an instance of the test class

Throws:

TestInstantiationException - if the test class has more than 1 constructor

UnsupportedOperationException - if parallel test execution is enabled

interceptTestMethod

public void interceptTestMethod(InvocationInterceptor.Invocation<Void> invocation,
 ReflectiveInvocationContext<Method> method,
 ExtensionContext context)
                         throws Throwable

Intercepts a test method invocation to determine if it is annotated with Classpath, @Resource or @Inline.

Specified by:

interceptTestMethod in interface InvocationInterceptor

Parameters:

invocation - the invocation

method - the method

context - the context

Throws:

IllegalArgumentException - if the test method is annotated with @Resource or @Inline

Throwable - if the invocation throws an exception

afterAll

public void afterAll(ExtensionContext context)

Tears down the compiler.

Specified by:

afterAll in interface AfterAllCallback

Parameters:

context - the context