@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.