@CsvFileSource for external CSV in JUnit - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the @CsvFileSource annotation in JUnit?

It is used to provide external CSV files as a source of parameters for parameterized tests, allowing multiple test cases to run with different input data.

beginner

How do you specify the path to an external CSV file using @CsvFileSource?

You use the resources folder and provide the relative path in the resources attribute, for example: @CsvFileSource(resources = "/data/test-data.csv").

intermediate

What happens if the CSV file specified in @CsvFileSource is missing or the path is incorrect?

The test will fail to run and throw an error indicating that the resource could not be found, so it is important to verify the file path and that the file is included in the test resources.

intermediate

Can @CsvFileSource handle CSV files with headers?

Yes, but you need to skip the header row by setting numLinesToSkip = 1 in the annotation to avoid treating the header as test data.

beginner

Write a simple example of a JUnit 5 parameterized test using @CsvFileSource with an external CSV file.

@ParameterizedTest @CsvFileSource(resources = "/data/input.csv", numLinesToSkip = 1) void testWithCsvFileSource(String input, int expected) { assertNotNull(input); assertTrue(expected >= 0); }

What attribute do you use to specify the CSV file path in @CsvFileSource?

A resources

B files

C path

D location

The correct attribute to specify the CSV file path is resources.

How do you skip the header row in a CSV file when using @CsvFileSource?

A Set <code>skipHeader=true</code>

B Remove the header manually

C Set <code>numLinesToSkip=1</code>

D Use <code>ignoreHeader=true</code>

You skip the header row by setting numLinesToSkip=1 in the annotation.

If the CSV file is not found, what happens when running a test with @CsvFileSource?

A Test passes automatically

B Test is skipped silently

C Test runs with empty data

D Test fails with an error

The test fails with an error indicating the resource could not be found.

Which JUnit feature does @CsvFileSource support?

A Parameterized tests

B Test suites

C Mocking objects

D Test lifecycle callbacks

@CsvFileSource is used for parameterized tests to run the same test with different inputs.

Where should the CSV file be placed to be accessible by @CsvFileSource?

A Inside the <code>src/main/java</code> folder

B Inside the <code>src/test/resources</code> folder

C In the root project folder

D Anywhere on the computer

CSV files should be placed in src/test/resources so they are available on the test classpath.

Explain how to use @CsvFileSource to run a parameterized test with data from an external CSV file.

Think about how JUnit reads CSV files and passes data to test methods.

Describe common errors when using @CsvFileSource and how to fix them.

Consider file location and data format issues.

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