JUnit 5 Release Notes

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.

Fixed handling of global post-discovery filters that apply to @Suite classes.

Since the Turkish language has special characters such as 'ı' and 'İ', the uppercase conversion in DefaultParallelExecutionConfigurationStrategy#getStrategy previously caused all tests to finish with exit code -1. This has been fixed by using the root locale instead of the default one.

Absolute path entries are now supported in JUnit’s Platform Console Launcher on Windows.

Attempts to load a Class for an invalid class name representing an extremely large multidimensional array now fail within a reasonable amount of time.

Fix concurrency issue in classpath scanning.

ConfigurationParameters.size() has been deprecated in favor of the new keySet() method.

Support for the Open Test Reporting format which supports all features of the JUnit Platform such as hierarchical test structures, display names, tags, etc. Please refer to the User Guide for instructions on how to enable such reports in your build.

ConfigurationParameters has a new keySet() method which allows you to retrieve all configuration parameter keys.

New IterationSelector for selecting a subset of a test’s or container’s iterations.

ParallelExecutionConfiguration allows configuring the saturate predicate of the ForkJoinPool used for parallel test execution.

JUnit OSGi bundles now contain engine and launcher requirements ensuring that at resolution time a fully running set of dependencies is calculated, avoiding the need for these to be manually specified.

JUnit Platform Standalone Console JAR now also includes the JUnit Platform Suite Engine.

New failIfNoTests attribute added to @Suite. This will fail the suite if no tests are discovered.

The output color for the ConsoleLauncher can now be customized. The option --single-color will apply a built-in monochrome style, while --color-palette will accept a properties file. See the User Guide for details.

The default theme for the ConsoleLauncher is now determined by the charset reported by the system console on Java 17 and later.

New --list-engines option added to the ConsoleLauncher which displays all registered test engine implementations.

Configuring included EngineFilters that do not match any registered TestEngine results in an error to avoid misconfiguration – for example, due to typos.

New public factory method to instantiate an ExecutionRequest.

Documentation for overriding the JUnit version used in Spring Boot applications. See the User Guide for details.

When cleaning up a @TempDir, only one retry attempt will be made to delete directories.

Since the Turkish language has special characters such as 'ı' and 'İ', the uppercase conversion in DefaultParallelExecutionConfigurationStrategy#getStrategy previously caused all tests to finish with exit code -1. This has been fixed by using the root locale instead of the default one.

@TempDir fields are no longer allowed to be declared as final.

Private lifecycle methods (annotated with @BeforeAll, @AfterAll, @BeforeEach, or @AfterEach) now correctly lead to an exception. Although this is a bug fix, it is technically also a breaking change since there might be existing user code with private lifecycle methods which will now start to fail.

@TempDir now includes a cleanup mode attribute for preventing a temporary directory from being deleted after a test. The default cleanup mode can be configured via a configuration parameter.

Support for FreeBSD and OpenBSD operating systems in @EnabledOnOs and @DisabledOnOs.

New MATCH_NONE mode for @EnumSource that selects only those enum constants whose names match none of the supplied patterns.

The @Order annotation is now a STABLE API.

New TestInstancePreConstructCallback extension API that is called prior to test instance construction – symmetric to the existing TestInstancePreDestroyCallback extension API.

Extensions can now leverage registered ParameterResolver extensions when invoking methods and constructors via the new ExecutableInvoker API available in the ExtensionContext.

A subset of the invocations of parameterized or dynamic tests can now be selected via the new IterationSelector discovery selector when launching the JUnit Platform.

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

@MethodSource factory methods can now accept arguments resolved by registered ParameterResolver extensions.

AssertionFailureBuilder allows reusing Jupiter’s logic for creating failure messages to assist in writing custom assertion methods.

Three new abort methods have been added to the Assumptions class. These are analogous to the fail methods in the Assertions class, but instead of failing they abort the test or container.

Support for enabling/disabling tests based on the system’s hardware architecture via new architectures attributes in @EnabledOnOs and @DisabledOnOs.

Default @MethodSource factory methods can now accept arguments. A default factory method is a method declared in the test class with the same name as the @ParameterizedTest method that is inferred as the factory method when no explicit factory method is specified in the @MethodSource annotation.

Thread mode can be set on @Timeout annotation. It allows to configure whether test code is executed in the thread of the calling code or in a separate thread. The three modes are: INFERRED (default) which resolves the thread mode configured via the property junit.jupiter.execution.timeout.thread.mode.default, SAME_THREAD that executes the test code in the same thread as the calling code, and SEPARATE_THREAD which executes it in a separate thread.

More accurate reporting of intermediate start/finish events, e.g. iterations of the Parameterized runner and classes executed indirectly via the Suite runner, when running with JUnit 4.13 or later.

Text blocks in @CsvSource are now treated like complete CSV files, including support for comments beginning with a # symbol as well as support for new lines within quoted strings. See the User Guide for details and examples.

CSV headers can now be used in display names in parameterized tests. See @CsvSource and @CsvFileSource in the User Guide for details and examples.

The quote character for quoted strings in @CsvSource and @CsvFileSource is now configurable via a new quoteCharacter attribute in each annotation.

@UseTechnicalNames has been deprecated in favor of the new @Suite support which does not require the use of technical names. See the warning in Using JUnit 4 to run the JUnit Platform for details.

ReflectionSupport.findNestedClasses(..) is now thread-safe with regard to cycle detection.

assertLinesMatch() in Assertions no longer fails with a NoSuchElementException if a limited fast-forward followed by at least one more expected line exceeds the remaining actual lines.

assertLinesMatch() in Assertions now handles fast-forwards with leading and trailing spaces correctly and no longer throws an IndexOutOfBoundsException.

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

CSV content in @CsvSource can now be supplied as a text block instead of an array of strings. See the User Guide for details and an example.

The ExecutionMode for the current test or container is now accessible via the ExtensionContext.

Relaxed version constraint in published Gradle Module Metadata to allow downgrading the junit:junit dependency from 4.13.2.