Skip to main content

AI-powered smart locator with retry functionality for Robot Framework using OpenAI

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Robot Framework DomRetryLibrary

A Robot Framework library with AI-powered fallback for locator variables, enhancing test reliability by using OpenAI to dynamically generate element locators when primary locators fail.

Installation

Install the library using pip:

pip install robotframework-domretrylibrary

Usage

Import the library in your Robot Framework test file:

*** Settings ***
Library           SeleniumLibrary
Library           DomRetryLibrary

Define your locators and AI fallback descriptions:

*** Variables ***
${USERNAME_FIELD}      css=#username_id
${AI_USERNAME_FIELD}   the username input field

Use the AI fallback in your tests (either with variable name or resolved variable):

*** Test Cases ***
Login Test
    Open Browser    https://example.com    chrome
    # Both syntaxes work in version 3.1.0+
    AI Fallback Locator    Input Text    USERNAME_FIELD    myusername
    # OR directly use the resolved variable
    AI Fallback Locator    Input Text    ${USERNAME_FIELD}    myusername
    Close Browser

You can also use custom keywords with fallback:

*** Keywords ***
Wait And Input Text
    [Arguments]    ${locator}    ${text}    ${timeout}=10
    [Documentation]    Input text with AI fallback if the primary locator fails
    ${status}    ${error}=    Run Keyword And Ignore Error    Input Text    ${locator}    ${text}
    Run Keyword If    '${status}' == 'FAIL'    AI Fallback Locator    Input Text    ${locator}    ${text}

API Key Setup

Store your OpenAI API key in a .env file or provide it when initializing the library:

*** Settings ***
Library    DomRetryLibrary    api_key=${OPENAI_API_KEY}

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

robotframework_domretrylibrary-3.1.0.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

robotframework_domretrylibrary-3.1.0-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file robotframework_domretrylibrary-3.1.0.tar.gz.

File metadata

File hashes

Hashes for robotframework_domretrylibrary-3.1.0.tar.gz
Algorithm Hash digest
SHA256 8330b145778a35d3974ae9f53b69dbf06805242df1f455fd6426511ebdbd8fa8
MD5 b299633a9f1c29756dad546aecbc3258
BLAKE2b-256 b4ff158908751142af1572f7151ae160209513583b84c9f0930de36a2c1d4189

See more details on using hashes here.

File details

Details for the file robotframework_domretrylibrary-3.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for robotframework_domretrylibrary-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 47107119451a609dc6f56bcb27ecd0329b7490addabab1f7d2364678c391c0ec
MD5 4f2d257497256c3fc58adf7603ce4eb8
BLAKE2b-256 c4fa14a4b25d8d6d494d4872d071f676d8e5b4614299d02e18b1b4f5c2a38184

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page