@API(value=Internal) public final class MethodBasedTestExtensionContext extends Object implements TestExtensionContext
ExtensionContext.Namespace, ExtensionContext.Store| Constructor and Description |
|---|
MethodBasedTestExtensionContext(ExtensionContext parent,
EngineExecutionListener engineExecutionListener,
MethodTestDescriptor testDescriptor,
Object testInstance,
ThrowableCollector throwableCollector) |
| 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.
|
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. |
protected T |
getTestDescriptor() |
Optional<Throwable> |
getTestException()
Get the exception that was thrown during execution of the test associated
with this
TestExtensionContext, if available. |
Object |
getTestInstance()
Get the test instance associated with this
TestExtensionContext. |
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> values)
Publish a map of key-value pairs to be consumed by an
org.junit.platform.engine.EngineExecutionListener. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetDisplayName, getParent, getStore, getStore, getTags, getUniqueId, publishReportEntry, publishReportEntrypublic MethodBasedTestExtensionContext(ExtensionContext parent, EngineExecutionListener engineExecutionListener, MethodTestDescriptor testDescriptor, Object testInstance, ThrowableCollector throwableCollector)
public Optional<AnnotatedElement> getElement()
ExtensionContextAnnotatedElement 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.
getElement in interface ExtensionContextOptional containing the AnnotatedElement;
never null but potentially emptyExtensionContext.getTestClass(),
ExtensionContext.getTestMethod()public Optional<Class<?>> getTestClass()
ExtensionContextClass associated with the current test or container,
if available.getTestClass in interface ExtensionContextOptional containing the class; never null but
potentially emptypublic Optional<Method> getTestMethod()
ExtensionContextMethod associated with the current test, if available.getTestMethod in interface ExtensionContextOptional containing the method; never null but
potentially emptypublic Object getTestInstance()
TestExtensionContextTestExtensionContext.getTestInstance in interface TestExtensionContextnullpublic Optional<Throwable> getTestException()
TestExtensionContextTestExtensionContext, if available.
This method is typically used for logging and tracing purposes. If you
wish to actually handle an exception thrown during test execution,
implement the TestExecutionExceptionHandler API.
Unlike the exception passed to a TestExecutionExceptionHandler,
a test exception returned by this method can be any exception
thrown during the invocation of a @Test method, its surrounding
@BeforeEach and @AfterEach methods, or a test-level
Extension. Note, however, that this method will never return an
exception swallowed by a TestExecutionExceptionHandler.
Furthermore, if multiple exceptions have been thrown during test execution,
the exception returned by this method will be the first such exception with
all additional exceptions suppressed in the first one.
getTestException in interface TestExtensionContextOptional containing the exception thrown; never
null but potentially empty if test execution has not (yet)
resulted in an exceptionpublic String getUniqueId()
ExtensionContextgetUniqueId in interface ExtensionContextnull or blankpublic String getDisplayName()
ExtensionContextThe 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.
getDisplayName in interface ExtensionContextnull or blankpublic void publishReportEntry(Map<String,String> values)
ExtensionContextorg.junit.platform.engine.EngineExecutionListener.publishReportEntry in interface ExtensionContextvalues - the key-value pairs to be published; never null;
keys and values within entries in the map also must not be
null or blankpublic Optional<ExtensionContext> getParent()
ExtensionContextgetParent in interface ExtensionContextOptional containing the parent; never null but
potentially emptyprotected T getTestDescriptor()
public ExtensionContext.Store getStore(ExtensionContext.Namespace namespace)
ExtensionContextExtensionContext.Store for the supplied ExtensionContext.Namespace.getStore in interface ExtensionContextnamespace - the Namespace to get the store for; never nullnullpublic Set<String> getTags()
ExtensionContextTags may be declared directly on the test element or inherited from an outer context.
getTags in interface ExtensionContextnull but
potentially empty