https://github.com/marketsquare/robotframework-browser

Robot Framework Browser library powered by Playwright.
https://github.com/marketsquare/robotframework-browser
playwright robotframework testing
Last synced: about 1 month ago
JSON representation
Robot Framework Browser library powered by Playwright.
Host: GitHub
URL: https://github.com/marketsquare/robotframework-browser
Owner: MarketSquare
License: apache-2.0
Created: 2020-06-01T20:49:22.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2025-05-12T00:54:13.000Z (9 months ago)
Last Synced: 2025-05-12T03:15:15.639Z (9 months ago)
Topics: playwright, robotframework, testing
Language: Python
Homepage:
Size: 15 MB
Stars: 571
Watchers: 19
Forks: 119
Open Issues: 35
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

          # robotframework-browser

[![All Contributors](https://img.shields.io/badge/all_contributors-195-orange.svg?style=flat-square)](#contributors-)

[![Version](https://img.shields.io/pypi/v/robotframework-browser.svg)](https://pypi.python.org/pypi/robotframework-browser)

[![Actions Status](https://github.com/MarketSquare/robotframework-browser/workflows/Continuous%20integration/badge.svg)](https://github.com/MarketSquare/robotframework-browser/actions)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

----

[Robot Framework](https://robotframework.org) Browser library powered by

[Playwright](https://playwright.dev/). Propelling browser automation into the future!

Aiming for :rocket: speed, :white_check_mark: reliability and :microscope: visibility.

See [keyword documentation](https://marketsquare.github.io/robotframework-browser/Browser.html) and

[web page](https://robotframework-browser.org/) for more details.

# Installation instructions

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](https://pypi.org/project/robotframework-browser-batteries/)

package (BrowserBatteries). BrowserBatteries contains precompiled NodeJS binaries and

NodeJS [dependencies](./package.json), so that users do not need to install NodeJS or its

Node-side dependencies by them self.

Limitations:

- BrowserBatteries may not be available for every operating system or processor architecture.

- If you develop plugins that require third-party NodeJS modules, those modules are not

  compiled into the BrowserBatteries package.

See [Installation without NodeJS](#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](https://pypi.org/project/robotframework-browser/)

and install NodeJS dependencies. See more detail in

[Installation with NodeJS](#nstallation-with-NodeJS) chapter

## Installation without NodeJS

1. Update pip `pip install -U pip` to ensure latest version is used

2. Install robotframework-browser and robotframework-browser-batteries from the commandline:

`pip install robotframework-browser[bb]`

3. Install the Playwright browser binaries, run: `rfbrowser install`

  - if `rfbrowser` is not found, try `python -m Browser.entry install`

## Installation with NodeJS

From Node side 20, 22 and 24 LTS versions are supported.

1. Install NodeJS e.g. from https://nodejs.org/en/download/

2. Update pip `pip install -U pip` to ensure latest version is used

3. Install robotframework-browser from the commandline: `pip install robotframework-browser`

4. Install the node dependencies: run `rfbrowser init` in your shell

  - if `rfbrowser` is not found, try `python -m Browser.entry init`

Please 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](https://github.com/MarketSquare/robotframework-browser/pkgs/container/robotframework-browser%2Frfbrowser-stable)

. Documented at

[docker/README.md](https://github.com/MarketSquare/robotframework-browser/blob/main/docker/README.md).

## Install with transformer

Starting from release 19.11.0 Browser library has optional dependency with

[Robocop](https://github.com/MarketSquare/robotframework-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](https://robocop.dev/stable/formatter/custom_formatters/). 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`.

## Update instructions without NodeJS

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.

1. Update from commandline: `pip install -U robotframework-browser robotframework-browser-batteries`

2. Clean old node side dependencies and browser binaries: `rfbrowser clean-node`

3. Install the node dependencies for the newly installed version: `rfbrowser install`

## Update instructions with NodeJS

To upgrade your already installed robotframework-browser library

1. Update from commandline: `pip install -U robotframework-browser`

2. Clean old node side dependencies and browser binaries: `rfbrowser clean-node`

3. Install the node dependencies for the newly installed version: `rfbrowser init`

## Uninstall instructions

To completely uninstall library, including the browser binaries installed by Playwright,

run following commands:

1. Clean old node side dependencies and browser binaries: `rfbrowser clean-node`

2. Uninstall with pip: `pip uninstall robotframework-browser`

3. If you have BrowserBatteries installed, also run: `pip uninstall robotframework-browser-batteries`

# Examples

### Testing with [Robot Framework](https://robotframework.org)

```RobotFramework

*** Settings ***

Library   Browser

*** Test Cases ***

Example Test

    New Page    https://playwright.dev

    Get Text    h1    contains    Playwright

```

### and testing with [Python](https://python.org).

```python

import Browser

browser = Browser.Browser()

browser.new_page("https://playwright.dev")

assert 'Playwright' in browser.get_text("h1")

browser.close_browser()

```

### and extending with JavaScript

```JavaScript

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;

```

```RobotFramework

*** Settings ***

Library   Browser  jsextension=${CURDIR}/mymodule.js

*** Test Cases ***

Example Test

   New Page

   myGoToKeyword   https://www.robotframework.org

```

See [example](https://github.com/MarketSquare/robotframework-browser/tree/main/docs/examples/babelES2015).

Ready made extensions and a place to share your own at [robotframework-browser-extensions](https://github.com/MarketSquare/robotframework-browser-extensions).

### Ergonomic selector syntax, supports chaining of `text`, `css`  and `xpath` selectors

```RobotFramework

# 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"

```

### Evaluate in browser page

```RobotFramework

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

```

### Asynchronously waiting for HTTP requests and responses

```RobotFramework

# 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 Descriptors

```RobotFramework

${device}=  Get Device  iPhone X

New Context  &{device}

New Page

Get Viewport Size  # returns { "width": 375, "height": 812 }

```

### Sending HTTP requests and parsing their responses

```RobotFramework

${response}=    HTTP    /api/post    POST    {"name": "John"}

Should Be Equal    ${response.status}    ${200}

```

### Parallel test execution using Pabot

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](https://github.com/MarketSquare/robotframework-browser/blob/a7d3e59a1e8e3e75f64b9146a088385445a5af30/Browser/utils/misc.py#L35) ). This saves some overhead based on how many splits of tests you are running. Clean up the process afterwards.

### Re-using authentication credentials

- Figure out how the page is storing authentication

- If it is localstorage or cookies `Save Storage State` should work. See usage example: https://marketsquare.github.io/robotframework-browser/Browser.html#Save%20Storage%20State

# Development

See [CONTRIBUTING.md](CONTRIBUTING.md) for development instructions.

## Core team

In order of appearance.

  * Mikko Korpela

  * Tatu Aalto

  * Janne Härkönen (Alumnus)

  * Kerkko Pelttari

  * René Rohner

## Contributors

This project is community driven and becomes a reality only through the work of all the people who contribute.

Supported by [Robocorp](https://robocorp.com/) through [Robot Framework Foundation](https://robotframework.org/foundation/).

  

    

      
_{Mikko Korpela}
💻

      
_{Tatu Aalto}
💻

      
_{Antti Karjalainen}
🔍

      
_{Ismo Aro}
🔍

      
_{Janne Härkönen}
💻

      
_{Kerkko Pelttari}
💻

      
_Robocorp
💵

    

    

      
_René
💻

      
_{Bryan Oakley}
🤔

      
_{Tanakiat Srisaranyakul}
🤔

      
_{Maaret Pyhäjärvi}
📓

      
_{Karlo Smid}
📓

      
_{Frank Schimmel}
📓

      
_Christoph
⚠️

    

    

      
_{Mika Hänninen}
💬

      
_imbus
💵

      
_Niklas
📖

      
_gdroes
⚠️

      
_Reaktor
💵

      
_{Adrian Yorke}
📖 👀

      
_Nanakawa
⚠️

    

    

      
_{Ed Manlove}
📖 🐛

      
_{Brian Tsao}
🐛 📓

      
_charis
💻 🐛

      
_s-galante
🐛

      
_{Simon Meggle}
📓 🐛 ⚠️ 🤔

      
_Anna-Gunda
🐛

      
_anton264
📓

    

    

      
_emakaay
🐛

      
_{Nea Ohvo}
🐛

      
_{Elout van Leeuwen}
📖 🤔 💻

      
_LDerikx
📖

      
_olga-
📖 🐛

      
_{Nicholas Bollweg}
📖

      
_{Ville Salonen}
🐛

    

    

      
_{Jani Mikkonen}
🐛 📖 🤔 💻

      
_{Aleh Borysiewicz}
🐛

      
_{Jürgen Knauth}
🐛

      
_dalaakso
🐛

      
_msirkka
🤔

      
_{Ossi R.}
💻

      
_{Adrian V.}
💻 🐛 🤔

    

    

      
_{Sami Sallmén}
🐛 ⚠️

      
_{Pekka Klärck}
💻 🐛

      
_{Jani Palsamäki}
🐛

      
_{AllanMedeiros}
🐛

      
_{Emmanuel Alap}
🐛 💻

      
_{ankurbhalla-gmail}
🤔

      
_UliSei
🤔 🐛 💻 📓

    

    

      
_{Tomasz Pawlak}
🐛

      
_mtoskamp
🐛

      
_zastress
🐛

      
_{Juga Paazmaya}
💻

      
_{Raphael Smadja}
🤔 💻 🐛

      
_{Antti Pakkanen}
🐛

      
_{Luis A Gomez-Tinoco}
🐛 💡 💻

    

    

      
_ePlanLori
🐛

      
_laguna357
🐛

      
_{Gavin Rodgers}
🐛

      
_{pokaalinkanssayohon}
🤔

      
_{Ryan Sandbach}
🐛 💻

      
_{Niko Kahilainen}
🐛

      
_{Guillaume Gautier}
📖

    

    

      
_{Robin Matz}
🤔

      
_{Stavros Ntentos}
📖

      
_Massukio
🐛 🤔

      
_Atihinen
🐛

      
_gvrkumar
🤔

      
_{Lauri Helkkula}
🐛

      
_rlall07
🐛 🤔

    

    

      
_{Eldad Uzman}
🤔

      
_mgarcibu
🐛

      
_DominikG
🤔

      
_jokinr
⚠️ 🐛

      
_{Jier Chen}
💻

      
_IDvoe
🐛

      
_{Cosmin Poieana}
🐛

    

    

      
_Shenthil
🐛

      
_{Marduk Bolaños}
🐛 🤔

      
_amodzelewski
🐛

      
_TimDicos
🐛

      
_vinismarques
🐛

      
_nizwiz
🐛

      
_Reddriver
🤔

    

    

      
_Seppo
🐛

      
_rousku
🐛

      
_{tomaspekarovic}
🤔

      
_{Robin Mackaij}
🐛

      
_nixuewei
🤔

      
_Slava
🤔 🐛 💻

      
_{Kari Harju}
🐛

    

    

      
_you
🐛

      
_axiom41
🐛

      
_amankul
🐛

      
_jcb-entrnce
🐛

      
_Remppa
🐛

      
_{Tomasz Pawlak}
🐛

      
_{Timo Stordell}
🐛

    

    

      
_{Marcin Gmurczyk}
💻

      
_{Daniel Biehl}
🐛 🤔

      
_rarajabs
🐛

      
_{Sandeep Vaidya}
🤔

      
_falk
📖

      
_ciadoh
🐛

      
_{Johan van Iperen}
💻

    

    

      
_{Fabio Zadrozny}
🐛

      
_BCGST
📖

      
_{Wilfried van Asten}
🐛 💻

      
_{Mikal H Henriksen}
🐛

      
_alexinoDr
🐛

      
_{trybuskrzysztof}
🐛

      
_Aino1980
🐛

    

    

      
_BjornAhmark
🐛

      
_Mezohren
🐛

      
_{Zoupers Zou}
🤔

      
_{lasselindqvist}
🐛

      
_{David Nieto Sanz}
🐛

      
_{Gil Forcada Codinachs}
📖 🐛

      
_{Nathan Hannig}
🐛

    

    

      
_{Martin Kjellstrand}
🐛

      
_{Anton Medvedev}
💻

      
_{martamedovova-ext91522}
🐛 🤔

      
_{Dr. Dirk Richter}
🤔

      
_RatexMak
🤔

      
_horzuff
💻

      
_naibra
🐛

    

    

      
_{Antti Pekka Vilkko}
🐛

      
_{Serafín Martín}
🐛

      
_JoostW21111
🐛

      
_Camatius
🐛

      
_terckert
🐛

      
_{Maksim Bondarew}
🐛

      
_{HenrikSchuette}
🐛

    

    

      
_{Gurunatharudh Bhandarkavathe(Infosys)}
🐛

      
_alpip1997
🐛

      
_terolindfors
🐛

      
_{Thisara Wijesundera}
🤔

      
_masudparvez
🤔

      
_gitkatsi
🐛 💻

      
_{Many Kasiriha}
🐛 🤔

    

    

      
_{Thulasi Raju}
📖

      
_{Giancarlo Soverini}
🤔

      
_lennartq
💻

      
_{Lukas Boekenoogen}
📖 💻 🐛

      
_anacomparada
🐛 📖

      
_siongwai
🤔 🐛

      
_nfaustin
🐛

    

    

      
_{Guido Schmitz}
💻

      
_{Chris Nesbitt-Smith}
💻

      
_vmmattila
🐛

      
_{Andre-A-AtGithub}
🐛

      
_Paweł
🐛

      
_{Raphael CAMUS}
🐛

      
_Markus
🤔

    

    

      
_wojtekwp
🐛

      
_Rudolf
🐛 🤔

      
_{Henrique Branco}
🐛

      
_mika-b
🐛

      
_okraus-ari
💻

      
_ecare-joost
🐛

      
_PaulBrandUWV
🐛

    

    

      
_ArttuKnowit
🐛

      
_{T. Silvola}
🐛

      
_{Teemu Kallio}
🐛

      
_{José Almeida}
🐛

      
_{William Looman}
💻

      
_mekxtari
🤔

      
_keef78
🤔

    

    

      
_André
💻

      
_MarvKler
🐛

      
_{Vaclav Carnogursky}
🤔

      
_{Alexander Vey}
🐛

      
_{Vaclovas Brazdauskas}
🐛

      
_{Benjamin Taylor}
🐛

      
_{Rein van der Vegt}
🐛

    

    

      
_tomek
🐛

      
_node137
🐛

      
_barambulka
🤔

      
_timdegroot
💻

      
_{Samuel Montgomery-Blinn}
💻

      
_{Paul Chevallier}
🐛

      
_{JaakkoPakarinen}
🤔

    

    

      
_{Matias Perichon}
🤔

      
_{Lassi Heikkinen}
🤔 💻

      
_{Maurice Koster}
🐛

      
_{Kitsios Konstantinos}
💻

      
_{Tobias Bora}
🐛

      
_{Frank Stenzhorn}
🐛

      
_{Sander van Beek}
🐛 💻

    

    

      
_{Sebastiaan Molenaar}
🐛

      
_{David Sommers}
💻 🤔

      
_{Alfred_Bail}
🐛

      
_{Eslam Elmishtawy}
🤔

      
_Miksuu14
🤔

      
_{BastiaanTenBroeke24}
💻
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/marketsquare/robotframework-browser

Awesome Lists containing this project

README
