Handling StaleElementReferenceException in Selenium Java - Framework Patterns

Framework Mode - Handling StaleElementReferenceException

Folder Structure

src/
└── test/
    └── java/
        └── com/
            └── example/
                ├── pages/
                │   └── LoginPage.java
                ├── tests/
                │   └── LoginTest.java
                ├── utils/
                │   └── WaitUtils.java
                └── config/
                    └── TestConfig.java

Test Framework Layers

• Driver Layer: Manages WebDriver setup and teardown (e.g., WebDriverFactory class).
• Page Objects: Classes representing web pages with locators and methods (e.g., LoginPage.java).
• Tests: Test classes using TestNG or JUnit to run test cases (e.g., LoginTest.java).
• Utilities: Helper classes for common tasks like explicit waits and retry logic (e.g., WaitUtils.java).
• Configuration: Holds environment settings, browser types, and credentials (e.g., TestConfig.java).

Configuration Patterns

• Environment Properties: Use property files or environment variables to switch between dev, test, and prod.
• Browser Selection: Pass browser type as a parameter or config to run tests on different browsers.
• Credentials Management: Store sensitive data securely outside code, load at runtime.
• Timeouts and Waits: Centralize wait durations in config for easy tuning.

Test Reporting and CI/CD Integration

• Use TestNG or JUnit reports for test results summary.
• Integrate with Allure or ExtentReports for detailed, user-friendly reports.
• Configure CI/CD pipelines (Jenkins, GitHub Actions) to run tests on code push.
• Fail builds on test failures to ensure quality gates.

Best Practices for Handling StaleElementReferenceException

• Use Explicit Waits: Wait for elements to be present and visible before interacting.
• Retry Locating Elements: Wrap element access in retry logic to recover from stale references.
• Minimize Page Changes: Avoid storing WebElement references across page reloads or DOM updates.
• Use Page Object Methods: Always locate elements fresh inside page methods rather than storing them as fields.
• Centralize Wait Utilities: Create reusable wait methods to handle stale elements gracefully.

Self Check

Where in this folder structure would you add a utility method to retry finding an element after catching a StaleElementReferenceException?

Key Result

Use page objects with fresh element lookups and retry logic in utility methods to handle stale element exceptions.