org.junit.jupiter.api.extension

Interface ExtensionContext

All Known Subinterfaces:

ContainerExtensionContext, TestExtensionContext

All Known Implementing Classes:

ClassBasedContainerExtensionContext, MethodBasedTestExtensionContext

@API(value=Experimental)
public interface ExtensionContext

ExtensionContext encapsulates the context in which the current test or container is being executed.

Extensions are provided an instance of ExtensionContext to perform their work.

Since:

5.0

See Also:

ExtensionContext.Store, ExtensionContext.Namespace

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExtensionContext.Namespace A Namespace is used to provide a scope for data saved by extensions within a ExtensionContext.Store.
static interface	ExtensionContext.Store Store provides methods for extensions to save and retrieve data.

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Get the display name for the current test or container.
Optional<AnnotatedElement>	getElement() Get the AnnotatedElement corresponding to the current extension context, if available.
Optional<ExtensionContext>	getParent() Get the parent extension context, if available.
default ExtensionContext.Store	getStore() Get the ExtensionContext.Store for the default, global ExtensionContext.Namespace.
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.
Optional<Class<?>>	getTestClass() Get the Class associated with the current test or container, if available.
Optional<Method>	getTestMethod() Get the Method associated with the current test, if available.
String	getUniqueId() Get the unique ID of the current test or container.
void	publishReportEntry(Map<String,String> map) Publish a map of key-value pairs to be consumed by an org.junit.platform.engine.EngineExecutionListener.
default void	publishReportEntry(String key, String value) Publish the specified key-value pair to be consumed by an org.junit.platform.engine.EngineExecutionListener.

Method Detail

getParent

Optional<ExtensionContext> getParent()

Get the parent extension context, if available.

Returns:

an Optional containing the parent; never null but potentially empty

getUniqueId

String getUniqueId()

Get the unique ID of the current test or container.

Returns:

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

getDisplayName

String getDisplayName()

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.

Returns:

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

getTags

Set<String> getTags()

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.

Returns:

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

getElement

Optional<AnnotatedElement> getElement()

Get the AnnotatedElement corresponding to the current extension context, if available.

For example, if the current extension context encapsulates a test class or test method, the annotated element will be the corresponding Class or Method reference.

Favor this method over more specific methods whenever the AnnotatedElement API suits the task at hand — for example, when looking up annotations regardless of concrete element type.

Returns:

an Optional containing the AnnotatedElement; never null but potentially empty

See Also:

getTestClass(), getTestMethod()

getTestClass

Optional<Class<?>> getTestClass()

Get the Class associated with the current test or container, if available.

Returns:

an Optional containing the class; never null but potentially empty

getTestMethod

Optional<Method> getTestMethod()

Get the Method associated with the current test, if available.

Returns:

an Optional containing the method; never null but potentially empty

publishReportEntry

void publishReportEntry(Map<String,String> map)

Publish a map of key-value pairs to be consumed by an org.junit.platform.engine.EngineExecutionListener.

Parameters:

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

publishReportEntry

default void publishReportEntry(String key,
                                String value)

Publish the specified key-value pair to be consumed by an org.junit.platform.engine.EngineExecutionListener.

Parameters:

key - the key of the published pair; never null or blank

value - the value of the published pair; never null or blank

getStore

default ExtensionContext.Store getStore()

Get the ExtensionContext.Store for the default, global ExtensionContext.Namespace.

Returns:

the default, global Store; never null

See Also:

getStore(Namespace), ExtensionContext.Namespace.DEFAULT

getStore

ExtensionContext.Store getStore(ExtensionContext.Namespace namespace)

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

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