OKW Web Selenium

Selenium WebDriver plugin for OKW4Robot — the driver-agnostic keyword library for Robot Framework.

This package provides WebSe_* widget implementations that translate OKW keywords (SetValue, ClickOn, VerifyValue, ...) into Selenium WebDriver calls for Chrome, Firefox, Edge and other browsers.

Deutsche Version: README_de.md

Installation

pip install robotframework-okw-web-selenium

This automatically installs robotframework-okw4robot (core) and robotframework-seleniumlibrary as dependencies.

Quick Start

*** Settings ***
Library    okw_web_selenium.library.OkwWebSeleniumLibrary

*** Test Cases ***
Login Test
    StartApp      MyApp
    SelectWindow  LoginDialog
    SetValue      Username         admin
    SetValue      Password         secret
    ClickOn       Login
    VerifyValue   Status           Logged in

StartApp loads the app YAML (locators/MyApp.yaml). If the YAML contains a __self__ section with the adapter class and browser parameter, the browser is opened automatically — no separate StartHost needed.

All keywords come from the core (okw4robot). This package only provides the Selenium-specific widget implementations — you never import individual keyword modules.

How It Works

OKW4Robot keyword              This package (WebSe_*)
─────────────────              ──────────────────────
SetValue "Name" "Smith"   →   WebSe_TextField.okw_set_value("Smith")
                               └→ Selenium: clear + input_text

ClickOn "Login"           →   WebSe_Button.okw_click()
                               └→ Selenium: click_element

VerifyValue "Status" "OK" →   WebSe_Label.okw_get_value()
                               └→ Selenium: get_text → polling loop

The YAML locator file determines which WebSe_* class is used for each GUI object:

# locators/MyApp.yaml
MyApp:
  LoginDialog:
    Username:
      class: okw_web_selenium.widgets.webse_textfield.WebSe_TextField
      locator: { id: user_input }
    Password:
      class: okw_web_selenium.widgets.webse_textfield.WebSe_TextField
      locator: { id: password_input }
    Login:
      class: okw_web_selenium.widgets.webse_button.WebSe_Button
      locator: { css: "button[type=submit]" }

Widget Classes

All widget classes inherit click, move_over, get_tooltip, get_label, get_attribute, get_placeholder from WebSe_Base. | BrowserControl | Browser host | start, stop, select_window | | UrlBar | Address bar | set_value (navigate to URL) |

Full reference: docs/widgets_common.md

Web-Only Keywords

These keywords are available only with OkwWebSeleniumLibrary (not in the core OKW4RobotLibrary):

RemoveAds

Removes ad elements from the current page. Without arguments, targets common Google Ads selectors. With arguments, each argument is a CSS selector for elements to remove.

A MutationObserver is installed to automatically remove ads that load asynchronously after the initial page load. One call per page is enough.

# Default (Google Ads):
OnFailIgnoreNOISE    RemoveAds

# Custom selectors:
OnFailIgnoreNOISE    RemoveAds    div.custom-banner    iframe[src*="ad-network"]

Best used with OnFailIgnoreNOISE in test setup — if the page has no ads, the keyword simply removes nothing and continues.

Documentation

• docs/README.md – Documentation overview
• docs/widgets_common.md – WebSe_* class reference
• docs/Web_Widget_Matrix.md – HTML element → widget mapping
• docs/radiolist.md – RadioList locator strategies
• docs/docs_host_app_config.md – Host/App YAML configuration
• docs/executejs-snippets.md – JavaScript snippets for ExecuteJS

For core documentation (keywords, contracts, timeouts, sync strategy) see robotframework-okw4robot.

Project Structure

robotframework-okw-web-selenium/
  src/okw_web_selenium/
    library.py              # OkwWebSeleniumLibrary (extends OKW4RobotLibrary)
    adapter.py              # SeleniumAdapter (browser lifecycle)
    widgets/
      webse_base.py         # WebSe_Base (shared Selenium logic)
      webse_textfield.py    # WebSe_TextField
      webse_button.py       # WebSe_Button
      webse_checkbox.py     # WebSe_CheckBox
      webse_combobox.py     # WebSe_ComboBox
      webse_listbox.py      # WebSe_ListBox
      webse_radiolist.py    # WebSe_RadioList
      webse_label.py        # WebSe_Label
      webse_link.py         # WebSe_Link
      webse_table.py        # WebSe_Table
      webse_multilinefield.py
      host/
        browsercontrol/     # BrowserControl + UrlBar
    locators/               # Built-in YAML locators (Chrome, WidgetsDemo, ...)
  tests/
    robot/                  # 53 Robot Framework integration tests
  docs/

License

• Community (non-commercial): see LICENSE
• Commercial: see COMMERCIAL_LICENSE.md
• FAQ: docs/license_faq.md