Robot Framework SeleniumTestability

2.1.0 · active · verified Wed Apr 15

Robot Framework SeleniumTestability is a library that enhances Robot Framework's SeleniumLibrary by providing additional keywords to handle asynchronous events and improve test stability for modern web applications. It helps in waiting for page readiness, Angular, jQuery, and network idle states. The current version is 2.1.0, with releases often coinciding with major SeleniumLibrary or Selenium updates.

Warnings

breaking Version 2.0.0 introduced a breaking change requiring Selenium 4 (or greater) due to updates in Robot Framework SeleniumLibrary. If you are using an older SeleniumLibrary or Selenium 3, you must either upgrade your Selenium stack or use an older version of robotframework-seleniumtestability (<2.0.0).
Fix: Upgrade your 'selenium' package to version 4+ and 'robotframework-seleniumlibrary' to a compatible version (e.g., 5.0+), or pin 'robotframework-seleniumtestability' to an earlier version like `robotframework-seleniumtestability<2.0.0`.
gotcha This library complements, but does not fully replace, the need for robust SeleniumLibrary waits. While it provides general asynchronous waits, complex or custom asynchronous operations might still require explicit 'Wait Until Element Is Visible' or 'Wait Until Element Contains' from SeleniumLibrary.
Fix: Combine SeleniumTestability's broad waits (e.g., 'Wait For Page Ready') with specific SeleniumLibrary waits for unique application behaviors (e.g., 'Wait Until Element Is Enabled' or custom `Wait Until Keyword Succeeds`).
gotcha Ensure SeleniumLibrary is imported and configured correctly *before* SeleniumTestability in your Robot Framework settings. SeleniumTestability relies on the browser context established by SeleniumLibrary.
Fix: Always include `Library SeleniumLibrary` with its necessary arguments (like `timeout`) before `Library SeleniumTestability` in your Robot Framework settings files (`.robot`). Ensure SeleniumLibrary is properly installed and its browser initialization keywords are used.

Install

pip install robotframework-seleniumtestability Install latest version

Imports

SeleniumTestability
```
Library    SeleniumTestability
```
This library is loaded within Robot Framework test suites using the 'Library' keyword in .robot files, not via standard Python 'import' statements. The `Library` keyword makes the keywords available in the test suite.

Quickstart

This quickstart demonstrates how to include SeleniumTestability in your Robot Framework project and use its core 'Wait For Page Ready' keyword to ensure the page is fully loaded, including common asynchronous operations, before proceeding with test steps. Ensure `SeleniumLibrary` is also imported and configured.

*** Settings ***
Library    SeleniumLibrary    timeout=10s
Library    SeleniumTestability

*** Test Cases ***
Example Test With Async Waits
    Open Browser    https://example.com    chrome
    Wait For Page Ready
    Title Should Be    Example Domain
    # Example: If your application uses jQuery, Angular, or waits for network idle
    # Wait For JQuery Ready
    # Wait For Angular Ready
    # Wait Until Network Idle
    Close Browser

view raw JSON →