JUnit 5 Release Notes

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.

Building native images with GraalVM now requires configuring the build arg --initialize-at-build-time=org.junit.platform.launcher.core.LauncherConfig and --initialize-at-build-time=org.junit.jupiter.engine.config.InstantiatingConfigurationParameterConverter.

The getMethodParameterTypes() methods in MethodSelector and NestedMethodSelector have been deprecated and replaced by getParameterTypeNames() for greater clarity.

Various "experimental" APIs have been promoted to "stable", including ModuleSelector, EngineDiscoveryListener, EngineDiscoveryRequestResolver, LauncherSession, LauncherSessionListener, parallel execution support classes, @Suite and related annotations, and others.

All utility methods in ReflectionSupport that return a List now have counterparts which return a Stream.

New tryToLoadClass(…​) variant in ReflectionSupport that accepts an explicit ClassLoader, allowing classes to be resolved with custom ClassLoader arrangements.

ReflectionSupport.findMethod(Class<?>, String, String) now uses the ClassLoader of the supplied Class to load parameter types instead of using the default ClassLoader. This allows parameter types to be resolved with custom ClassLoader arrangements (such as OSGi). Consequently, DiscoverySelectors.selectMethod(Class<?>, String, String) also now works properly with custom ClassLoader arrangements.

New @SelectMethod selector support in the @Suite test engine.

Classes may now be selected by fully-qualified name via the names attribute in @SelectClasses.

New overloaded constructors for ClassSelector, NestedClassSelector, MethodSelector, and NestedMethodSelector that take an explicit ClassLoader as a parameter, allowing selectors to select classes in custom ClassLoader arrangements like in OSGi.

New selectMethod() and selectNestedMethod() variants in DiscoverySelectors that accept a Class<?>…​ argument of parameter types as a type-safe alternative to providing the names of parameter types as a comma-delimited string.

For consistency with JUnit Jupiter lifecycle callbacks, listener method pairs for started/finished and opened/closed events are now invoked using "wrapping" semantics. This means that finished/closed event methods are invoked in reverse order compared to the corresponding started/opened event methods when multiple listeners are registered. This affects the following listener interfaces: TestExecutionListener, EngineExecutionListener, LauncherDiscoveryListener, and LauncherSessionListener.

New LauncherInterceptor SPI for intercepting the creation of instances of Launcher and LauncherSessionlistener as well as invocations of the discover and execute methods of the former. Please refer to the User Guide for details.

Support for limiting the max-pool-size-factor for parallel execution via a configuration parameter.

New testfeed details mode for ConsoleLauncher that prints test execution events as they occur in a concise format.

The existing functionality of the ConsoleLauncher has been split into two subcommands: execute for executing tests and engines for listing registered test engines.

A new discover subcommand has been added to the ConsoleLauncher to print the discovered tests for the specified details mode without executing them.

Improved error message for cyclic graphs detected during test discovery to be more actionable.

Extracted NamespacedHierarchicalStore from JUnit Jupiter engine for reuse by other test engines and their extensions.

New dry-run mode to simulate test execution without actually running tests. Please refer to the User Guide for details.

Stack traces produced by failing tests are now pruned of calls from the org.junit, jdk.internal.reflect, and sun.reflect packages. This feature can be disabled via a configuration parameter. Please refer to the User Guide for details.

New getAncestors() method in TestDescriptor.

The extensions supporting @MethodSource, @EnabledIf, and @DisabledIf now load classes by fully-qualified class name using the ClassLoader obtained from the test class when possible. This allows classes to be resolved with custom ClassLoader arrangements (such as OSGi).

When converting an argument for a @ParameterizedTest method from a fully-qualified class name (String) to a Class, the ClassLoader of the class in which the @ParameterizedTest method is declared is now used to resolve the Class instead of the default ClassLoader.

The dynamic parallel execution strategy now allows the thread pool to be saturated by default.

Implicit type conversion of boolean values like in @CsvSource is now stricter, only allowing values "true" or "false" (case-insensitive), in order to make accidental mistakes apparent and to avoid potential confusion.

Various "experimental" APIs have been promoted to "stable", including MethodOrderer, ClassOrderer, InvocationInterceptor, LifecycleMethodExecutionExceptionHandler, @TempDir, parallel execution annotations, and others.

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

New reason attribute in @Execution which can be used to document the reason for using the selected execution mode.

New junit.jupiter.execution.parallel.config.dynamic.max-pool-size-factor configuration parameter to set the maximum pool size factor.

New junit.jupiter.execution.parallel.config.dynamic.saturate configuration parameter to disable pool saturation.

@RepeatedTest can now be configured with a failure threshold which signifies the number of failures after which remaining repetitions will be automatically skipped. See the User Guide for details.

If @MethodSource is used with a non-static factory method that should be static, the exception thrown now provides the user a meaningful explanation of how to address the problem.

@EmptySource now supports additional types, including Collection and Map subtypes with a public no-arg constructor.

New ArgumentsAccessor.getInvocationIndex() method that supplies the index of a @ParameterizedTest invocation.

New AnnotationBasedArgumentsProvider convenience base class which implements both ArgumentsProvider and AnnotationConsumer.

New AnnotationBasedArgumentConverter convenience base class which implements both ArgumentConverter and AnnotationConsumer.

@TempDir can now be used as a meta-annotation in order to create custom composed annotations. See the @JimfsTempDir example in the User Guide for details.

@TempDir now successfully cleans up files and directories on Windows that are set to read-only.

New TempDirFactory SPI for customizing how the @TempDir extension creates temporary directories. See the User Guide for details.

The User Guide now includes an example implementation of the RandomNumberExtension in order to improve the documentation for extension registration via @ExtendWith on fields.

The scope of applicability for TestWatcher implementations is now more extensively documented in the User Guide and Javadoc.

DisplayNameGenerator methods are now allowed to return null, in order to signal to fall back to the default display name generator.

Parameter types for local @MethodSource factory method names are now validated. For example, @MethodSource("myFactory(example.NonexistentType)") will now result in an exception stating that example.NonexistentType cannot be resolved to a valid type.

The syntax for parameter types in local @MethodSource factory method names now supports canonical array names — for example, you may now specify int[] as in @MethodSource("myFactory(int[])") instead of the binary name [I as in @MethodSource("myFactory([I)") (which was already supported) and @MethodSource("myFactory(java.lang.String[])") instead of @MethodSource("myFactory([Ljava.lang.String;)").

The search algorithm used to find @MethodSource factory methods now applies consistent semantics for local qualified method names and fully-qualified method names for overloaded factory methods.

The {displayName} placeholder for @ParameterizedTest invocation names is no longer parsed using java.text.MessageFormat. Consequently, any text in the display name of the @ParameterizedTest method will be included unmodified in the invocation display name. For example, Kotlin method names and custom display names configured via @DisplayName can now contain apostrophes (') as well as text resembling MessageFormat elements such as {0} or {data}.

Exceptions thrown for files that cannot be deleted when cleaning up a temporary directory created via @TempDir now include the root cause.

Lifecycle methods are allowed to be declared as private again for backwards compatibility; however, using private visibility for lifecycle methods is strongly discouraged and will be disallowed in a future release.

The search algorithm used to find @MethodSource factory methods now falls back to lenient search semantics when a factory method cannot be found by qualified name (without a parameter list) and also provides better diagnostics when a unique factory method cannot be found.

The Java 7 based constructor for ForkJoinPool is no longer accidentally used on Java 9 or higher when invalid ParallelExecutionConfiguration is provided. Instead, an exception is thrown for invalid configuration, thereby preventing invalid configuration from being silently ignored.

New TestPlan.getTestIdentifier(UniqueId) and TestPlan.getChildren(UniqueId) methods to avoid parsing unique IDs unnecessarily during test execution.

Support for limiting the max-pool-size for parallel execution via a configuration parameter.

Suite discovery now ignores cycles encountered in a test suite and logs an informational message at CONFIG level instead of throwing an exception.

New @MethodSource syntax for explicitly selecting an overloaded local factory method without specifying its fully qualified name.

The fixed parallel execution strategy now allows the thread pool to be saturated by default.

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

New junit.jupiter.execution.parallel.config.fixed.max-pool-size configuration parameter to set the maximum pool size.

New junit.jupiter.execution.parallel.config.fixed.saturate configuration parameter to disable pool saturation.

Parameterized tests are now properly reported when used in combination with the Enclosed runner.

ReflectionSupport.findMethods(…​) now returns a distinct set of methods.

Execution in GraalVM native images no longer requires --initialize-at-build-time for OpenTestReportGeneratingListener.

Headers provided via the value attribute in @CsvSource for a @ParameterizedTest are now properly parsed when the useHeadersInDisplayName attribute is set to true.

A @ParameterizedTest method configured with a @MethodSource annotation that references a factory method inherited from multiple interfaces no longer fails with an exception stating that multiple factory methods with the same name were found.

A @ParameterizedTest method configured with a @MethodSource annotation that references a factory method whose name is the same as other non-factory methods in the same class no longer fails with an exception stating that multiple factory methods with the same name were found.

Assertion failures thrown from methods with applied timeouts using ThreadMode.SEPARATE are now properly reported.

New @EnabledInNativeImage and @DisabledInNativeImage annotations for enabling and disabling tests within a GraalVM native image.