io.micronaut.test.extensions

Class AbstractMicronautExtension<C>

java.lang.Object

io.micronaut.test.extensions.AbstractMicronautExtension<C>

Type Parameters:

C - The extension context

All Implemented Interfaces:

TestExecutionListener

Direct Known Subclasses:

MicronautJunit5Extension, MicronautSpockExtension

public abstract class AbstractMicronautExtension<C>
extends java.lang.Object
implements TestExecutionListener

Abstract base class for both JUnit 5 and Spock.

Since:

1.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
protected io.micronaut.context.ApplicationContext	applicationContext
static java.lang.String	DISABLED_MESSAGE
protected io.micronaut.runtime.EmbeddedApplication	embeddedApplication
static java.lang.String	MISCONFIGURED_MESSAGE
protected java.util.Map<java.lang.String,java.lang.Object>	oldValues
protected io.micronaut.runtime.context.scope.refresh.RefreshScope	refreshScope
protected io.micronaut.inject.BeanDefinition<?>	specDefinition
static java.lang.String	TEST_PROPERTY_SOURCE The name of the property source that contains test properties.
static java.lang.String	TEST_ROLLBACK
static java.lang.String	TEST_TRANSACTION_MODE
static java.lang.String	TEST_TRANSACTIONAL
protected java.util.Map<java.lang.String,java.lang.Object>	testProperties

Constructor Summary

Constructors

Constructor and Description
AbstractMicronautExtension()

Method Summary

Modifier and Type	Method and Description
protected void	afterClass(C context) Executed after the class is complete.
void	afterCleanupTest(TestContext testContext) Executed after the setup method of a test method.
void	afterEach(C context) Executed after each test completes.
void	afterSetupTest(TestContext testContext) Executed after the setup method of a test method.
void	afterTestClass(TestContext testContext) Executed after all of the tests of a class have bean executed.
void	afterTestExecution(TestContext testContext) Executed after a single test iteration has been executed .
void	afterTestMethod(TestContext testContext) Executed after a test method has been executed (a test method may contain multiple iterations).
protected abstract void	alignMocks(C context, java.lang.Object instance)
protected void	beforeClass(C context, java.lang.Class<?> testClass, MicronautTestValue testAnnotationValue) Executed before tests within a class are run.
void	beforeCleanupTest(TestContext testContext) Executed before the setup method of a test method.
protected void	beforeEach(C context, java.lang.Object testInstance, java.lang.reflect.AnnotatedElement method, java.util.List<io.micronaut.context.annotation.Property> propertyAnnotations) To be called by the different implementations before each test method.
void	beforeSetupTest(TestContext testContext) Executed before the setup method of a test method.
void	beforeTestClass(TestContext testContext) Executed before all of the tests of a class are executed.
void	beforeTestExecution(TestContext testContext) Executed before a single test iteration is executed.
void	beforeTestMethod(TestContext testContext) Executed before a test method is executed (a test method may contain multiple iterations).
protected boolean	isTestSuiteBeanPresent(java.lang.Class<?> requiredTestClass)
protected void	postProcessBuilder(io.micronaut.context.ApplicationContextBuilder builder) Allows subclasses to customize the builder right before context initialization.
protected abstract void	resolveTestProperties(C context, MicronautTestValue testAnnotationValue, java.util.Map<java.lang.String,java.lang.Object> testProperties) Resolves any test properties.
protected void	startApplicationContext() Starts the application context.

Methods inherited from class java.lang.Object

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

Field Detail

TEST_ROLLBACK

public static final java.lang.String TEST_ROLLBACK

See Also:

Constant Field Values

TEST_TRANSACTIONAL

public static final java.lang.String TEST_TRANSACTIONAL

See Also:

Constant Field Values

TEST_TRANSACTION_MODE

public static final java.lang.String TEST_TRANSACTION_MODE

See Also:

Constant Field Values

DISABLED_MESSAGE

public static final java.lang.String DISABLED_MESSAGE

See Also:

Constant Field Values

MISCONFIGURED_MESSAGE

public static final java.lang.String MISCONFIGURED_MESSAGE

See Also:

Constant Field Values

TEST_PROPERTY_SOURCE

public static final java.lang.String TEST_PROPERTY_SOURCE

The name of the property source that contains test properties.

See Also:

Constant Field Values

applicationContext

protected io.micronaut.context.ApplicationContext applicationContext

embeddedApplication

protected io.micronaut.runtime.EmbeddedApplication embeddedApplication

refreshScope

protected io.micronaut.runtime.context.scope.refresh.RefreshScope refreshScope

specDefinition

protected io.micronaut.inject.BeanDefinition<?> specDefinition

testProperties

protected java.util.Map<java.lang.String,java.lang.Object> testProperties

oldValues

protected java.util.Map<java.lang.String,java.lang.Object> oldValues

Constructor Detail

AbstractMicronautExtension

public AbstractMicronautExtension()

Method Detail

beforeTestExecution

public void beforeTestExecution(TestContext testContext)
                         throws java.lang.Exception

Executed before a single test iteration is executed.

Specified by:

beforeTestExecution in interface TestExecutionListener

Parameters:

testContext - the test context

Throws:

java.lang.Exception - allows any exception to propagate

beforeCleanupTest

public void beforeCleanupTest(TestContext testContext)
                       throws java.lang.Exception

Description copied from interface: TestExecutionListener

Executed before the setup method of a test method.

Specified by:

beforeCleanupTest in interface TestExecutionListener

Parameters:

testContext - the test context

Throws:

java.lang.Exception - allows any exception to propagate

afterCleanupTest

public void afterCleanupTest(TestContext testContext)
                      throws java.lang.Exception

Description copied from interface: TestExecutionListener

Executed after the setup method of a test method.

Specified by:

afterCleanupTest in interface TestExecutionListener

Parameters:

testContext - the test context

Throws:

java.lang.Exception - allows any exception to propagate

afterTestExecution

public void afterTestExecution(TestContext testContext)
                        throws java.lang.Exception

Executed after a single test iteration has been executed .

Specified by:

afterTestExecution in interface TestExecutionListener

Parameters:

testContext - the test context

Throws:

java.lang.Exception - allows any exception to propagate

beforeTestClass

public void beforeTestClass(TestContext testContext)
                     throws java.lang.Exception

Executed before all of the tests of a class are executed.

Specified by:

beforeTestClass in interface TestExecutionListener

Parameters:

testContext - the test context

Throws:

java.lang.Exception - allows any exception to propagate

afterTestClass

public void afterTestClass(TestContext testContext)
                    throws java.lang.Exception

Executed after all of the tests of a class have bean executed.

Specified by:

afterTestClass in interface TestExecutionListener

Parameters:

testContext - the test context

Throws:

java.lang.Exception - allows any exception to propagate

beforeSetupTest

public void beforeSetupTest(TestContext testContext)
                     throws java.lang.Exception

Description copied from interface: TestExecutionListener

Executed before the setup method of a test method.

Specified by:

beforeSetupTest in interface TestExecutionListener

Parameters:

testContext - the test context

Throws:

java.lang.Exception - allows any exception to propagate

afterSetupTest

public void afterSetupTest(TestContext testContext)
                    throws java.lang.Exception

Description copied from interface: TestExecutionListener

Executed after the setup method of a test method.

Specified by:

afterSetupTest in interface TestExecutionListener

Parameters:

testContext - the test context

Throws:

java.lang.Exception - allows any exception to propagate

beforeTestMethod

public void beforeTestMethod(TestContext testContext)
                      throws java.lang.Exception

Executed before a test method is executed (a test method may contain multiple iterations).

Specified by:

beforeTestMethod in interface TestExecutionListener

Parameters:

testContext - the test context

Throws:

java.lang.Exception - allows any exception to propagate

afterTestMethod

public void afterTestMethod(TestContext testContext)
                     throws java.lang.Exception

Executed after a test method has been executed (a test method may contain multiple iterations).

Specified by:

afterTestMethod in interface TestExecutionListener

Parameters:

testContext - the test context

Throws:

java.lang.Exception - allows any exception to propagate

beforeClass

protected void beforeClass(C context,
                           java.lang.Class<?> testClass,
                           @Nullable
                           MicronautTestValue testAnnotationValue)

Executed before tests within a class are run.

Parameters:

context - The test context

testClass - The test class

testAnnotationValue - The test annotation values

postProcessBuilder

protected void postProcessBuilder(io.micronaut.context.ApplicationContextBuilder builder)

Allows subclasses to customize the builder right before context initialization.

Parameters:

builder - the application context builder

resolveTestProperties

protected abstract void resolveTestProperties(C context,
                                              MicronautTestValue testAnnotationValue,
                                              java.util.Map<java.lang.String,java.lang.Object> testProperties)

Resolves any test properties.

Parameters:

context - The test context

testAnnotationValue - The test annotation

testProperties - The test properties

beforeEach

protected void beforeEach(C context,
                          @Nullable
                          java.lang.Object testInstance,
                          @Nullable
                          java.lang.reflect.AnnotatedElement method,
                          java.util.List<io.micronaut.context.annotation.Property> propertyAnnotations)

To be called by the different implementations before each test method.

Parameters:

context - The test context

testInstance - The test instance

method - The test method

propertyAnnotations - The @Property annotations found in the test method, if any

afterClass

protected void afterClass(C context)

Executed after the class is complete.

Parameters:

context - the context

afterEach

public void afterEach(C context)
               throws java.lang.Exception

Executed after each test completes.

Parameters:

context - The context

Throws:

java.lang.Exception - allows any exception to propagate

startApplicationContext

protected void startApplicationContext()

Starts the application context.

isTestSuiteBeanPresent

protected boolean isTestSuiteBeanPresent(java.lang.Class<?> requiredTestClass)

Parameters:

requiredTestClass - The test class

Returns:

true if the te given class has a bean definition class in the classpath (ie: the annotation processor has been run correctly)

alignMocks

protected abstract void alignMocks(C context,
                                   java.lang.Object instance)

Parameters:

context - The context

instance - The mock instance to inject