@CsvFileSource for external CSV in JUnit - Framework Patterns

Framework Mode - @CsvFileSource for external CSV

Folder Structure

project-root/
├── src/
│   ├── main/
│   │   └── java/
│   │       └── com/example/app/
│   │           └── Application.java
│   └── test/
│       ├── java/
│       │   └── com/example/tests/
│       │       ├── CsvDataDrivenTest.java
│       │       └── utils/
│       │           └── TestUtils.java
│       └── resources/
│           └── testdata/
│               └── test-data.csv
├── pom.xml
└── README.md

Test Framework Layers

• Test Classes: Java classes under src/test/java/com/example/tests/ containing JUnit tests using @CsvFileSource to load CSV data.
• Test Data: External CSV files stored in src/test/resources/testdata/ for easy maintenance and separation from code.
• Utilities: Helper classes in utils/ for common test functions like parsing or validation.
• Application Code: Production code under src/main/java/ separate from tests.
• Build & Dependency Management: Managed by pom.xml for Maven, including JUnit 5 dependencies.

Configuration Patterns

• CSV File Location: Place CSV files in src/test/resources/ so they are on the test classpath and accessible via @CsvFileSource(resources = "/testdata/test-data.csv").
• Environment Handling: Use Maven profiles or system properties to switch test configurations if needed, but CSV data remains consistent for data-driven tests.
• Browser or External Config: For UI tests, use src/test/resources/config.properties or environment variables; for CSV-driven unit tests, keep data static.
• Credentials: Avoid storing sensitive data in CSV; use environment variables or secure vaults instead.

Test Reporting and CI/CD Integration

• JUnit Reports: Use JUnit 5's built-in reporting with IDEs and build tools to see test results per CSV data row.
• Build Tools: Integrate tests in Maven lifecycle with mvn test to run CSV-driven tests automatically.
• CI/CD: Configure pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests on each commit and publish reports.
• Failure Analysis: Each CSV row is a separate test case, so failures show which data input caused the issue.

Best Practices

1. Keep CSV Files Small and Focused: One CSV per test scenario to keep tests clear and maintainable.
2. Use Relative Paths: Reference CSV files with classpath-relative paths to avoid environment issues.
3. Validate CSV Format: Ensure CSV files have correct headers and consistent columns to prevent test failures.
4. Separate Test Data from Code: Store CSV files outside source code folders to allow easy updates without code changes.
5. Use Descriptive Test Names: Use JUnit's display names or parameterized test names to show CSV input values in reports.

Self Check

Where in this folder structure would you add a new CSV file for testing login credentials?

Key Result

Use @CsvFileSource to load external CSV files from test resources for clean, maintainable data-driven JUnit tests.

Practice

1. What is the main purpose of using @CsvFileSource in JUnit tests?

easy

A. To run the same test multiple times with different data from a CSV file

B. To write data into a CSV file during test execution

C. To generate random test data automatically

D. To skip tests based on CSV file content

Solution

1. Step 1: Understand the role of @CsvFileSource

   @CsvFileSource provides external CSV data to parameterized tests, allowing multiple runs with different inputs.

2. Step 2: Compare options with this role

   Only To run the same test multiple times with different data from a CSV file correctly describes running tests multiple times with CSV data. Others describe unrelated actions.

3. Final Answer:

   To run the same test multiple times with different data from a CSV file -> Option A

4. Quick Check:

   @CsvFileSource runs tests with CSV data = B [OK]

Hint: Remember: @CsvFileSource feeds test data, not writes or skips [OK]

Common Mistakes:

• Thinking @CsvFileSource writes data instead of reading
• Confusing it with random data generation
• Assuming it controls test skipping

2. Which of the following is the correct syntax to skip the header line in a CSV file when using @CsvFileSource?

easy

A. @CsvFileSource(resources = "/data.csv", skipLines = 1)

B. @CsvFileSource(resources = "/data.csv", skipHeader = true)

C. @CsvFileSource(resources = "/data.csv", ignoreFirstLine = true)

D. @CsvFileSource(resources = "/data.csv", numLinesToSkip = 1)

Solution

1. Step 1: Recall the correct attribute for skipping lines

   The correct attribute to skip lines in @CsvFileSource is numLinesToSkip.

2. Step 2: Match options with correct attribute

   Only @CsvFileSource(resources = "/data.csv", numLinesToSkip = 1) uses numLinesToSkip = 1 which skips the first line (header).

3. Final Answer:

   @CsvFileSource(resources = "/data.csv", numLinesToSkip = 1) -> Option D

4. Quick Check:

   Skip header line = numLinesToSkip = 1 [OK]

Hint: Use numLinesToSkip to skip headers, not skipHeader or ignoreFirstLine [OK]

Common Mistakes:

• Using non-existent attributes like skipHeader or ignoreFirstLine
• Confusing skipLines with numLinesToSkip
• Forgetting to skip header causing test failures

3. Given the CSV file data.csv with content:

name,age
Alice,30
Bob,25

and the test method:

@ParameterizedTest
@CsvFileSource(resources = "/data.csv", numLinesToSkip = 1)
void testUser(String name, int age) {
    System.out.println(name + "-" + age);
}

What will be the printed output when the test runs?

medium

A. name-age
Alice-30
Bob-25

B. Alice-30
Bob-25

C. Alice-30

D. Test fails due to header line

Solution

1. Step 1: Understand numLinesToSkip effect

   numLinesToSkip=1 skips the header line "name,age" so only data lines remain.

2. Step 2: Identify printed lines

   Test runs twice, printing "Alice-30" and "Bob-25" each on separate lines.

3. Final Answer:

   Alice-30 Bob-25 -> Option B

4. Quick Check:

   Header skipped, prints data lines only = D [OK]

Hint: Skip header to avoid printing it as data [OK]

Common Mistakes:

• Not skipping header causing it to print as data
• Expecting header line to print
• Confusing output format with CSV file content

4. Consider this test snippet:

@ParameterizedTest
@CsvFileSource(resources = "/users.csv")
void testUser(String name, int age) {
    assertTrue(age > 0);
}

The CSV file users.csv has a header line. What is the likely problem when running this test?

medium

A. Test will fail because header line is treated as data causing NumberFormatException

B. Test will pass because header is ignored automatically

C. Test will fail due to missing @Test annotation

D. Test will skip all lines and run zero times

Solution

1. Step 1: Check if header is skipped

   No numLinesToSkip is set, so header line is treated as data.

2. Step 2: Understand impact on parsing

   Trying to convert header "age" to int causes NumberFormatException, failing the test.

3. Final Answer:

   Test will fail because header line is treated as data causing NumberFormatException -> Option A

4. Quick Check:

   Header not skipped causes parse error = A [OK]

Hint: Always skip header lines to avoid parsing errors [OK]

Common Mistakes:

• Assuming header is skipped automatically
• Forgetting to add numLinesToSkip=1
• Confusing @ParameterizedTest with @Test

5. You want to test a method that calculates discounts using data from a CSV file with columns: product,price,discountRate. The CSV has a header line. Which is the best way to write the parameterized test method signature and annotation to correctly read and use this data?

hard

A. @ParameterizedTest
@CsvFileSource(resources = "/discounts.csv", numLinesToSkip = 1)
void testDiscount(String product, String price, String discountRate) { ... }

B. @ParameterizedTest
@CsvFileSource(resources = "/discounts.csv")
void testDiscount(String product, int price, int discountRate) { ... }

C. @ParameterizedTest
@CsvFileSource(resources = "/discounts.csv", numLinesToSkip = 1)
void testDiscount(String product, double price, double discountRate) { ... }

D. @ParameterizedTest
@CsvFileSource(resources = "/discounts.csv", skipHeader = true)
void testDiscount(String product, double price, double discountRate) { ... }

Solution

1. Step 1: Identify header skipping attribute

   Use numLinesToSkip = 1 to skip the CSV header line.

2. Step 2: Match method parameters to CSV columns and types

   Product is String, price and discountRate are decimal numbers, so use double for price and discountRate.

3. Step 3: Check options for correctness

   @ParameterizedTest @CsvFileSource(resources = "/discounts.csv", numLinesToSkip = 1) void testDiscount(String product, double price, double discountRate) { ... } correctly uses numLinesToSkip=1 and matching parameter types. @ParameterizedTest @CsvFileSource(resources = "/discounts.csv") void testDiscount(String product, int price, int discountRate) { ... } misses skipping header and uses int instead of double. @ParameterizedTest @CsvFileSource(resources = "/discounts.csv", numLinesToSkip = 1) void testDiscount(String product, String price, String discountRate) { ... } uses String for numeric fields. @ParameterizedTest @CsvFileSource(resources = "/discounts.csv", skipHeader = true) void testDiscount(String product, double price, double discountRate) { ... } uses invalid attribute skipHeader.

4. Final Answer:

   @ParameterizedTest @CsvFileSource(resources = "/discounts.csv", numLinesToSkip = 1) void testDiscount(String product, double price, double discountRate) { ... } -> Option C

5. Quick Check:

   Skip header with numLinesToSkip=1 and match types = C [OK]

Hint: Use numLinesToSkip=1 and match parameter types to CSV columns [OK]

Common Mistakes:

• Using skipHeader instead of numLinesToSkip
• Not skipping header causing parse errors
• Mismatching parameter types with CSV data