Wopee.io Visual Testing for Robot Framework

wopee_rf adds visual testing to your Robot Framework tests. Your test takes a screenshot at the steps you choose, Wopee.io compares it with the approved baseline, and you review the differences in Commander.

The full guide is at docs.wopee.io/robot-framework.

Install

Python 3.11 or newer:

pip install wopee_rf robotframework robotframework-browser
rfbrowser init chromium

For SeleniumLibrary, install robotframework-seleniumlibrary instead of robotframework-browser.

Configure

Create a .env file next to your tests folder. Copy the URL, project UUID and API key from More › Settings › API Keys in Commander:

WOPEE_API_URL=https://api.wopee.io
WOPEE_PROJECT_UUID=your-project-uuid
WOPEE_API_KEY=your-api-key
WOPEE_SCREENSHOT_VALIDATION_ENABLED=true
WOPEE_DRIVER_LIBRARY=BrowserLibrary

Both last lines are required: without them nothing is sent to Wopee.io. Use WOPEE_DRIVER_LIBRARY=SeleniumLibrary for Selenium tests.

Write a test

tests/saucedemo.robot:

*** Settings ***
Library     Browser
Library     wopee_rf.Standalone    dot_env_path=.env

Test Setup       New Page    https://www.saucedemo.com
Test Teardown    Stop Scenario

*** Variables ***
${USER}     standard_user
${SUITE}    Robot Framework demo ${{datetime.datetime.now().strftime('%Y-%m-%d %H:%M')}}

*** Test Cases ***
Login And Products
    Start Suite       suite_name=${SUITE}
    Start Scenario    scenario_name=Robot Framework: login and products
    ${login}=    Track Fullpage    step_name=Login page
    Fill Text    id=user-name    ${USER}
    Fill Text    id=password     secret_sauce
    Click        id=login-button
    Wait For Elements State    css=.inventory_list    visible
    ${products}=    Track Fullpage    step_name=Products
    Log To Console    \nLogin page: ${login.status} | Products: ${products.status}

Run it from the folder that holds .env:

robot -d reports tests/

The first run creates the baselines (status new). Approve them in Runs in Commander; later runs report ok or unresolved.

All keywords take named arguments only: step_name=Login page, not Login page.

Keywords and listener

To add visual testing to existing tests without changing them, run them with the listener wopee_rf.Listener and list the keywords to screenshot after in WOPEE_TRACKED_KEYWORDS:

WOPEE_TRACKED_KEYWORDS="Browser.New Page;Browser.Click" \
  robot -d reports --listener 'wopee_rf.Listener:dot_env_path=.env' tests/existing_test.robot

Documentation

• Getting started: the complete example, step by step
• Configuration and listener: all settings, the listener, SeleniumLibrary, branches, CI and troubleshooting
• Template project: start from a ready repository
• Examples: more tracking parameters, viewport screenshots, mobile apps and PDF documents