Package org.junit.jupiter.engine.descriptor

Class AbstractExtensionContext<T extends TestDescriptor>

java.lang.Object

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

All Implemented Interfaces:

java.lang.AutoCloseable, ExtensionContext

Direct Known Subclasses:

ClassExtensionContext, DynamicExtensionContext, JupiterEngineExtensionContext, MethodExtensionContext, TestTemplateExtensionContext

abstract class AbstractExtensionContext<T extends TestDescriptor>
extends java.lang.Object
implements ExtensionContext, java.lang.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 JupiterConfiguration	configuration
private EngineExecutionListener	engineExecutionListener
private ExtensionContext	parent
private java.util.Set<java.lang.String>	tags
private T	testDescriptor
private ExtensionValuesStore	valuesStore

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()
private ExtensionValuesStore	createStore(ExtensionContext parent)
java.util.Optional<java.lang.String>	getConfigurationParameter(java.lang.String key)	Get the configuration parameter stored under the specified key.
<V> java.util.Optional<V>	getConfigurationParameter(java.lang.String key, java.util.function.Function<java.lang.String,V> transformer)	Get and transform the configuration parameter stored under the specified key using the specified transformer.
java.lang.String	getDisplayName()	Get the display name for the current test or container.
java.util.Optional<ExtensionContext>	getParent()	Get the parent extension context, if available.
ExtensionContext	getRoot()	Get the root ExtensionContext.
ExtensionContext.Store	getStore(ExtensionContext.Namespace namespace)	Get the ExtensionContext.Store for the supplied ExtensionContext.Namespace.
java.util.Set<java.lang.String>	getTags()	Get the set of all tags for the current test or container.
protected T	getTestDescriptor()
java.lang.String	getUniqueId()	Get the unique ID of the current test or container.
void	publishReportEntry(java.util.Map<java.lang.String,java.lang.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.

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 Detail

parent

private final ExtensionContext parent

engineExecutionListener

private final EngineExecutionListener engineExecutionListener

testDescriptor

private final T extends TestDescriptor testDescriptor

tags

private final java.util.Set<java.lang.String> tags

configuration

private final JupiterConfiguration configuration

valuesStore

private final ExtensionValuesStore valuesStore

Constructor Detail

AbstractExtensionContext

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

Method Detail

createStore

private ExtensionValuesStore createStore(ExtensionContext parent)

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

getUniqueId

public java.lang.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 java.lang.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(java.util.Map<java.lang.String,java.lang.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 java.util.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 java.util.Set<java.lang.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 java.util.Optional<java.lang.String> getConfigurationParameter(java.lang.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> java.util.Optional<V> getConfigurationParameter(java.lang.String key,
                                                           java.util.function.Function<java.lang.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