BeforeEachCallback and AfterEachCallback in JUnit - Framework Patterns

Framework Mode - BeforeEachCallback and AfterEachCallback

Folder Structure

src
└── test
    └── java
        └── com
            └── example
                ├── tests
                │   └── ExampleTest.java
                ├── extensions
                │   └── CustomBeforeAfterExtension.java
                └── utils
                    └── TestUtils.java

Test Framework Layers

• Test Classes: Contain test methods annotated with @Test. Use JUnit 5 lifecycle annotations and extensions.
• Extension Layer: Implements BeforeEachCallback and AfterEachCallback interfaces to run code before and after each test method.
• Utilities: Helper classes for common test operations, data setup, or cleanup.
• Configuration: Handles environment setup, test parameters, and extension registration.

Configuration Patterns

• Register Extensions: Use @ExtendWith(CustomBeforeAfterExtension.class) on test classes or methods to apply callbacks.
• Environment Setup: Use system properties or config files to manage test environments.
• Parameter Injection: Use JUnit 5's parameter resolution to inject dependencies if needed.
• Credentials & Secrets: Store securely outside code, load during setup callbacks.

Test Reporting and CI/CD Integration

• JUnit 5 generates XML reports compatible with CI tools like Jenkins, GitHub Actions, or GitLab CI.
• Use build tools (Maven/Gradle) to run tests and publish reports automatically.
• Custom extensions can log additional info during BeforeEachCallback and AfterEachCallback for enhanced reporting.
• Integrate with code coverage tools (JaCoCo) to measure test completeness.

Best Practices

1. Use Extensions for Reusable Setup/Cleanup: Implement BeforeEachCallback and AfterEachCallback in extensions to avoid repeating code in tests.
2. Keep Tests Independent: Setup and cleanup in callbacks ensure each test runs in a clean state.
3. Register Extensions Properly: Use @ExtendWith annotation or register programmatically for consistent behavior.
4. Log Actions in Callbacks: Helps debugging test failures by tracing setup and teardown steps.
5. Handle Exceptions Gracefully: Ensure cleanup runs even if setup or test fails to avoid side effects.

Self Check

Where in this folder structure would you add a new extension that logs a message before and after each test method?

Key Result

Use JUnit 5 extensions implementing BeforeEachCallback and AfterEachCallback to manage reusable setup and cleanup logic for each test method.