Class DefaulttestContext

java.lang.Object

org.springframework.test.context.support.DefaulttestContext

All Implemented Interfaces:

Serializable, AttributeAccessor, testContext

public class DefaulttestContext
extends Object
implements testContext

Default implementation of the testContext interface.

Since:

4.0

Author:

Sam Brannen, Juergen Hoeller, Rob Harrop

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaulttestContext(Class<?> testClass, MergedContextConfiguration mergedConfig, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate)	Construct a new DefaulttestContext from the supplied arguments.
DefaulttestContext(DefaulttestContext testContext)	Copy constructor for creating a new DefaulttestContext based on the attributes and immutable state of the supplied context.

Method Summary

Modifier and Type	Method	Description
String[]	attributeNames()	Return the names of all attributes.
<T> T	computeAttribute(String name, Function<String,T> computeFunction)	Compute a new value for the attribute identified by name if necessary and set the new value in this AttributeAccessor.
ApplicationContext	getApplicationContext()	Get the application context for this test context.
@Nullable Object	getAttribute(String name)	Get the value of the attribute identified by name.
final MethodInvoker	getMethodInvoker()	Get the MethodInvoker to use.
final Class<?>	gettestClass()	Get the test class for this test context.
final @Nullable Throwable	gettestException()	Get the exception that was thrown during execution of the test method.
final Object	gettestInstance()	Get the current test instance for this test context.
final Method	gettestMethod()	Get the current test method for this test context.
boolean	hasApplicationContext()	Determine if the application context for this test context is present in the context cache.
boolean	hasAttribute(String name)	Return true if the attribute identified by name exists.
void	markApplicationContextDirty(@Nullable DirtiesContext.HierarchyMode hierarchyMode)	Mark the application context associated with this test context as dirty (i.e., by removing it from the context cache and closing it).
void	markApplicationContextUnused()	Mark the application context associated with this test context as unused so that it can be safely paused if no other test classes are actively using the same application context.
@Nullable Object	removeAttribute(String name)	Remove the attribute identified by name and return its value.
void	setAttribute(String name, @Nullable Object value)	Set the attribute defined by name to the supplied value.
final void	setMethodInvoker(MethodInvoker methodInvoker)	Set the MethodInvoker to use.
String	toString()	Provide a String representation of this test context's state.
void	updatestate(@Nullable Object testInstance, @Nullable Method testMethod, @Nullable Throwable testException)	Update this test context to reflect the state of the currently executing test.

Methods inherited from class Object

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

Methods inherited from interface testContext

publishEvent

Constructor Details

DefaulttestContext

public DefaulttestContext(DefaulttestContext testContext)

Copy constructor for creating a new DefaulttestContext based on the attributes and immutable state of the supplied context.

Immutable state includes all arguments supplied to the standard constructor.

Throws:

NullPointerException - if the supplied DefaulttestContext is null

DefaulttestContext

public DefaulttestContext(Class<?> testClass,
 MergedContextConfiguration mergedConfig,
 CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate)

Construct a new DefaulttestContext from the supplied arguments.

Parameters:

testClass - the test class for this test context

mergedConfig - the merged application context configuration for this test context

cacheAwareContextLoaderDelegate - the delegate to use for loading and closing the application context for this test context

Method Details

hasApplicationContext

public boolean hasApplicationContext()

Determine if the application context for this test context is present in the context cache.

Specified by:

hasApplicationContext in interface testContext

Returns:

true if the application context has already been loaded and stored in the context cache

Since:

5.2

See Also:

• getApplicationContext()
• CacheAwareContextLoaderDelegate.isContextLoaded(MergedContextConfiguration)

getApplicationContext

public ApplicationContext getApplicationContext()

Get the application context for this test context.

The default implementation delegates to the CacheAwareContextLoaderDelegate that was supplied when this testContext was constructed.

Specified by:

getApplicationContext in interface testContext

Returns:

the application context (never null)

Throws:

IllegalStateException - if the context returned by the context loader delegate is not active (i.e., has been closed)

See Also:

• CacheAwareContextLoaderDelegate.loadContext(MergedContextConfiguration)

markApplicationContextUnused

public void markApplicationContextUnused()

Mark the application context associated with this test context as unused so that it can be safely paused if no other test classes are actively using the same application context.

The default implementation delegates to the CacheAwareContextLoaderDelegate that was supplied when this testContext was constructed.

Specified by:

markApplicationContextUnused in interface testContext

Since:

7.0

See Also:

• CacheAwareContextLoaderDelegate.unregisterContextUsage(MergedContextConfiguration, Class)

markApplicationContextDirty

public void markApplicationContextDirty(@Nullable DirtiesContext.HierarchyMode hierarchyMode)

Mark the application context associated with this test context as dirty (i.e., by removing it from the context cache and closing it).

The default implementation delegates to the CacheAwareContextLoaderDelegate that was supplied when this testContext was constructed.

Specified by:

markApplicationContextDirty in interface testContext

Parameters:

hierarchyMode - the context cache clearing mode to be applied if the context is part of a hierarchy (may be null)

See Also:

• CacheAwareContextLoaderDelegate.closeContext(MergedContextConfiguration, DirtiesContext.HierarchyMode)

gettestClass

public final Class<?> gettestClass()

Description copied from interface: testContext

Get the test class for this test context.

Since JUnit Jupiter 5.12, if the SpringExtension is used with a test-method scoped ExtensionContext, the Class returned from this method may refer to the test class for the current test method, which may be a @Nested test class within the class for the test instance. Thus, if you need consistent access to the class for the current test instance within an implementation of testExecutionListener.preparetestInstance(testContext), you should invoke testContext.gettestInstance().getClass() instead of testContext.gettestClass().

Specified by:

gettestClass in interface testContext

Returns:

the test class (never null)

See Also:

• @SpringExtensionConfig

gettestInstance

public final Object gettestInstance()

Description copied from interface: testContext

Get the current test instance for this test context.

Note: this is a mutable property.

Specified by:

gettestInstance in interface testContext

Returns:

the current test instance (never null)

See Also:

• testContext.updatestate(Object, Method, Throwable)

gettestMethod

public final Method gettestMethod()

Description copied from interface: testContext

Get the current test method for this test context.

Note: this is a mutable property.

Specified by:

gettestMethod in interface testContext

Returns:

the current test method (never null)

See Also:

• testContext.updatestate(Object, Method, Throwable)

gettestException

public final @Nullable Throwable gettestException()

Description copied from interface: testContext

Get the exception that was thrown during execution of the test method.

Note: this is a mutable property.

Specified by:

gettestException in interface testContext

Returns:

the exception that was thrown, or null if no exception was thrown

See Also:

• testContext.updatestate(Object, Method, Throwable)

updatestate

public void updatestate(@Nullable Object testInstance,
 @Nullable Method testMethod,
 @Nullable Throwable testException)

Description copied from interface: testContext

Update this test context to reflect the state of the currently executing test.

WARNING: This method should only be invoked by the testContextManager.

Caution: concurrent invocations of this method might not be thread-safe, depending on the underlying implementation.

Specified by:

updatestate in interface testContext

Parameters:

testInstance - the current test instance (may be null)

testMethod - the current test method (may be null)

testException - the exception that was thrown in the test method, or null if no exception was thrown

setMethodInvoker

public final void setMethodInvoker(MethodInvoker methodInvoker)

Description copied from interface: testContext

Set the MethodInvoker to use.

By default, this method does nothing.

Concrete implementations should track the supplied MethodInvoker and return it from testContext.getMethodInvoker(). Note that the standard testContext implementation in Spring overrides this method appropriately.

Specified by:

setMethodInvoker in interface testContext

getMethodInvoker

public final MethodInvoker getMethodInvoker()

Description copied from interface: testContext

Get the MethodInvoker to use.

By default, this method returns MethodInvoker.DEFAULT_INVOKER.

Concrete implementations should return the MethodInvoker supplied to testContext.setMethodInvoker(MethodInvoker). Note that the standard testContext implementation in Spring overrides this method appropriately.

Specified by:

getMethodInvoker in interface testContext

setAttribute

public void setAttribute(String name,
 @Nullable Object value)

Description copied from interface: AttributeAccessor

Set the attribute defined by name to the supplied value.

If value is null, the attribute is removed.

In general, users should take care to prevent overlaps with other metadata attributes by using fully-qualified names, perhaps using class or package names as prefix.

Specified by:

setAttribute in interface AttributeAccessor

Parameters:

name - the unique attribute key

value - the attribute value to be attached

getAttribute

public @Nullable Object getAttribute(String name)

Description copied from interface: AttributeAccessor

Get the value of the attribute identified by name.

Return null if the attribute doesn't exist.

Specified by:

getAttribute in interface AttributeAccessor

Parameters:

name - the unique attribute key

Returns:

the current value of the attribute, if any

computeAttribute

public <T> T computeAttribute(String name,
 Function<String,T> computeFunction)

Description copied from interface: AttributeAccessor

Compute a new value for the attribute identified by name if necessary and set the new value in this AttributeAccessor.

If a value for the attribute identified by name already exists in this AttributeAccessor, the existing value will be returned without applying the supplied compute function.

The default implementation of this method is not thread safe but can be overridden by concrete implementations of this interface.

Specified by:

computeAttribute in interface AttributeAccessor

Type Parameters:

T - the type of the attribute value

Parameters:

name - the unique attribute key

computeFunction - a function that computes a new value for the attribute name; the function must not return a null value

Returns:

the existing value or newly computed value for the named attribute

See Also:

• AttributeAccessor.getAttribute(String)
• AttributeAccessor.setAttribute(String, Object)

removeAttribute

public @Nullable Object removeAttribute(String name)

Description copied from interface: AttributeAccessor

Remove the attribute identified by name and return its value.

Return null if no attribute under name is found.

Specified by:

removeAttribute in interface AttributeAccessor

Parameters:

name - the unique attribute key

Returns:

the last value of the attribute, if any

hasAttribute

public boolean hasAttribute(String name)

Description copied from interface: AttributeAccessor

Return true if the attribute identified by name exists.

Otherwise return false.

Specified by:

hasAttribute in interface AttributeAccessor

Parameters:

name - the unique attribute key

attributeNames

public String[] attributeNames()

Description copied from interface: AttributeAccessor

Return the names of all attributes.

Specified by:

attributeNames in interface AttributeAccessor

toString

public String toString()

Provide a String representation of this test context's state.

Overrides:

toString in class Object