org.junit.jupiter.params.ParameterizedTest Maven / Gradle / Ivy
Show all versions of junit-jupiter-params Show documentation
/*
* Copyright 2015-2021 the original author or authors.
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v2.0 which
* accompanies this distribution and is available at
*
* https://www.eclipse.org/legal/epl-v20.html
*/
package org.junit.jupiter.params;
import static org.apiguardian.api.API.Status.EXPERIMENTAL;
import static org.apiguardian.api.API.Status.STABLE;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.apiguardian.api.API;
import org.junit.jupiter.api.TestTemplate;
import org.junit.jupiter.api.extension.ExtendWith;
/**
* {@code @ParameterizedTest} is used to signal that the annotated method is a
* parameterized test method.
*
* Such methods must not be {@code private} or {@code static}.
*
*
Argument Providers and Sources
*
* {@code @ParameterizedTest} methods must specify at least one
* {@link org.junit.jupiter.params.provider.ArgumentsProvider ArgumentsProvider}
* via {@link org.junit.jupiter.params.provider.ArgumentsSource @ArgumentsSource}
* or a corresponding composed annotation (e.g., {@code @ValueSource},
* {@code @CsvSource}, etc.). The provider is responsible for providing a
* {@link java.util.stream.Stream Stream} of
* {@link org.junit.jupiter.params.provider.Arguments Arguments} that will be
* used to invoke the parameterized test method.
*
*
Formal Parameter List
*
* A {@code @ParameterizedTest} method may declare additional parameters at
* the end of the method's parameter list to be resolved by other
* {@link org.junit.jupiter.api.extension.ParameterResolver ParameterResolvers}
* (e.g., {@code TestInfo}, {@code 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 {@code ParameterResolver}
* implementations must be declared last.
*
*
* In this context, an indexed argument is an argument for a given
* index in the {@code Arguments} provided by an {@code ArgumentsProvider} 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 type
* {@link org.junit.jupiter.params.aggregator.ArgumentsAccessor ArgumentsAccessor}
* or any parameter annotated with
* {@link org.junit.jupiter.params.aggregator.AggregateWith @AggregateWith}.
*
*
Argument Conversion
*
* Method parameters may be annotated with
* {@link org.junit.jupiter.params.converter.ConvertWith @ConvertWith}
* or a corresponding composed annotation to specify an explicit
* {@link org.junit.jupiter.params.converter.ArgumentConverter ArgumentConverter}.
* Otherwise, JUnit Jupiter will attempt to perform an implicit
* conversion to the target type automatically (see the User Guide for further
* details).
*
*
Composed Annotations
*
* {@code @ParameterizedTest} may also be used as a meta-annotation in order
* to create a custom composed annotation that inherits the semantics
* of {@code @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 {@code @Test},
* {@code @RepeatedTest}, {@code @ParameterizedTest}, {@code @TestFactory}, or
* {@code @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
* {@link org.junit.jupiter.api.TestInstance @TestInstance(Lifecycle.PER_CLASS)}.
*
*
To control the order in which test methods are executed, annotate your
* test class or test interface with
* {@link org.junit.jupiter.api.TestMethodOrder @TestMethodOrder} and specify
* the desired {@link org.junit.jupiter.api.MethodOrderer MethodOrderer}
* implementation.
*
* @since 5.0
* @see org.junit.jupiter.params.provider.Arguments
* @see org.junit.jupiter.params.provider.ArgumentsProvider
* @see org.junit.jupiter.params.provider.ArgumentsSource
* @see org.junit.jupiter.params.provider.CsvFileSource
* @see org.junit.jupiter.params.provider.CsvSource
* @see org.junit.jupiter.params.provider.EnumSource
* @see org.junit.jupiter.params.provider.MethodSource
* @see org.junit.jupiter.params.provider.ValueSource
* @see org.junit.jupiter.params.aggregator.ArgumentsAccessor
* @see org.junit.jupiter.params.aggregator.AggregateWith
* @see org.junit.jupiter.params.converter.ArgumentConverter
* @see org.junit.jupiter.params.converter.ConvertWith
*/
@Target({ ElementType.ANNOTATION_TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@API(status = STABLE, since = "5.7")
@TestTemplate
@ExtendWith(ParameterizedTestExtension.class)
public @interface ParameterizedTest {
/**
* Placeholder for the {@linkplain org.junit.jupiter.api.TestInfo#getDisplayName
* display name} of a {@code @ParameterizedTest} method: {displayName}
*
* @since 5.3
* @see #name
*/
String DISPLAY_NAME_PLACEHOLDER = "{displayName}";
/**
* Placeholder for the current invocation index of a {@code @ParameterizedTest}
* method (1-based): {index}
*
* @since 5.3
* @see #name
*/
String INDEX_PLACEHOLDER = "{index}";
/**
* Placeholder for the complete, comma-separated arguments list of the
* current invocation of a {@code @ParameterizedTest} method:
* {arguments}
*
* @since 5.3
* @see #name
*/
String ARGUMENTS_PLACEHOLDER = "{arguments}";
/**
* Placeholder for the complete, comma-separated named arguments list
* of the current invocation of a {@code @ParameterizedTest} method:
* {argumentsWithNames}
*
* @since 5.6
* @see #name
*/
String ARGUMENTS_WITH_NAMES_PLACEHOLDER = "{argumentsWithNames}";
/**
* Default display name pattern for the current invocation of a
* {@code @ParameterizedTest} method: {@value}
*
*
Note that the default pattern does not include the
* {@linkplain #DISPLAY_NAME_PLACEHOLDER display name} of the
* {@code @ParameterizedTest} method.
*
* @since 5.3
* @see #name
* @see #DISPLAY_NAME_PLACEHOLDER
* @see #INDEX_PLACEHOLDER
* @see #ARGUMENTS_WITH_NAMES_PLACEHOLDER
*/
String DEFAULT_DISPLAY_NAME = "[" + INDEX_PLACEHOLDER + "] " + ARGUMENTS_WITH_NAMES_PLACEHOLDER;
/**
* The display name to be used for individual invocations of the
* parameterized test; never blank or consisting solely of whitespace.
*
*
If "{default_display_name}" is returned when invoking name(), we will:
*
* - Look up the new config param from junit-platform.properties, and if it has been set, use it
* - otherwise, we will use the value of the {@link #DEFAULT_DISPLAY_NAME} constant.
*
*
* Supported placeholders
*
* - {@link #DISPLAY_NAME_PLACEHOLDER}
* - {@link #INDEX_PLACEHOLDER}
* - {@link #ARGUMENTS_PLACEHOLDER}
* {0}, {1}, etc.: an individual argument (0-based)
*
* Note that "{default_display_name}" is a flag rather than a placeholder.
*
*
For the latter, you may use {@link java.text.MessageFormat} patterns
* to customize formatting. Please note that the original arguments are
* passed when formatting, regardless of any implicit or explicit argument
* conversions.
*
* @see java.text.MessageFormat
*/
String name() default "{default_display_name}";
/**
* If true, all arguments of the parameterized test implementing {@link AutoCloseable}
* will be closed after {@code @AfterEach} methods and {@code AfterEachCallbacks}
* have been called.
*
* @since 5.8
* @see java.lang.AutoCloseable
* @see ParameterizedTestParameterResolver
*/
@API(status = EXPERIMENTAL, since = "5.8")
boolean autoCloseArguments() default true;
}