Class JupiterEngineExtensionContext

    • Method Detail

      • getElement

        public java.util.Optional<java.lang.reflect.AnnotatedElement> getElement​()
        Description copied from interface: ExtensionContext
        Get the AnnotatedElement corresponding to the current extension context, if available.

        For example, if the current extension context encapsulates a test class, test method, test factory method, or test template 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:
        ExtensionContext.getTestClass(), ExtensionContext.getTestMethod()
      • getTestClass

        public java.util.Optional<java.lang.Class<?>> getTestClass​()
        Description copied from interface: ExtensionContext
        Get the Class associated with the current test or container, if available.
        Returns:
        an Optional containing the class; never null but potentially empty
        See Also:
        ExtensionContext.getRequiredTestClass()
      • getTestInstance

        public java.util.Optional<java.lang.Object> getTestInstance​()
        Description copied from interface: ExtensionContext
        Get the test instance associated with the current test or container, if available.
        Returns:
        an Optional containing the test instance; never null but potentially empty
        See Also:
        ExtensionContext.getRequiredTestInstance()
      • getTestMethod

        public java.util.Optional<java.lang.reflect.Method> getTestMethod​()
        Description copied from interface: ExtensionContext
        Get the Method associated with the current test, if available.
        Returns:
        an Optional containing the method; never null but potentially empty
        See Also:
        ExtensionContext.getRequiredTestMethod()
      • getExecutionException

        public java.util.Optional<java.lang.Throwable> getExecutionException​()
        Description copied from interface: ExtensionContext
        Get the exception that was thrown during execution of the test or container associated with this ExtensionContext, 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, an execution 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. Similarly, if this ExtensionContext represents a test class, the execution exception returned by this method can be any exception thrown in a @BeforeAll or AfterAll method or a class-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.

        Returns:
        an Optional containing the exception thrown; never null but potentially empty if test execution has not (yet) resulted in an exception
      • 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.
        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
      • getTestDescriptor

        protected T getTestDescriptor​()
      • 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