org.junit.jupiter.params.provider.CsvFileSource 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.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.apiguardian.api.API;
/**
* {@code @CsvFileSource} is an {@link ArgumentsSource} which is used to load
* comma-separated value (CSV) files from one or more classpath {@link #resources}
* or {@link #files}.
*
* The CSV records parsed from these resources and files will be provided as
* arguments to the annotated {@code @ParameterizedTest} method. Note that the
* first record may optionally be used to supply CSV headers (see
* {@link #useHeadersInDisplayName}).
*
*
Any line beginning with a {@code #} symbol will be interpreted as a comment
* and will be ignored.
*
*
The column delimiter (which defaults to a comma ({@code ,})) can be customized
* via either {@link #delimiter} or {@link #delimiterString}.
*
*
In contrast to the default syntax used in {@code @CsvSource}, {@code @CsvFileSource}
* uses a double quote ({@code "}) as its quote character by default, but this can
* be changed via {@link #quoteCharacter}. 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}.
*
* @since 5.0
* @see CsvSource
* @see org.junit.jupiter.params.provider.ArgumentsSource
* @see org.junit.jupiter.params.ParameterizedTest
*/
@Target({ ElementType.ANNOTATION_TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@API(status = STABLE, since = "5.7")
@ArgumentsSource(CsvFileArgumentsProvider.class)
@SuppressWarnings("exports")
public @interface CsvFileSource {
/**
* The CSV classpath resources to use as the sources of arguments; must not
* be empty unless {@link #files} is non-empty.
*/
String[] resources() default {};
/**
* The CSV files to use as the sources of arguments; must not be empty
* unless {@link #resources} is non-empty.
*/
String[] files() default {};
/**
* The encoding to use when reading the CSV files; must be a valid charset.
*
*
Defaults to {@code "UTF-8"}.
*
* @see java.nio.charset.StandardCharsets
*/
String encoding() default "UTF-8";
/**
* The line separator to use when reading the CSV files; must consist of 1
* or 2 characters, typically {@code "\r"}, {@code "\n"}, or {@code "\r\n"}.
*
*
Defaults to {@code "\n"}.
*/
String lineSeparator() default "\n";
/**
* 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 @}CsvFileSource(resources = "fruits.csv", useHeadersInDisplayName = true)
* 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 double quote ({@code "}).
*
*
You may change the quote character to anything that makes sense for
* your use case.
*
* @since 5.8.2
*/
@API(status = STABLE, since = "5.10")
char quoteCharacter() default '"';
/**
* The column delimiter character to use when reading the CSV files.
*
*
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 CSV files.
*
*
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 number of lines to skip when reading the CSV files.
*
*
Typically used to skip header lines.
*
*
Defaults to {@code 0}.
*
* @since 5.1
*/
int numLinesToSkip() default 0;
/**
* The empty value to use when reading the CSV files.
*
*
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.
*
*
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;
}