JUnit 5 Release Notes

❓

❓

❓

❓

❓

❓

❓

❓

❓

The JUnit feature in GraalVM Native Build Tools has been rewritten to no longer require JUnit classes to be initialized at build time. Therefore, JUnit’s JARs no longer ship with native-image.properties files that contain --initialize-at-build-time options (introduced in 5.12.0). Please update to the most recent version of GraalVM Native Build Tools prior to upgrading to this version of JUnit.

Reintroduce support for JVM shutdown hooks when using the -cp/--classpath option of the ConsoleLauncher. Prior to this release, the created class loader was closed prior to JVM shutdown hooks being invoked, which caused hooks to fail with a ClassNotFoundException when loading classes during shutdown.

Introduce resource management mechanism that allows preparing and sharing state across executions or test engines via stores that are scoped to a LauncherSession or ExecutionRequest. The Jupiter API uses these stores as ancestors to the Store instances accessible via ExtensionContext and provides a new method to access them directly. Please refer to the User Guide for examples of managing session-scoped and request-scoped resources.

Introduce a mechanism for TestEngine implementations to report issues encountered during test discovery. If an engine reports a DiscoveryIssue with a Severity equal to or higher than a configurable critical severity, its tests will not be executed. Instead, the engine will be reported as failed during execution with a failure message listing all critical issues. Non-critical issues will be logged but will not prevent the engine from executing its tests. The critical severity can be configured via a new configuration parameter and, currently, defaults to ERROR. Please refer to the User Guide for details.

Start reporting discovery issues for problematic @Suite classes:

Make validation of including EngineFilters more strict to avoid misconfiguration, for example, due to typos. Prior to this release, an exception was only thrown when none of a filter’s included IDs matched any engine. Now, an exception is thrown if at least one included ID across all filters did not match any engine.

Start reporting discovery issues for potentially problematic test classes:

By default, AutoCloseable objects put into ExtensionContext.Store are now treated like instances of CloseableResource (which has been deprecated) and are closed automatically when the store is closed at the end of the test lifecycle. It’s possible to revert to the old behavior via a configuration parameter. Please also see the migration note for third-party extensions wanting to support both JUnit 5.13 and earlier versions.

java.util.Locale arguments are now converted according to the IETF BCP 47 language tag format. See the User Guide for details.

Avoid reporting potentially misleading validation exception for @ParameterizedClass test classes and @ParameterizedTest methods as suppressed exception for earlier failures.

Fix regression when executing @Nested classes compiled without -parameters in versions of Java prior to 21.

Notify LauncherDiscoveryListener implementation registered via LaucherConfig or on the Launcher of selectorProcessed events.

New ConsoleLauncher options --redirect-stdout and --redirect-stderr for redirecting stdout and stderr output streams to files.

Add TestDescriptor.Visitor.composite(List) factory method for creating a composite visitor that delegates to the given visitors in order.

Introduce test discovery support in EngineTestKit to ease testing for discovery issues produced by a TestEngine. Please refer to the User Guide for details.

This milestone contains preliminary APIs for reporting issues encountered by test engines during test discovery. However, these are still under active development and not yet ready for general use. If you’re a maintainer of a test engine, please wait for the next milestone before adopting these new APIs. If you’re interested, you can follow along our progress in #242.

If the autoCloseArguments attribute in @ParameterizedTest is set to true, all arguments returned by registered ArgumentsProvider implementations are now closed even if the test method declares fewer parameters.

AutoCloseable arguments returned by an ArgumentsProvider are now closed even if they are wrapped with Named.

AutoCloseable arguments returned by an ArgumentsProvider are now closed even if a failure happens prior to invoking the parameterized method.

New @ClassTemplate annotation and ClassTemplateInvocationContextProvider API that allow declaring a top-level or @Nested test class as a template to be invoked multiple times. This may be used, for example, to inject different parameters to be used by all tests in the class template or to set up each invocation of the class template differently. Please refer to the User Guide for details.

New BeforeClassTemplateInvocationCallback and AfterClassTemplateInvocationCallback extension callback interfaces allow implementing extensions that are invoked before and after each invocation of a class template.

New @ParameterizedClass support that builds on @ClassTemplate and allows declaring a top-level or @Nested test class as a parameterized test class to be invoked multiple times with different arguments. The same @…​Source annotations supported with @ParameterizedTest may be used to provide arguments via constructor or field injection. Please refer to the User Guide for details.

New @ParameterizedClass-specific @BeforeParameterizedClassInvocation/@AfterParameterizedClassInvocation lifecycle methods that are invoked once before/after each invocation of the parameterized class.

Provide access to the parameters and resolved arguments of a @ParameterizedTest or @ParameterizedClass by storing ParameterInfo in the ExtensionContext.Store for retrieval by other extensions. Please refer to the Javadoc for details.

New @SentenceFragment annotation which allows one to supply custom text for individual sentence fragments when using the IndicativeSentences DisplayNameGenerator. See the updated documentation in the User Guide for an example.

New TestTemplateInvocationContext.prepareInvocation(ExtensionContext) callback method which allows extensions to prepare the ExtensionContext before the test template method is invoked. This may be used, for example, to store entries in the ExtensionContext.Store to benefit from its cleanup support or for retrieval by other extensions.

Fix handling of CleanupMode.ON_SUCCESS with @TempDir that caused no temporary directories (using that mode) to be deleted after the first failure even if the corresponding tests passed.

Set stable module name org.junit.platform.console.standalone for the junit-platform-console-standalone artifact, superseding the unstable name generated from the name of the JAR file when putting the artifact on the module path.

New ExtensionContext.getEnclosingTestClasses() method to help with migration away from AnnotationSupport.findAnnotation(Class, Class, SearchOption) (deprecated since 1.12.0) to AnnotationSupport.findAnnotation(Class, Class, List).