-
@Target({ANNOTATION_TYPE,METHOD}) @Retention(RUNTIME) @Documented @API(status=STABLE, since="5.7") @TestTemplate @ExtendWith(org.junit.jupiter.params.ParameterizedTestExtension.class) public @interface ParameterizedTest
@ParameterizedTest
is used to signal that the annotated method is a parameterized test method.Such methods must not be
private
orstatic
.Argument Providers and Sources
@ParameterizedTest
methods must specify at least oneArgumentsProvider
via@ArgumentsSource
or a corresponding composed annotation (e.g.,@ValueSource
,@CsvSource
, etc.). The provider is responsible for providing aStream
ofArguments
that will be used to invoke the parameterized test method.Formal Parameter List
A
@ParameterizedTest
method may declare additional parameters at the end of the method's parameter list to be resolved by otherParameterResolvers
(e.g.,TestInfo
,TestReporter
, etc). Specifically, a parameterized test method must declare formal parameters according to the following rules.- Zero or more indexed arguments must be declared first.
- Zero or more aggregators must be declared next.
- Zero or more arguments supplied by other
ParameterResolver
implementations must be declared last.
In this context, an indexed argument is an argument for a given index in the
Arguments
provided by anArgumentsProvider
that is passed as an argument to the parameterized method at the same index in the method's formal parameter list. An aggregator is any parameter of typeArgumentsAccessor
or any parameter annotated with@AggregateWith
.Argument Conversion
Method parameters may be annotated with
@ConvertWith
or a corresponding composed annotation to specify an explicitArgumentConverter
. Otherwise, JUnit Jupiter will attempt to perform an implicit conversion to the target type automatically (see the User Guide for further details).Composed Annotations
@ParameterizedTest
may also be used as a meta-annotation in order to create a custom composed annotation that inherits the semantics of@ParameterizedTest
.Test Execution Order
By default, test methods will be ordered using an algorithm that is deterministic but intentionally nonobvious. This ensures that subsequent runs of a test suite execute test methods in the same order, thereby allowing for repeatable builds. In this context, a test method is any instance method that is directly annotated or meta-annotated with
@Test
,@RepeatedTest
,@ParameterizedTest
,@TestFactory
, or@TestTemplate
.Although true unit tests typically should not rely on the order in which they are executed, there are times when it is necessary to enforce a specific test method execution order — for example, when writing integration tests or functional tests where the sequence of the tests is important, especially in conjunction with
@TestInstance(Lifecycle.PER_CLASS)
.To control the order in which test methods are executed, annotate your test class or test interface with
@TestMethodOrder
and specify the desiredMethodOrderer
implementation.- Since:
- 5.0
- See Also:
Arguments
,ArgumentsProvider
,ArgumentsSource
,CsvFileSource
,CsvSource
,EnumSource
,MethodSource
,ValueSource
,ArgumentsAccessor
,AggregateWith
,ArgumentConverter
,ConvertWith
-
-
Field Summary
Fields Modifier and Type Fields Description static String
ARGUMENTS_PLACEHOLDER
Placeholder for the complete, comma-separated arguments list of the current invocation of a@ParameterizedTest
method:{arguments}
static String
ARGUMENTS_WITH_NAMES_PLACEHOLDER
Placeholder for the complete, comma-separated named arguments list of the current invocation of a@ParameterizedTest
method:{argumentsWithNames}
static String
DEFAULT_DISPLAY_NAME
Default display name pattern for the current invocation of a@ParameterizedTest
method: "[{index}] {argumentsWithNames}"static String
DISPLAY_NAME_PLACEHOLDER
static String
INDEX_PLACEHOLDER
Placeholder for the current invocation index of a@ParameterizedTest
method (1-based):{index}
-
-
-
-
DEFAULT_DISPLAY_NAME
static final String DEFAULT_DISPLAY_NAME
Default display name pattern for the current invocation of a@ParameterizedTest
method: "[{index}] {argumentsWithNames}"Note that the default pattern does not include the display name of the
@ParameterizedTest
method.- Since:
- 5.3
- See Also:
name()
,DISPLAY_NAME_PLACEHOLDER
,INDEX_PLACEHOLDER
,ARGUMENTS_WITH_NAMES_PLACEHOLDER
-
-
Element Detail
-
name
String name
The display name to be used for individual invocations of the parameterized test; never blank or consisting solely of whitespace.Defaults to
DEFAULT_DISPLAY_NAME
.Supported placeholders
DISPLAY_NAME_PLACEHOLDER
INDEX_PLACEHOLDER
ARGUMENTS_PLACEHOLDER
{0}
,{1}
, etc.: an individual argument (0-based)
For the latter, you may use
MessageFormat
patterns to customize formatting. Please note that the original arguments are passed when formatting, regardless of any implicit or explicit argument conversions.- See Also:
MessageFormat
- Default:
- "[{index}] {argumentsWithNames}"
-
-