Custom argument providers in JUnit - Framework Patterns

Framework Mode - Custom argument providers

Folder Structure

src
└── test
    └── java
        └── com
            └── example
                ├── arguments
                │   └── CustomArgumentProvider.java
                ├── tests
                │   └── ParameterizedTestExample.java
                └── utils
                    └── TestUtils.java

Test Framework Layers

• Custom Argument Providers Layer: Classes implementing org.junit.jupiter.params.provider.ArgumentsProvider to supply test data dynamically.
• Test Layer: Parameterized test classes using @ParameterizedTest and @ArgumentsSource annotations to consume custom arguments.
• Utility Layer: Helper classes for data preparation or common test utilities.
• Configuration Layer: Handles environment setup, test properties, and test execution parameters.

Configuration Patterns

• Test Properties File: Use src/test/resources/test.properties to store environment variables or flags controlling test data sources.
• System Properties or Environment Variables: Control which argument provider to use or toggle data sources dynamically.
• JUnit Platform Configuration: Use junit-platform.properties for global test settings.
• Dependency Injection: Use constructor or method injection in argument providers if needed for complex data setup.

Test Reporting and CI/CD Integration

• JUnit Reports: Use built-in JUnit XML reports generated by Maven or Gradle for CI systems.
• Enhanced Reporting: Integrate with tools like Allure or ReportPortal for detailed parameterized test reports showing input data.
• CI/CD Pipelines: Configure pipelines (GitHub Actions, Jenkins, GitLab CI) to run parameterized tests and publish reports automatically.
• Fail Fast Option: Configure test runs to stop on first failure or continue to gather full test results.

Best Practices for Custom Argument Providers

1. Keep Argument Providers Focused: Each provider should supply data for a specific test scenario or domain area.
2. Use Streams for Efficiency: Return Stream<Arguments> to support lazy evaluation and large data sets.
3. Separate Data from Logic: Avoid embedding complex logic in argument providers; use utility classes if needed.
4. Readable Test Data: Provide descriptive argument names or use @DisplayName to clarify test cases.
5. Reuse Providers: Share argument providers across multiple tests when data sets overlap.

Self Check

Where in this folder structure would you add a new argument provider for testing user login scenarios?

Key Result

Organize custom argument providers in a dedicated package to supply dynamic test data for parameterized JUnit tests.