@CsvFileSource reads CSV records from classpath resources for each invocation of a @ParameterizedTest.
Java source and doc
Definition of CsvFileSource(Version: junit-5 5.0.0) package org.junit.jupiter.params.provider;
........
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@API(status = EXPERIMENTAL, since = "5.0")
@ArgumentsSource(CsvFileArgumentsProvider.class)
public @interface CsvFileSource {
String[] resources(); 1
String encoding() default "UTF-8"; 2
String lineSeparator() default "\n"; 3
char delimiter() default ','; 4
}
Examples
src/test/resources/numbers.csvfirst,second,sum
1,2,3
10,20,30
7,5,12
package com.logicbig.example;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvFileSource;
import static org.junit.jupiter.api.Assertions.assertEquals;
public class ParameterizedCsvFileSourceTest {
@ParameterizedTest(name = "#{index} {0} + {1} = {2}")
@CsvFileSource(resources = "/numbers.csv", numLinesToSkip = 1)
void sumFromCsv(int a, int b, int expectedSum) {
assertEquals(expectedSum, a + b);
}
}
mvn test -Dtest=ParameterizedCsvFileSourceTest OutputD:\example-projects\junit-5\junit-5-parameterized-tests\junit-5-parameterized-csvfilesource>mvn test -Dtest=ParameterizedCsvFileSourceTest [INFO] Scanning for projects... [INFO] [INFO] ------< com.logicbig.example:junit-5-parameterized-csvfilesource >------- [INFO] Building junit-5-parameterized-csvfilesource 1.0-SNAPSHOT [INFO] from pom.xml [INFO] --------------------------------[ jar ]--------------------------------- [INFO] [INFO] --- resources:3.3.1:resources (default-resources) @ junit-5-parameterized-csvfilesource --- [INFO] skip non existing resourceDirectory D:\example-projects\junit-5\junit-5-enabling-disabling-tests\junit-5-parameterized-tests\junit-5-parameterized-csvfilesource\src\main\resources [INFO] [INFO] --- compiler:3.14.1:compile (default-compile) @ junit-5-parameterized-csvfilesource --- [INFO] No sources to compile [INFO] [INFO] --- resources:3.3.1:testResources (default-testResources) @ junit-5-parameterized-csvfilesource --- [INFO] Copying 1 resource from src\test\resources to target\test-classes [INFO] [INFO] --- compiler:3.14.1:testCompile (default-testCompile) @ junit-5-parameterized-csvfilesource --- [INFO] Recompiling the module because of changed source code. [INFO] Compiling 1 source file with javac [debug target 25] to target\test-classes [INFO] [INFO] --- surefire:3.5.0:test (default-test) @ junit-5-parameterized-csvfilesource --- [INFO] Using auto detected provider org.apache.maven.surefire.junitplatform.JUnitPlatformProvider [INFO] [INFO] ------------------------------------------------------- [INFO] T E S T S [INFO] ------------------------------------------------------- [INFO] +--com.logicbig.example.ParameterizedCsvFileSourceTest - 0.315 ss [INFO] | +-- [OK] sumFromCsv(int, int, int) #1 "1" + "2" = "3" - 0.100 ss [INFO] | +-- [OK] sumFromCsv(int, int, int) #2 "10" + "20" = "30" - 0.004 ss [INFO] | '-- [OK] sumFromCsv(int, int, int) #3 "7" + "5" = "12" - 0.002 ss [INFO] [INFO] Results: [INFO] [INFO] Tests run: 3, Failures: 0, Errors: 0, Skipped: 0 [INFO] [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 6.532 s [INFO] Finished at: 2025-12-04T14:06:19+08:00 [INFO] ------------------------------------------------------------------------
Example ProjectDependencies and Technologies Used: - junit-jupiter-engine 6.0.1 (Module "junit-jupiter-engine" of JUnit)
Version Compatibility: 5.0.0 - 6.0.1 Version compatibilities of junit-jupiter-engine with this example:
- 5.0.0
- 5.0.1
- 5.0.2
- 5.0.3
- 5.1.0
- 5.1.1
- 5.2.0
- 5.3.0
- 5.3.1
- 5.3.2
- 5.4.0
- 5.4.1
- 5.4.2
- 5.5.0
- 5.5.1
- 5.5.2
- 5.6.0
- 5.6.1
- 5.6.2
- 5.6.3
- 5.7.0
- 5.7.1
- 5.7.2
- 5.8.0
- 5.8.1
- 5.8.2
- 5.9.0
- 5.9.1
- 5.9.2
- 5.9.3
- 5.10.0
- 5.10.1
- 5.10.2
- 5.10.3
- 5.10.4
- 5.10.5
- 5.11.0
- 5.11.1
- 5.11.2
- 5.11.3
- 5.11.4
- 5.12.0
- 5.12.1
- 5.12.2
- 5.13.0
- 5.13.1
- 5.13.2
- 5.13.3
- 5.13.4
- 5.14.0
- 5.14.1
- 6.0.0
- 6.0.1
Versions in green have been tested.
- junit-jupiter-params 6.0.1 (Module "junit-jupiter-params" of JUnit)
- JDK 25
- Maven 3.9.11
|
|