Custom conditions with @EnabledIf in JUnit - Framework Patterns

Framework Mode - Custom conditions with @EnabledIf

Folder Structure

project-root/
├── src/
│   ├── main/
│   │   └── java/
│   │       └── com/example/app/
│   │           └── Application.java
│   └── test/
│       └── java/
│           └── com/example/app/
│               ├── tests/
│               │   └── FeatureTests.java
│               ├── conditions/
│               │   └── CustomCondition.java
│               └── utils/
│                   └── TestUtils.java
├── build.gradle
└── settings.gradle
  

Test Framework Layers

• Test Classes: Contain test methods annotated with @Test and conditional annotations like @EnabledIf.
• Custom Condition Classes: Implement logic for enabling/disabling tests dynamically, e.g., CustomCondition with a static method returning boolean.
• Utilities: Helper methods for common tasks like reading environment variables or configuration.
• Configuration: External files or environment variables to control test behavior (e.g., which environment or feature flags).

Configuration Patterns

Use environment variables or system properties to control test execution conditions.

• Define environment variables like TEST_ENV or FEATURE_ENABLED.
• Access these variables in custom condition methods to decide if a test should run.
• Use System.getProperty() or System.getenv() in Java for flexible configuration.

Example: Enable a test only if FEATURE_ENABLED is true.

Test Reporting and CI/CD Integration

• JUnit reports show skipped tests when @EnabledIf conditions are false.
• CI/CD pipelines can set environment variables to control which tests run.
• Use build tools like Gradle or Maven to run tests with different profiles.
• Reports help identify which tests were skipped due to conditions.

Best Practices

1. Keep custom condition methods simple and fast to avoid slowing down test runs.
2. Use meaningful names for condition methods to clearly express when tests run.
3. Centralize condition logic in one place to avoid duplication.
4. Document environment variables or system properties that affect test enabling.
5. Combine @EnabledIf with other JUnit annotations for flexible test control.

Self Check

Where in this folder structure would you add a new custom condition class to enable tests based on a new feature flag?

Key Result

Use @EnabledIf with centralized custom condition classes to control test execution dynamically based on environment or feature flags.