This document contains the change log for all JUnit 5 releases since 5.11 GA.
Please refer to the User Guide for comprehensive reference documentation for programmers writing tests, extension authors, and engine authors as well as build tool and IDE vendors.
5.12.0-M1
Date of Release: ❓
Scope: ❓
For a complete list of all closed issues and pull requests for this release, consult the 5.12.0-M1 milestone page in the JUnit repository on GitHub.
JUnit Platform
New Features and Improvements
-
New
addResourceContainerSelectorResolver()
inEngineDiscoveryRequestResolver.Builder
to support the discovery of class path resource based tests, analogous to theaddClassContainerSelectorResolver()
. -
Introduce
ReflectionSupport.makeAccessible(Field)
for third-party use rather than calling the internalReflectionUtils.makeAccessible(Field)
method directly. -
Support both the primitive type
void
and the wrapper typeVoid
in the internalReflectionUtils
to allowString
toClass
conversion in parameterized tests. -
Add support for passing line and column number to
ConsoleLauncher
via--select-file
and--select-resource
. -
ConsoleLauncher
now accepts multiple values for all--select
options. -
Add
--select-unique-id
support to ConsoleLauncher. -
Add
getOutputDirectoryProvider()
method toEngineDiscoveryRequest
andTestPlan
to allow test engines to publish/attach files to containers and tests by callingEngineExecutionListener.fileEntryPublished(…)
. RegisteredTestExecutionListeners
can then access these files by overriding thefileEntryPublished(…)
method. -
The following improvements have been made to the Open Test Reporting XML output:
-
Information about the Git repository, the current branch, the commit hash, and the current worktree status are now included in the XML report, if applicable.
-
A section containing JUnit-specific metadata about each test/container to the HTML report is now written by open-test-reporting when added to the classpath/module path
-
Information about published files is now included as attachments.
-
If output capturing is enabled, the captured output written to
System.out
andSystem.err
is now included in the XML report.
-
-
Output written to
System.out
andSystem.err
from non-test threads is now attributed to the most recent test or container that was started or has written output. -
Introduced contracts for Kotlin-specific assertion methods.
-
New public interface
ClasspathScanner
allowing third parties to provide a custom implementation for scanning the classpath for classes and resources.
JUnit Jupiter
Deprecations and Breaking Changes
-
When injecting
TestInfo
into test class constructors it now contains data of the test method the test class instance is being created for unless the test instance lifecycle is set toPER_CLASS
(in which case it continues to contain the data of the test class). If you require theTestInfo
of the test class, you can implement a class-level lifecycle method (e.g.,@BeforeAll
) and injectTestInfo
into that method. -
When injecting
TestReporter
into test class constructors the published report entries are now associated with the test method rather than the test class unless the test instance lifecycle is set toPER_CLASS
(in which case they will continue to be associated with the test class). If you want to publish report entries for the test class, you can implement a class-level lifecycle method (e.g.,@BeforeAll
) and injectTestReporter
into that method.
New Features and Improvements
-
New
--exclude-methodname
and--include-methodname
options added to theConsoleLauncher
to include or exclude methods based on fully qualified method names without parameters. For example,--exclude-methodname=^org\.example\..+#methodname
will exclude all methods calledmethodName
under packageorg.example
. -
In a
@ParameterizedTest
method, anull
value can now be supplied for Java Date/Time types such asLocalDate
if the newnullable
attribute in@JavaTimeConversionPattern
is set totrue
. -
ArgumentsProvider
(declared via@ArgumentsSource
),ArgumentConverter
(declared via@ConvertWith
), andArgumentsAggregator
(declared via@AggregateWith
) implementations can now use constructor injection from registeredParameterResolver
extensions. -
Extensions based on
TestTemplateInvocationContextProvider
can now allow returning zero invocation contexts by overriding the newmayReturnZeroTestTemplateInvocationContexts
method. -
The new
@ParameterizedTest(allowZeroInvocations = true)
attribute allows to specify that the absence of invocations is expected in some cases and should not cause a test failure. -
Allow determining "shared resources" at runtime via the new
@ResourceLock#providers
attribute that accepts implementations ofResourceLocksProvider
. -
Allow declaring "shared resources" for direct child nodes via the new
@ResourceLock(target = CHILDREN)
attribute. This may improve parallelization when a test class declares aREAD
lock, but only a few methods hold aREAD_WRITE
lock. -
Extensions that implement
TestInstancePreConstructCallback
,TestInstanceFactory
,TestInstancePostProcessor
,ParameterResolver
, orInvocationInterceptor
may override thegetTestInstantiationExtensionContextScope()
method to enable receiving a test-scopedExtensionContext
inExtension
methods called during test class instantiation. This behavior will become the default in future versions of JUnit. -
@TempDir
is now supported on test class constructors. -
Parameterized tests now support argument count validation. If the
junit.jupiter.params.argumentCountValidation=strict
configuration parameter or the@ParameterizedTest(argumentCountValidation = STRICT)
attribute is set, any mismatch between the declared number of arguments and the number of arguments provided by the arguments source will result in an error. By default, it’s still only an error if there are fewer arguments provided than declared. -
The new
PreInterruptCallback
extension point defines the API forExtensions
that wish to be called prior to invocations ofThread#interrupt()
by the@Timeout
extension. -
When enabled via the
junit.jupiter.execution.timeout.threaddump.enabled
configuration parameter, an implementation ofPreInterruptCallback
is registered that writes a thread dump toSystem.out
prior to interrupting a test thread due to a timeout. -
TestReporter
now allows publishing files for a test method or test class which can be used to include them in test reports, such as the Open Test Reporting format.
5.11.4
Date of Release: December 16, 2024
Scope: Bug fixes and enhancements since 5.11.3
For a complete list of all closed issues and pull requests for this release, consult the 5.11.4 milestone page in the JUnit repository on GitHub.
JUnit Platform
Bug Fixes
-
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.
5.11.3
Date of Release: October 21, 2024
Scope: Bug fixes and enhancements since 5.11.2
For a complete list of all closed issues and pull requests for this release, consult the 5.11.3 milestone page in the JUnit repository on GitHub.
JUnit Jupiter
Bug Fixes
-
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.
5.11.2
Date of Release: October 4, 2024
Scope: Bug fixes and enhancements since 5.11.1
For a complete list of all closed issues and pull requests for this release, consult the 5.11.2 milestone page in the JUnit repository on GitHub.
5.11.1
Date of Release: September 25, 2024
Scope: Bug fixes and enhancements since 5.11.0
For a complete list of all closed issues and pull requests for this release, consult the 5.11.1 milestone page in the JUnit repository on GitHub.
JUnit Platform
Bug Fixes
-
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 theget(…)
orgetOrComputeIfAbsent(…)
methods; however, if agetOrComputeIfAbsent(…)
invocation results in the computation of a new value, an exception will still be thrown. -
Fixed potential locking issue with
ExclusiveResource
in theHierarchicalTestExecutorService
, which could lead to deadlocks in certain scenarios.
5.11.0
Date of Release: August 14, 2024
Scope:
-
@FieldSource
annotation for use with@ParameterizedTest
methods -
Repeatable
@..Source
annotations for parameterized tests -
Enhancements for authoring dynamic and parameterized tests
-
@AutoClose
annotation to automatically close field resources in tests -
ConversionSupport
utility for converting from a string to a supported target type -
Extensible syntax for specifying discovery selectors
-
@BeforeSuite
and@AfterSuite
annotations -
Classpath resource scanning support for engines
-
Numerous bug fixes and enhancements regarding field and method search algorithms
For complete details consult the 5.11.0 Release Notes online.