Package org.junit.jupiter.api

JUnit Jupiter API for writing tests.

Interface Summary

Interface	Description
DisplayNameGenerator	DisplayNameGenerator defines the SPI for generating display names programmatically.
MethodDescriptor	MethodDescriptor encapsulates functionality for a given Method.
MethodOrderer	MethodOrderer defines the API for ordering the test methods in a given test class.
MethodOrdererContext	MethodOrdererContext encapsulates the context in which a MethodOrderer will be invoked.
RepetitionInfo	RepetitionInfo is used to inject information about the current repetition of a repeated test into @RepeatedTest, @BeforeEach, and @AfterEach methods.
TestInfo	TestInfo is used to inject information about the current test or container into to @Test, @RepeatedTest, @ParameterizedTest, @TestFactory, @BeforeEach, @AfterEach, @BeforeAll, and @AfterAll methods.
TestReporter	Parameters of type TestReporter can be injected into @BeforeEach and @AfterEach lifecycle methods as well as methods annotated with @Test, @RepeatedTest, @ParameterizedTest, @TestFactory, etc.

Class Summary

Class	Description
Assertions	Assertions is a collection of utility methods that support asserting conditions in tests.
Assumptions	Assumptions is a collection of utility methods that support conditional test execution based on assumptions.
DisplayNameGenerator.ReplaceUnderscores	Replace all underscore characters with spaces.
DisplayNameGenerator.Standard	Standard display name generator.
DynamicContainer	A DynamicContainer is a container generated at runtime.
DynamicNode	DynamicNode serves as the abstract base class for a container or a test case generated at runtime.
DynamicTest	A DynamicTest is a test case generated at runtime.
MethodOrderer.Alphanumeric	MethodOrderer that sorts methods alphanumerically based on their names using String.compareTo(String).
MethodOrderer.OrderAnnotation	MethodOrderer that sorts methods based on the @Order annotation.
MethodOrderer.Random	MethodOrderer that orders methods pseudo-randomly and allows for concurrent execution by default.

Enum Summary

Enum	Description
TestInstance.Lifecycle	Enumeration of test instance lifecycle modes.

Annotation Types Summary

Annotation Type	Description
AfterAll	@AfterAll is used to signal that the annotated method should be executed after all tests in the current test class.
AfterEach	@AfterEach is used to signal that the annotated method should be executed after each @Test, @RepeatedTest, @ParameterizedTest, @TestFactory, and @TestTemplate method in the current test class.
BeforeAll	@BeforeAll is used to signal that the annotated method should be executed before all tests in the current test class.
BeforeEach	@BeforeEach is used to signal that the annotated method should be executed before each @Test, @RepeatedTest, @ParameterizedTest, @TestFactory, and @TestTemplate method in the current test class.
Disabled	@Disabled is used to signal that the annotated test class or test method is currently disabled and should not be executed.
DisplayName	@DisplayName is used to declare a custom display name for the annotated test class or test method.
DisplayNameGeneration	@DisplayNameGeneration is used to declare a custom display name generator for the annotated test class.
Nested	@Nested is used to signal that the annotated class is a nested, non-static test class (i.e., an inner class) that can share setup and state with an instance of its enclosing class.
Order	@Order is a method-level annotation that is used to configure the order in which the annotated method should be executed relative to other methods of the same category.
RepeatedTest	@RepeatedTest is used to signal that the annotated method is a test template method that should be repeated a specified number of times with a configurable display name.
Tag	@Tag is a repeatable annotation that is used to declare a tag for the annotated test class or test method.
Tags	@Tags is a container for one or more @Tag declarations.
Test	@Test is used to signal that the annotated method is a test method.
TestFactory	@TestFactory is used to signal that the annotated method is a test factory method.
TestInstance	@TestInstance is a type-level annotation that is used to configure the lifecycle of test instances for the annotated test class or test interface.
TestMethodOrder	@TestMethodOrder is a type-level annotation that is used to configure a MethodOrderer for the test methods of the annotated test class or test interface.
TestTemplate	@TestTemplate is used to signal that the annotated method is a test template method.