robotframework-browser
Advanced tools
Robot Framework Browser library powered by Playwright. Aiming for speed, reliability and visibility.
Robot Framework Browser library powered by Playwright. Propelling browser automation into the future!
Aiming for :rocket: speed, :white_check_mark: reliability and :microscope: visibility.
See keyword documentation and web page for more details.
For both installation options only Python 3.10 or newer is supported. There are two main ways to install Browser library, with or without user having NodeJS installed.
The easiest way to install the Browser library is to use the robotframework-browser-batteries package (BrowserBatteries). BrowserBatteries contains precompiled NodeJS binaries and NodeJS dependencies, so that users do not need to install NodeJS or its Node-side dependencies by them self.
Limitations:
See Installation without NodeJS for more details.
If BrowserBatteries package is not suitable for you, for some reason, then you need to install NodeJS, install robotframework-browser and install NodeJS dependencies. See more detail in Installation with NodeJS chapter
pip install -U pip to ensure latest version is usedpip install robotframework-browser[bb]rfbrowser installrfbrowser is not found, try python -m Browser.entry installFrom Node side 20, 22 and 24 LTS versions are supported.
pip install -U pip to ensure latest version is usedpip install robotframework-browserrfbrowser init in your shellrfbrowser is not found, try python -m Browser.entry initPlease note that by default Chromium, Firefox and WebKit browser are installed, even those would be already
installed in the system. The installation size depends on the operating system, but usually is +700Mb.
It is possible to skip browser binaries installation with rfbrowser install-browser --skip-browsers
or rfbrowser init --skip-browsers command, but then user is responsible for Playwright browser binary
installation. It is possible to install only selected browser binaries by adding
chromium, firefox or webkit as arguments to init command. Example rfbrowser init firefox would install
only Firefox binaries and rfbrowser install-browser firefox chromium would install both Firefox and
Chromium binaries.
Or use the docker images . Documented at docker/README.md.
Starting from release 19.11.0 Browser library has optional dependency with
Robocop. Install library with Robocop, run install with:
pip install robotframework-browser[robocop]. Starting from 18.3.0 release, library will provide external
Robocop transformer. Transformer provided
by Browser library can be run with command: rfbrowser transform --transformer-name /path/to/tests. Example:
rfbrowser transform --wait-until-network-is-idle /path/to/tests would transform deprecated Wait Until Network Is Idle
keyword to Wait For Load State keyword. To see full list of transformers provided by Browser library, run
command: rfbrowser transform --help.
To upgrade your already installed robotframework-browser and robotframework-browser-batteries follow steps in below. Please note that robotframework-browser and robotframework-browser-batteries packages are tied together and having different versions of these packages is not supported.
pip install -U robotframework-browser robotframework-browser-batteriesrfbrowser clean-noderfbrowser installTo upgrade your already installed robotframework-browser library
pip install -U robotframework-browserrfbrowser clean-noderfbrowser initTo completely uninstall library, including the browser binaries installed by Playwright, run following commands:
rfbrowser clean-nodepip uninstall robotframework-browserpip uninstall robotframework-browser-batteries*** Settings ***
Library Browser
*** Test Cases ***
Example Test
New Page https://playwright.dev
Get Text h1 contains Playwright
import Browser
browser = Browser.Browser()
browser.new_page("https://playwright.dev")
assert 'Playwright' in browser.get_text("h1")
browser.close_browser()
async function myGoToKeyword(url, page, logger) {
logger("Going to " + url)
return await page.goto(url);
}
myGoToKeyword.rfdoc = "This is my own go to keyword";
exports.__esModule = true;
exports.myGoToKeyword = myGoToKeyword;
*** Settings ***
Library Browser jsextension=${CURDIR}/mymodule.js
*** Test Cases ***
Example Test
New Page
myGoToKeyword https://www.robotframework.org
See example. Ready made extensions and a place to share your own at robotframework-browser-extensions.
text, css and xpath selectors# Select element containing text "Login" with text selector strategy
# and select it's parent `input` element with xpath
Click "Login" >> xpath=../input
# Select element with CSS strategy and select button in it with text strategy
Click div.dialog >> "Ok"
New Page ${LOGIN_URL}
${ref}= Get Element h1
Get Property ${ref} innerText == Login Page
Evaluate JavaScript ${ref} (elem) => elem.innerText = "abc"
Get Property ${ref} innerText == abc
# The button with id `delayed_request` fires a delayed request. We use a promise to capture it.
${promise}= Promise To Wait For Response matcher= timeout=3s
Click \#delayed_request
${body}= Wait For ${promise}
${device}= Get Device iPhone X
New Context &{device}
New Page
Get Viewport Size # returns { "width": 375, "height": 812 }
${response}= HTTP /api/post POST {"name": "John"}
Should Be Equal ${response.status} ${200}
You can let RF Browser spawn separate processes for every pabot process. This is very simple, just run the tests normally using pabot (see https://github.com/mkorpela/pabot#basic-use ). However if you have small tests do not use --testlevelsplit, it will cause lots of overhead because tests cannot share the browsers in any case.
You can share the node side RF Browser processes by using the ROBOT_FRAMEWORK_BROWSER_NODE_PORT environment variable, and from Browser.utils import spawn_node_process helper (see the docs for the helper ). This saves some overhead based on how many splits of tests you are running. Clean up the process afterwards.
Save Storage State should work. See usage example: https://marketsquare.github.io/robotframework-browser/Browser.html#Save%20Storage%20StateSee CONTRIBUTING.md for development instructions.
In order of appearance.
This project is community driven and becomes a reality only through the work of all the people who contribute. Supported by Robocorp through Robot Framework Foundation.
FAQs
Robot Framework Browser library powered by Playwright. Aiming for speed, reliability and visibility.
We found that robotframework-browser demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.ย It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Fake โPhantom Shuttleโ VPN Chrome extensions (active since 2017) hijack proxy auth to intercept traffic and continuously exfiltrate user credentials to attacker infrastructure.
Security News
/Product
Socket Firewall Free is now bundled into Docker Hardened Images, adding build-time and dependency-install supply chain protection on top of hardened base images for Node.js, Python, and Rust.
Security News
Seasonโs greetings from Socket, and hereโs to a calm end of year: clean dependencies, boring pipelines, no surprises.
