Module org.junit.jupiter.engine

Package org.junit.jupiter.engine.descriptor

Class AbstractExtensionContext<T extends TestDescriptor>

java.lang.Object

org.junit.jupiter.engine.descriptor.AbstractExtensionContext<T>

All Implemented Interfaces:

AutoCloseable, ExtensionContext

Direct Known Subclasses:

ClassExtensionContext, DynamicExtensionContext, JupiterEngineExtensionContext, MethodExtensionContext, TestTemplateExtensionContext

abstract class AbstractExtensionContext<T extends TestDescriptor>
extends Object
implements ExtensionContext, AutoCloseable

Since:

5.0

Nested Class Summary

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

ExtensionContext.Namespace, ExtensionContext.Store

Field Summary

Fields

Modifier and Type	Field	Description
private static final NamespacedHierarchicalStore.CloseAction<ExtensionContext.Namespace>	CLOSE_RESOURCES
private final JupiterConfiguration	configuration
private final EngineExecutionListener	engineExecutionListener
private final ExecutableInvoker	executableInvoker
private final ExtensionContext	parent
private final Set<String>	tags
private final T	testDescriptor
private final NamespacedHierarchicalStore<ExtensionContext.Namespace>	valuesStore

Constructor Summary

Constructors

Constructor	Description
AbstractExtensionContext(ExtensionContext parent, EngineExecutionListener engineExecutionListener, T testDescriptor, JupiterConfiguration configuration, ExecutableInvoker executableInvoker)

Method Summary

Modifier and Type	Method	Description
void	close()
private NamespacedHierarchicalStore<ExtensionContext.Namespace>	createStore(ExtensionContext parent)
Optional<String>	getConfigurationParameter(String key)	Get the configuration parameter stored under the specified key.
<V> Optional<V>	getConfigurationParameter(String key, Function<String,V> transformer)	Get and transform the configuration parameter stored under the specified key using the specified transformer.
String	getDisplayName()	Get the display name for the current test or container.
ExecutableInvoker	getExecutableInvoker()	Get an ExecutableInvoker to invoke methods and constructors with support for dynamic resolution of parameters.
ExecutionMode	getExecutionMode()	Get the ExecutionMode associated with the current test or container.
Optional<ExtensionContext>	getParent()	Get the parent extension context, if available.
protected abstract Node.ExecutionMode	getPlatformExecutionMode()
ExtensionContext	getRoot()	Get the root ExtensionContext.
ExtensionContext.Store	getStore(ExtensionContext.Namespace namespace)	Get the ExtensionContext.Store for the supplied ExtensionContext.Namespace.
Set<String>	getTags()	Get the set of all tags for the current test or container.
protected T	getTestDescriptor()
String	getUniqueId()	Get the unique ID of the current test or container.
void	publishReportEntry(Map<String,String> values)	Publish a map of key-value pairs to be consumed by an org.junit.platform.engine.EngineExecutionListener in order to supply additional information to the reporting infrastructure.
private ExecutionMode	toJupiterExecutionMode(Node.ExecutionMode mode)

Methods inherited from class java.lang.Object

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

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

getElement, getExecutionException, getRequiredTestClass, getRequiredTestInstance, getRequiredTestInstances, getRequiredTestMethod, getTestClass, getTestInstance, getTestInstanceLifecycle, getTestInstances, getTestMethod, publishReportEntry, publishReportEntry

Field Details

CLOSE_RESOURCES

private static final NamespacedHierarchicalStore.CloseAction<ExtensionContext.Namespace> CLOSE_RESOURCES

parent

private final ExtensionContext parent

engineExecutionListener

private final EngineExecutionListener engineExecutionListener

testDescriptor

private final T extends TestDescriptor testDescriptor

tags

private final Set<String> tags

configuration

private final JupiterConfiguration configuration

valuesStore

private final NamespacedHierarchicalStore<ExtensionContext.Namespace> valuesStore

executableInvoker

private final ExecutableInvoker executableInvoker

Constructor Details

AbstractExtensionContext

AbstractExtensionContext(ExtensionContext parent,
 EngineExecutionListener engineExecutionListener,
 T testDescriptor,
 JupiterConfiguration configuration,
 ExecutableInvoker executableInvoker)

Method Details

createStore

private NamespacedHierarchicalStore<ExtensionContext.Namespace> createStore(ExtensionContext parent)

close

public void close()

Specified by:

close in interface AutoCloseable

getUniqueId

public String getUniqueId()

Description copied from interface: ExtensionContext

Get the unique ID of the current test or container.

Specified by:

getUniqueId in interface ExtensionContext

Returns:

the unique ID of the test or container; never null or blank

getDisplayName

public String getDisplayName()

Description copied from interface: ExtensionContext

Get the display name for the current test or container.

The display name is either a default name or a custom name configured via @DisplayName.

For details on default display names consult the Javadoc for TestInfo.getDisplayName().

Note that display names are typically used for test reporting in IDEs and build tools and may contain spaces, special characters, and even emoji.

Specified by:

getDisplayName in interface ExtensionContext

Returns:

the display name of the test or container; never null or blank

publishReportEntry

public void publishReportEntry(Map<String,String> values)

Description copied from interface: ExtensionContext

Publish a map of key-value pairs to be consumed by an org.junit.platform.engine.EngineExecutionListener in order to supply additional information to the reporting infrastructure.

Specified by:

publishReportEntry in interface ExtensionContext

Parameters:

values - the key-value pairs to be published; never null; keys and values within entries in the map also must not be null or blank

See Also:

• ExtensionContext.publishReportEntry(String, String)
• ExtensionContext.publishReportEntry(String)
• EngineExecutionListener.reportingEntryPublished(org.junit.platform.engine.TestDescriptor, org.junit.platform.engine.reporting.ReportEntry)

getParent

public Optional<ExtensionContext> getParent()

Description copied from interface: ExtensionContext

Get the parent extension context, if available.

Specified by:

getParent in interface ExtensionContext

Returns:

an Optional containing the parent; never null but potentially empty

See Also:

• ExtensionContext.getRoot()

getRoot

public ExtensionContext getRoot()

Description copied from interface: ExtensionContext

Get the root ExtensionContext.

Specified by:

getRoot in interface ExtensionContext

Returns:

the root extension context; never null but potentially this ExtensionContext

See Also:

• ExtensionContext.getParent()

getTestDescriptor

protected T getTestDescriptor()

getStore

public ExtensionContext.Store getStore(ExtensionContext.Namespace namespace)

Description copied from interface: ExtensionContext

Get the ExtensionContext.Store for the supplied ExtensionContext.Namespace.

Use getStore(Namespace.GLOBAL) to get the default, global ExtensionContext.Namespace.

A store is bound to its extension context lifecycle. When an extension context lifecycle ends it closes its associated store. All stored values that are instances of ExtensionContext.Store.CloseableResource are notified by invoking their close() methods.

Specified by:

getStore in interface ExtensionContext

Parameters:

namespace - the Namespace to get the store for; never null

Returns:

the store in which to put and get objects for other invocations working in the same namespace; never null

See Also:

• ExtensionContext.Namespace.GLOBAL

getTags

public Set<String> getTags()

Description copied from interface: ExtensionContext

Get the set of all tags for the current test or container.

Tags may be declared directly on the test element or inherited from an outer context.

Specified by:

getTags in interface ExtensionContext

Returns:

the set of tags for the test or container; never null but potentially empty

getConfigurationParameter

public Optional<String> getConfigurationParameter(String key)

Description copied from interface: ExtensionContext

Get the configuration parameter stored under the specified key.

If no such key is present in the ConfigurationParameters for the JUnit Platform, an attempt will be made to look up the value as a JVM system property. If no such system property exists, an attempt will be made to look up the value in the JUnit Platform properties file.

Specified by:

getConfigurationParameter in interface ExtensionContext

Parameters:

key - the key to look up; never null or blank

Returns:

an Optional containing the value; never null but potentially empty

See Also:

• System.getProperty(String)
• ConfigurationParameters

getConfigurationParameter

public <V> Optional<V> getConfigurationParameter(String key,
 Function<String,V> transformer)

Description copied from interface: ExtensionContext

Get and transform the configuration parameter stored under the specified key using the specified transformer.

If no such key is present in the ConfigurationParameters for the JUnit Platform, an attempt will be made to look up the value as a JVM system property. If no such system property exists, an attempt will be made to look up the value in the JUnit Platform properties file.

In case the transformer throws an exception, it will be wrapped in a JUnitException with a helpful message.

Specified by:

getConfigurationParameter in interface ExtensionContext

Parameters:

key - the key to look up; never null or blank

transformer - the transformer to apply in case a value is found; never null

Returns:

an Optional containing the value; never null but potentially empty

See Also:

• System.getProperty(String)
• ConfigurationParameters

getExecutionMode

public ExecutionMode getExecutionMode()

Description copied from interface: ExtensionContext

Get the ExecutionMode associated with the current test or container.

Specified by:

getExecutionMode in interface ExtensionContext

Returns:

the ExecutionMode of the test; never null

See Also:

• @ExecutionMode

getExecutableInvoker

public ExecutableInvoker getExecutableInvoker()

Description copied from interface: ExtensionContext

Get an ExecutableInvoker to invoke methods and constructors with support for dynamic resolution of parameters.

Specified by:

getExecutableInvoker in interface ExtensionContext

getPlatformExecutionMode

protected abstract Node.ExecutionMode getPlatformExecutionMode()

toJupiterExecutionMode

private ExecutionMode toJupiterExecutionMode(Node.ExecutionMode mode)