- All Superinterfaces:
Extension
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
TestInstanceFactory
defines the API for Extensions
that wish to create test instances.
Common use cases include creating test instances with special construction requirements or acquiring the test instance from a dependency injection framework.
Extensions that implement TestInstanceFactory
must be registered
at the class level.
Warning
Only one TestInstanceFactory
is allowed to be registered for any
given test class. Registering multiple factories for any single test class
will result in an exception being thrown for all tests in that class, in any
subclass, and in any nested class. Note that any TestInstanceFactory
registered in a superclass or
enclosing class (i.e., in the case of
a @Nested
test class) is inherited. It is therefore the
user's responsibility to ensure that only a single TestInstanceFactory
is registered for any specific test class.
Constructor Requirements
Consult the documentation in Extension
for details on
constructor requirements.
- Since:
- 5.3
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptioncreateTestInstance
(TestInstanceFactoryContext factoryContext, ExtensionContext extensionContext) Callback for creating a test instance for the supplied context.
-
Method Details
-
createTestInstance
Object createTestInstance(TestInstanceFactoryContext factoryContext, ExtensionContext extensionContext) throws TestInstantiationException Callback for creating a test instance for the supplied context.You may annotate your extension with
@EnableTestScopedConstructorContext
for revised handling ofCloseableResource
and to make test-specific data available to your implementation.Note: the
ExtensionContext
supplied to aTestInstanceFactory
will always return an emptyOptional
value fromgetTestInstance()
since the test instance cannot exist before it has been created by aTestInstanceFactory
or the framework itself.- Parameters:
factoryContext
- the context for the test class to be instantiated; nevernull
extensionContext
- the current extension context; nevernull
- Returns:
- the test instance; never
null
- Throws:
TestInstantiationException
- if an error occurs while creating the test instance
-