TestWatcher for reporting in JUnit - Framework Patterns

Framework Mode - TestWatcher for reporting

Folder Structure

src/
└── test/
    └── java/
        └── com/
            └── example/
                ├── tests/
                │   └── LoginTest.java
                ├── watchers/
                │   └── CustomTestWatcher.java
                ├── pages/
                │   └── LoginPage.java
                └── utils/
                    └── TestUtils.java

Test Framework Layers

• Test Classes: Contain test methods using JUnit annotations (@Test). Example: LoginTest.java.
• TestWatcher Layer: Custom classes extending TestWatcher to listen to test events (success, failure, skipped) and perform reporting actions. Example: CustomTestWatcher.java.
• Page Objects: Represent UI pages with methods to interact with elements. Example: LoginPage.java.
• Utilities: Helper classes for common functions like screenshots, logging, or data handling. Example: TestUtils.java.
• Configuration: External files or classes managing environment settings, credentials, and browser options.

Configuration Patterns

• Properties File: Use config.properties to store environment URLs, browser types, and credentials.
• System Properties: Override config values via command line for flexibility (e.g., -Dbrowser=chrome).
• TestWatcher Setup: Initialize reporting tools and screenshot paths in the watcher constructor or setup methods.
• Environment Profiles: Separate config files or sections for dev, test, and prod environments to switch easily.

Test Reporting and CI/CD Integration

• JUnit Reports: Use built-in JUnit XML reports for basic pass/fail results.
• Custom Reporting: Extend TestWatcher to capture screenshots on failure and log detailed messages.
• CI/CD Integration: Configure Jenkins, GitHub Actions, or other pipelines to run tests and publish reports automatically.
• Report Storage: Save screenshots and logs in a structured folder for easy access after test runs.

Best Practices

1. Single Responsibility: Keep TestWatcher focused on reporting and logging, not test logic.
2. Reusable Watchers: Create generic watchers that can be reused across multiple test classes.
3. Clear Naming: Name watcher classes clearly to reflect their purpose, e.g., CustomTestWatcher or ScreenshotOnFailureWatcher.
4. Fail Fast Reporting: Capture failure details immediately to help quick debugging.
5. Integrate with Logs: Combine watcher reports with logging frameworks for comprehensive test insights.

Self Check

Where in this folder structure would you add a new TestWatcher class that captures screenshots on test failure?

Key Result

Use JUnit's TestWatcher to listen to test events and enhance reporting with screenshots and logs.