Retry analyzer for failures in Selenium Java - Framework Patterns

Framework Mode - Retry analyzer for failures

Folder Structure

src/
└── test/
    └── java/
        ├── com/
        │   └── example/
        │       ├── pages/          # Page Object classes
        │       │   └── LoginPage.java
        │       ├── tests/          # Test classes
        │       │   └── LoginTest.java
        │       ├── utils/          # Utility classes (e.g., RetryAnalyzer)
        │       │   └── RetryAnalyzer.java
        │       └── config/         # Configuration classes
        │           └── TestConfig.java

Test Framework Layers

• Driver Layer: Manages WebDriver setup and teardown for browser control.
• Page Objects: Encapsulate web page elements and actions (e.g., LoginPage.java).
• Tests: Test classes using TestNG with annotations and assertions (e.g., LoginTest.java).
• Utilities: Helper classes like RetryAnalyzer to retry failed tests automatically.
• Configuration: Holds environment settings, browser types, credentials (e.g., TestConfig.java).

Configuration Patterns

• Environment Properties: Use config.properties or Java classes to store URLs, credentials.
• Browser Selection: Pass browser type as a parameter or system property to run tests on different browsers.
• Retry Analyzer Setup: Configure retry logic in TestNG XML or via annotation @Test(retryAnalyzer = RetryAnalyzer.class).
• Credentials Management: Store sensitive data securely, e.g., environment variables or encrypted files.

Test Reporting and CI/CD Integration

• Use TestNG default reports or integrate with advanced reporters like Allure for detailed test results.
• Reports show retry attempts and final pass/fail status for flaky tests.
• Integrate with CI/CD tools (Jenkins, GitHub Actions) to run tests automatically on code changes.
• Configure build pipelines to fail only if tests fail after retries.

Best Practices for Retry Analyzer Framework

1. Limit Retry Attempts: Avoid infinite retries; set a max retry count (e.g., 2-3) to prevent long test runs.
2. Retry Only on Failures: Retry tests only when failures are due to flaky issues, not assertion failures.
3. Keep Retry Logic Separate: Implement retry logic in a dedicated utility class to keep tests clean.
4. Log Retry Attempts: Provide clear logs when retries happen to help debugging.
5. Use Annotations: Apply retry analyzer via TestNG annotations for easy maintenance.

Self Check

Where in this folder structure would you add a new retry analyzer class to handle test retries?

Key Result

Use a dedicated RetryAnalyzer class in the utils layer to automatically retry failed Selenium tests with TestNG.