org.junit.jupiter.api

Interface TestInfo

@API(value=Experimental)
public interface TestInfo

TestInfo is used to inject information about the current test or container into to @Test, @BeforeEach, @AfterEach, @BeforeAll, and @AfterAll methods.

If a method parameter is of type TestInfo, JUnit will supply an instance of TestInfo corresponding to the current test as the value for the parameter.

Since:

5.0

See Also:

Test, DisplayName

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName() Get the display name of the current test or container.
java.util.Set<java.lang.String>	getTags() Get the set of all tags for the current test or container.
java.util.Optional<java.lang.Class<?>>	getTestClass() Get the Class associated with the current test or container, if available.
java.util.Optional<java.lang.reflect.Method>	getTestMethod() Get the Method associated with the current test, if available.

Method Detail

getDisplayName

java.lang.String getDisplayName()

Get the display name of the current test or container.

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

Default Display Names

If the context in which TestInfo is used is at the container level, the default display name is generated based on the name of the test class. For top-level and @Nested test classes, the default display name is the simple name of the class. For static nested test classes, the default display name is the default display name for the enclosing class concatenated with the simple name of the static nested class, separated by a dollar sign ($). For example, the default display names for the following test classes are TopLevelTests, NestedTests, and TopLevelTests$StaticTests.

   class TopLevelTests {

      @Nested
      class NestedTests {}

      static class StaticTests {}
   }
 

If the context in which TestInfo is used is at the test level, the default display name is the name of the test method concatenated with a comma-separated list of simple names of the parameter types in parentheses. For example, the default display name for the following test method is testUser(TestInfo, User).

   @Test
   void testUser(TestInfo testInfo, @Mock User user) {}
 

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

java.util.Set<java.lang.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.

getTestClass

java.util.Optional<java.lang.Class<?>> getTestClass()

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

getTestMethod

java.util.Optional<java.lang.reflect.Method> getTestMethod()

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