JUnit 5 Release Notes

Escape whitespace characters (such as line breaks) in XML attribute values (such as exception messages) in the legacy XML report generated by the Console Launcher. This change ensures the resulting XML files can be processed by downstream tools while preserving whitespace characters.

Enable auto-flushing of output in the ConsoleLauncher to fix issues with buffering, in particular when using the --details=testfeed option.

JAVA_25 has been added to the JRE enum for use with JRE-based execution conditions.

Fixed a regression in method search algorithms introduced in 5.11.0 when classes reside in the default package and using a Java 8 runtime.

Extensions can once again be registered via multiple @ExtendWith meta-annotations on the same composed annotation on a field within a test class.

@ExtendWith annotations can now also be repeated when used directly on fields and parameters.

All @…​Source annotations of parameterized tests can now also be repeated when used as meta annotations.

Fix regression in parallel execution that was introduced in 5.11.1 regarding global read-write locks. When such a lock was declared on descendants of top-level nodes in the test tree, such as Cucumber scenarios, test execution failed.

Fix support for disabling ANSI colors on the console when the NO_COLOR environment variable is available.

NamespacedHierarchicalStore no longer throws an exception after it has been closed if the store is queried via one of the get(…​) or getOrComputeIfAbsent(…​) methods; however, if a getOrComputeIfAbsent(…​) invocation results in the computation of a new value, an exception will still be thrown.

Fixed potential locking issue with ExclusiveResource in the HierarchicalTestExecutorService, which could lead to deadlocks in certain scenarios.

Improve parallelism and reduce number of blocked threads used by HierarchicalTestEngine implementations when parallel execution is enabled and the global read-write lock is used.

TestWatcher callback methods can once again access data in the ExtensionContext.Store.

Improve parallelism and reduce number of blocked threads in the presence of @Isolated tests when parallel execution is enabled

Java classes in published artifacts are now compiled with the -parameters option of javac and thus now contain metadata for reflection on parameters such as their names.

Field and method search algorithms now adhere to standard Java semantics regarding whether a given field or method is visible or overridden according to the rules of the Java language. See the new Field and Method Search Semantics section of the User Guide for details.

ReflectionSupport.findFields(…​) now returns a distinct set of fields.

Fixed parsing of recursive jar URIs which allows the JUnit Platform Launcher to be used inside Spring Boot executable jars for Spring Boot 3.2 and later.

The junit-platform-suite-engine now includes configuration provided via @ConfigurationParameter when selecting tests by UniqueId (backported to 5.10.3).

In order to support using @EnabledInNativeImage on test classes, UniqueIdTrackingListener now tracks descendants of skipped test containers (backported to 5.10.3).

Attempting to deserialize a TestIdentifier no longer causes a NullPointerException when there is no parent identifier. See issue 3819 (backported to 5.10.3).

As mentioned in the Bug Fixes section above, field and method search algorithms now adhere to standard Java semantics regarding whether a given field or method is visible or overridden according to the rules of the Java language. The changes in the search algorithms may, however, result in breaking changes for some use cases. In light of that, it is possible to revert to the previous "legacy semantics". See the new Field and Method Search Semantics section of the User Guide for details.

New ConversionSupport utility in junit-platform-commons which exposes the conversion logic that was previously private to JUnit Jupiter’s @ParameterizedTest infrastructure — for use in third-party extensions and test engines.

Error messages for type mismatches in NamespacedHierarchicalStore now include the actual type and value in addition to the required type.

Updated open-test-reporting dependency to 0.1.0-M2.

All Platform implementations of DiscoverySelector now have a parseable string representation that can be generated by calling the new DiscoverySelector.toIdentifier() method and toString() on the returned DiscoverySelectorIdentifier. This string representation can be used to reconstruct the original DiscoverySelector by calling the new DiscoverySelectors.parse() method. This change will allow build tools and IDEs to provide generic mechanisms for specifying selectors on the command line or in configuration files without having to support each selector type individually.

The Console Launcher now provides a --version option.

NamespacedHierarchicalStore now throws an IllegalStateException for any attempt to modify or query the store after it has been closed. In addition, an attempt to close a store that has already been closed will have no effect.

Introduce @ConfigurationParametersResource for @Suite classes and --config-resource option for ConsoleLauncher that allow specifying additional properties files on the classpath as sources of configuration parameters.

New rootCause() condition in TestExecutionResultConditions that matches if an exception’s root cause matches all supplied conditions, for use with the EngineTestKit.

ReflectionSupport now supports scanning for classpath resources.

Introduce @BeforeSuite and @AfterSuite lifecycle methods for @Suite classes.

Due to changes in the JUnit Platform regarding field and method search algorithms (see Bug Fixes above), numerous bugs have been addressed within JUnit Jupiter, including but not limited to the following.

MethodOrderer.Random and ClassOrderer.Random now use the same default seed that is generated during class initialization (backported to 5.10.3).

TestInstancePostProcessor extensions can now be registered via the @ExtendWith annotation on non-static fields.

Methods and constructors invoked via ExecutableInvoker now use the same extensions as the context they are invoked from and the same ExtensionContext is passed to registered instances of ParameterResolver.

The org.junit.jupiter.api.extension.support package is now exported from the org.junit.jupiter.api module

The registration order of extensions was changed to allow non-static fields to be processed earlier. This change may affect extensions that rely on the order of registration.

Kotlin support now depends on Kotlin API and language version 1.6; whereas, it previously depended on version 1.3.

New @FieldSource annotation for use with @ParameterizedTest methods which allows you to source arguments from a local field or an external field referenced by fully qualified field name. This feature is similar to the existing @MethodSource feature. See the User Guide for details.

New @AutoClose annotation that can be applied to fields within tests to automatically close the annotated resource after test execution. See the User Guide for details.

JAVA_23 and JAVA_24 have been added to the JRE enum for use with JRE-based execution conditions.

New Exception Handling documentation in the User Guide.

Improved documentation for Assumptions in the User Guide.

Improved Javadoc for assertThrows() and assertThrowsExactly() to make it clear that the supplied message is not the expected message of the thrown exception.

Improved documentation for semantics of a disabled test regarding class-level lifecycle methods and callbacks.

@..Source annotations for parameterized tests can now be used as repeatable annotations. See the User Guide for details.

New argumentSet() factory method for providing a custom name for an entire set of arguments for a @ParameterizedTest. See the User Guide for details.

New assertInstanceOf methods added for Kotlin following up with similar Java assertInstanceOf methods introduced in 5.8 version.

New generators in DynamicTest that take a Stream/Iterator of Named<Executable> along with a convenient NamedExecutable interface that can simplify writing dynamic tests, in particular in recent versions of Java that support records.

@TempDir now suppresses NoSuchFileException when attempting to delete files that may have been already deleted by another thread or process.

@TempDir now fails fast in case TempDirFactory::createTempDirectory returns null, a file, or a symbolic link to a file.

@TempDir now fails fast in case the annotated target is of type File and TempDirFactory::createTempDirectory returns a Path that does not belong to the default file system.

Allow potentially unlimited characters per column in @CsvSource and @CsvFileSource by specifying maxCharsPerColumn = -1.

Fix regression in parallel execution that was introduced in 5.10.4 regarding global read-write locks. When such a lock was declared on descendants of top-level nodes in the test tree, such as Cucumber scenarios, test execution failed.

Fix support for disabling ANSI colors on the console when the NO_COLOR environment variable is available.

Fixed potential locking issue with ExclusiveResource in the HierarchicalTestExecutorService, which could lead to deadlocks in certain scenarios.

Improve parallelism and reduce number of blocked threads used by HierarchicalTestEngine implementations when parallel execution is enabled and the global read-write lock is used.

JAVA_23 and JAVA_24 have been added to the JRE enum for use with JRE-based execution conditions.

Improve parallelism and reduce number of blocked threads in the presence of @Isolated tests when parallel execution is enabled

The junit-platform-suite-engine now includes configuration provided via @ConfigurationParameter when selecting tests by UniqueId.

In order to support using @EnabledInNativeImage on test classes, UniqueIdTrackingListener now tracks descendants of skipped test containers.

Attempting to deserialize a TestIdentifier no longer causes a NullPointerException when there is no parent identifier. See issue 3819.

TempDir suppresses NoSuchFileException when deleting files that may have been deleted by another thread or process.

MethodOrderer.Random and ClassOrderer.Random now use the same default seed that is generated during class initialization.

The junit-platform-launcher may now be used as a Java module when junit.platform.launcher.interceptors.enabled is set to true.

Field predicates are no longer applied eagerly while searching the type hierarchy.

Method predicates are no longer applied eagerly while searching the type hierarchy.

JUnit Jupiter once again properly detects when a @Test method is overridden in a subclass.

A package-private static field annotated with @TempDir is once again shadowed by a non-static field annotated with @TempDir when the non-static field resides in a different package and has the same name as the static field.

A package-private class-level lifecycle method annotated with @BeforeAll or @AfterAll is once again shadowed by a method-level lifecycle method annotated with @BeforeEach or @AfterEach when the method-level lifecycle method resides in a different package and has the same name as the class-level lifecycle method.

Field predicates are now applied while searching the type hierarchy. This fixes bugs in findFields(…​) and streamFields(…​) in ReflectionSupport as well as findAnnotatedFields(…​) and findAnnotatedFieldValues(…​) in AnnotationSupport.

Method predicates are now applied while searching the type hierarchy. This fixes bugs in findMethods(…​) and streamMethods(…​) in ReflectionSupport as well as findAnnotatedMethods(…​) in AnnotationSupport.

A package-private static field annotated with @TempDir is no longer shadowed by a non-static field annotated with @TempDir when the non-static field resides in a different package and has the same name as the static field.

A package-private class-level lifecycle method annotated with @BeforeAll or @AfterAll is no longer shadowed by a method-level lifecycle method annotated with @BeforeEach or @AfterEach when the method-level lifecycle method resides in a different package and has the same name as the class-level lifecycle method.

The ON_SUCCESS cleanup mode of @TempDir now takes into account failures of test methods and nested tests when it’s declared on the class level, e.g. as a static field.

The RandomNumberExtension example in the User Guide has been updated to properly support Integer types as well as non-static field injection.

Improved Javadoc for Assertions.assertTimeoutPreemptively regarding thread interrupt.

Documentation for @Disabled and conditional annotations now explicitly explains that such annotations are not inherited by subclasses.

Fixed reporting for JUnit 3 test classes that use JUnit 4’s @Ignored annotation.