org.junit.jupiter.params.provider.CsvSource Maven / Gradle / Ivy
Show all versions of junit-jupiter-params Show documentation
/*
* Copyright 2015-2024 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.provider;
import static org.apiguardian.api.API.Status.STABLE;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.apiguardian.api.API;
/**
* {@code @CsvSource} is a {@linkplain Repeatable repeatable}
* {@link ArgumentsSource} which reads comma-separated values (CSV) from one
* or more CSV records supplied via the {@link #value} attribute or
* {@link #textBlock} attribute.
*
* The supplied values will be provided as arguments to the annotated
* {@code @ParameterizedTest} method.
*
*
The column delimiter (which defaults to a comma ({@code ,})) can be customized
* via either {@link #delimiter} or {@link #delimiterString}.
*
*
By default, {@code @CsvSource} uses a single quote ({@code '}) as its quote
* character, but this can be changed via {@link #quoteCharacter}. See the
* {@code 'lemon, lime'} examples in the documentation for the {@link #value}
* and {@link #textBlock} attributes. An empty, quoted value ({@code ''}) results
* in an empty {@link String} unless the {@link #emptyValue} attribute is set;
* whereas, an entirely empty value is interpreted as a {@code null} reference.
* By specifying one or more {@link #nullValues} a custom value can be interpreted
* as a {@code null} reference (see the User Guide for an example). An
* {@link org.junit.jupiter.params.converter.ArgumentConversionException
* ArgumentConversionException} is thrown if the target type of a {@code null}
* reference is a primitive type.
*
*
NOTE: An unquoted empty value will always be converted to a
* {@code null} reference regardless of any custom values configured via the
* {@link #nullValues} attribute.
*
*
Except within a quoted string, leading and trailing whitespace in a CSV
* column is trimmed by default. This behavior can be changed by setting the
* {@link #ignoreLeadingAndTrailingWhitespace} attribute to {@code true}.
*
*
In general, CSV records should not contain explicit newlines ({@code \n})
* unless they are placed within quoted strings. Note that CSV records supplied
* via {@link #textBlock} will implicitly contain newlines at the end of each
* physical line within the text block. Thus, if a CSV column wraps across a
* new line in a text block, the column must be a quoted string.
*
* @since 5.0
* @see CsvFileSource
* @see org.junit.jupiter.params.provider.ArgumentsSource
* @see org.junit.jupiter.params.ParameterizedTest
*/
@Target({ ElementType.ANNOTATION_TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(CsvSources.class)
@Documented
@API(status = STABLE, since = "5.7")
@ArgumentsSource(CsvArgumentsProvider.class)
@SuppressWarnings("exports")
public @interface CsvSource {
/**
* The CSV records to use as the source of arguments; must not be empty.
*
*
Defaults to an empty array. You therefore must supply CSV content
* via this attribute or the {@link #textBlock} attribute.
*
*
Each value corresponds to a record in a CSV file and will be split using
* the specified {@link #delimiter} or {@link #delimiterString}. Note that
* the first value may optionally be used to supply CSV headers (see
* {@link #useHeadersInDisplayName}).
*
*
If text block syntax is supported by your programming language,
* you may find it more convenient to declare your CSV content via the
* {@link #textBlock} attribute.
*
*
Example
*
* {@literal @}ParameterizedTest
* {@literal @}CsvSource({
* "apple, 1",
* "banana, 2",
* "'lemon, lime', 0xF1",
* "strawberry, 700_000"
* })
* void test(String fruit, int rank) {
* // ...
* }
*
* @see #textBlock
*/
String[] value() default {};
/**
* The CSV records to use as the source of arguments, supplied as a single
* text block; must not be empty.
*
* Defaults to an empty string. You therefore must supply CSV content
* via this attribute or the {@link #value} attribute.
*
*
Text block syntax is supported by various languages on the JVM
* including Java SE 15 or higher. If text blocks are not supported, you
* should declare your CSV content via the {@link #value} attribute.
*
*
Each record in the text block corresponds to a record in a CSV file and will
* be split using the specified {@link #delimiter} or {@link #delimiterString}.
* Note that the first record may optionally be used to supply CSV headers (see
* {@link #useHeadersInDisplayName}).
*
*
In contrast to CSV records supplied via {@link #value}, a text block
* can contain comments. Any line beginning with a hash tag ({@code #}) will
* be treated as a comment and ignored. Note, however, that the {@code #}
* symbol must be the first character on the line without any leading
* whitespace. It is therefore recommended that the closing text block
* delimiter {@code """} be placed either at the end of the last line of
* input or on the following line, vertically aligned with the rest of the
* input (as can be seen in the example below).
*
*
Java's text block
* feature automatically removes incidental whitespace when the code
* is compiled. However other JVM languages such as Groovy and Kotlin do not.
* Thus, if you are using a programming language other than Java and your text
* block contains comments or new lines within quoted strings, you will need
* to ensure that there is no leading whitespace within your text block.
*
*
Example
*
* {@literal @}ParameterizedTest
* {@literal @}CsvSource(quoteCharacter = '"', textBlock = """
* # FRUIT, RANK
* apple, 1
* banana, 2
* "lemon, lime", 0xF1
* strawberry, 700_000
* """)
* void test(String fruit, int rank) {
* // ...
* }
*
* @since 5.8.1
* @see #value
* @see #quoteCharacter
*/
@API(status = STABLE, since = "5.10")
String textBlock() default "";
/**
* Configures whether the first CSV record should be treated as header names
* for columns.
*
* When set to {@code true}, the header names will be used in the
* generated display name for each {@code @ParameterizedTest} method
* invocation. When using this feature, you must ensure that the display name
* pattern for {@code @ParameterizedTest} includes
* {@value org.junit.jupiter.params.ParameterizedTest#ARGUMENTS_PLACEHOLDER} instead of
* {@value org.junit.jupiter.params.ParameterizedTest#ARGUMENTS_WITH_NAMES_PLACEHOLDER}
* as demonstrated in the example below.
*
*
Defaults to {@code false}.
*
*
Example
*
* {@literal @}ParameterizedTest(name = "[{index}] {arguments}")
* {@literal @}CsvSource(useHeadersInDisplayName = true, textBlock = """
* FRUIT, RANK
* apple, 1
* banana, 2
* 'lemon, lime', 0xF1
* strawberry, 700_000
* """)
* void test(String fruit, int rank) {
* // ...
* }
*
* @since 5.8.2
*/
@API(status = STABLE, since = "5.10")
boolean useHeadersInDisplayName() default false;
/**
* The quote character to use for quoted strings.
*
* Defaults to a single quote ({@code '}).
*
*
You may change the quote character to anything that makes sense for
* your use case; however, the primary use case is to allow you to use double
* quotes in {@link #textBlock}.
*
* @since 5.8.2
* @see #textBlock
*/
@API(status = STABLE, since = "5.10")
char quoteCharacter() default '\'';
/**
* The column delimiter character to use when reading the {@linkplain #value records}.
*
*
This is an alternative to {@link #delimiterString} and cannot be
* used in conjunction with {@link #delimiterString}.
*
*
Defaults implicitly to {@code ','}, if neither delimiter attribute is
* explicitly set.
*/
char delimiter() default '\0';
/**
* The column delimiter string to use when reading the {@linkplain #value records}.
*
*
This is an alternative to {@link #delimiter} and cannot be used in
* conjunction with {@link #delimiter}.
*
*
Defaults implicitly to {@code ","}, if neither delimiter attribute is
* explicitly set.
*
* @since 5.6
*/
String delimiterString() default "";
/**
* The empty value to use when reading the {@linkplain #value records}.
*
*
This value replaces quoted empty strings read from the input.
*
*
Defaults to {@code ""}.
*
* @since 5.5
*/
String emptyValue() default "";
/**
* A list of strings that should be interpreted as {@code null} references.
*
*
For example, you may wish for certain values such as {@code "N/A"} or
* {@code "NIL"} to be converted to {@code null} references.
*
*
Please note that unquoted empty values will always be converted
* to {@code null} references regardless of the value of this {@code nullValues}
* attribute; whereas, a quoted empty string will be treated as an
* {@link #emptyValue}.
*
*
Defaults to {@code {}}.
*
* @since 5.6
*/
String[] nullValues() default {};
/**
* The maximum number of characters allowed per CSV column.
*
*
Must be a positive number or {@code -1} to allow an unlimited number
* of characters.
*
*
Defaults to {@code 4096}.
*
* @since 5.7
*/
@API(status = STABLE, since = "5.10")
int maxCharsPerColumn() default 4096;
/**
* Controls whether leading and trailing whitespace characters of unquoted
* CSV columns should be ignored.
*
*
Defaults to {@code true}.
*
* @since 5.8
*/
@API(status = STABLE, since = "5.10")
boolean ignoreLeadingAndTrailingWhitespace() default true;
}