Skip to main content

Robot Framework Browser library powered by Playwright. Aiming for speed, reliability and visibility.

Project description

robotframework-browser

All Contributors

Version Actions Status License


Robot Framework Browser library powered by Playwright. Moving browser automation to year 2023!

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

See keyword documentation and web page for more details.

Installation instructions

Only Python 3.8 or newer is supported. From Node side 18 and 20 LTS versions are supported.

  1. Install node.js 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 init --skip-browsers command, but then user is responsible for 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 init firefox chromium would install both Firefox and Chromium binaries.

Or use the docker images. Documented at docker/README.md.

Update instructions

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 install 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

Examples

Testing with Robot Framework

*** Settings ***
Library   Browser

*** Test Cases ***
Example Test
    New Page    https://playwright.dev
    Get Text    h1    contains    Playwright

and testing with 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

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.

Ergonomic selector syntax, supports chaining of 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"

Evaluate in browser page

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

# 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

${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

${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 ). This saves some overhead based on how many splits of tests you are running. Clean up the process afterwards.

Re-using authentication credentials

Development

See 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 through Robot Framework Foundation.

Mikko Korpela
Mikko Korpela

💻
Tatu Aalto
Tatu Aalto

💻
Antti Karjalainen
Antti Karjalainen

🔍
Ismo Aro
Ismo Aro

🔍
Janne Härkönen
Janne Härkönen

💻
Kerkko Pelttari
Kerkko Pelttari

💻
Robocorp
Robocorp

💵
René
René

💻
Bryan Oakley
Bryan Oakley

🤔
Tanakiat Srisaranyakul
Tanakiat Srisaranyakul

🤔
Maaret Pyhäjärvi
Maaret Pyhäjärvi

📓
Karlo Smid
Karlo Smid

📓
Frank Schimmel
Frank Schimmel

📓
Christoph
Christoph

⚠️
Mika Hänninen
Mika Hänninen

💬
imbus
imbus

💵
Niklas
Niklas

📖
gdroes
gdroes

⚠️
Reaktor
Reaktor

💵
Adrian Yorke
Adrian Yorke

📖 👀
Nanakawa
Nanakawa

⚠️
Ed Manlove
Ed Manlove

📖 🐛
Brian Tsao
Brian Tsao

🐛 📓
charis
charis

💻 🐛
s-galante
s-galante

🐛
Simon Meggle
Simon Meggle

📓 🐛 ⚠️ 🤔
Anna-Gunda
Anna-Gunda

🐛
anton264
anton264

📓
emakaay
emakaay

🐛
Nea Ohvo
Nea Ohvo

🐛
Elout van Leeuwen
Elout van Leeuwen

📖 🤔 💻
LDerikx
LDerikx

📖
olga-
olga-

📖 🐛
Nicholas Bollweg
Nicholas Bollweg

📖
Ville Salonen
Ville Salonen

🐛
Jani Mikkonen
Jani Mikkonen

🐛
Aleh Borysiewicz
Aleh Borysiewicz

🐛
Jürgen Knauth
Jürgen Knauth

🐛
dalaakso
dalaakso

🐛
msirkka
msirkka

🤔
Ossi R.
Ossi R.

💻
Adrian V.
Adrian V.

💻 🐛 🤔
Sami Sallmén
Sami Sallmén

🐛 ⚠️
Pekka Klärck
Pekka Klärck

💻 🐛
Jani Palsamäki
Jani Palsamäki

🐛
AllanMedeiros
AllanMedeiros

🐛
Emmanuel Alap
Emmanuel Alap

🐛 💻
ankurbhalla-gmail
ankurbhalla-gmail

🤔
UliSei
UliSei

🤔 🐛 💻 📓
Tomasz Pawlak
Tomasz Pawlak

🐛
mtoskamp
mtoskamp

🐛
zastress
zastress

🐛
Juga Paazmaya
Juga Paazmaya

💻
Raphael Smadja
Raphael Smadja

🤔 💻 🐛
Antti Pakkanen
Antti Pakkanen

🐛
Luis A Gomez-Tinoco
Luis A Gomez-Tinoco

🐛 💡 💻
ePlanLori
ePlanLori

🐛
laguna357
laguna357

🐛
Gavin Rodgers
Gavin Rodgers

🐛
pokaalinkanssayohon
pokaalinkanssayohon

🤔
Ryan Sandbach
Ryan Sandbach

🐛 💻
Niko Kahilainen
Niko Kahilainen

🐛
Guillaume Gautier
Guillaume Gautier

📖
Robin Matz
Robin Matz

🤔
Stavros Ntentos
Stavros Ntentos

📖
Massukio
Massukio

🐛 🤔
Atihinen
Atihinen

🐛
gvrkumar
gvrkumar

🤔
Lauri Helkkula
Lauri Helkkula

🐛
rlall07
rlall07

🐛 🤔
Eldad Uzman
Eldad Uzman

🤔
mgarcibu
mgarcibu

🐛
DominikG
DominikG

🤔
jokinr
jokinr

⚠️ 🐛
Jier Chen
Jier Chen

💻
IDvoe
IDvoe

🐛
Cosmin Poieana
Cosmin Poieana

🐛
Shenthil
Shenthil

🐛
Marduk Bolaños
Marduk Bolaños

🐛 🤔
amodzelewski
amodzelewski

🐛
TimDicos
TimDicos

🐛
vinismarques
vinismarques

🐛
nizwiz
nizwiz

🐛
Reddriver
Reddriver

🤔
Seppo
Seppo

🐛
rousku
rousku

🐛
tomaspekarovic
tomaspekarovic

🤔
Robin Mackaij
Robin Mackaij

🐛
nixuewei
nixuewei

🤔
Slava
Slava

🤔 🐛 💻
Kari Harju
Kari Harju

🐛
you
you

🐛
axiom41
axiom41

🐛
amankul
amankul

🐛
jcb-entrnce
jcb-entrnce

🐛
Remppa
Remppa

🐛
Tomasz Pawlak
Tomasz Pawlak

🐛
Timo Stordell
Timo Stordell

🐛
Marcin Gmurczyk
Marcin Gmurczyk

💻
Daniel Biehl
Daniel Biehl

🐛 🤔
rarajabs
rarajabs

🐛
Sandeep Vaidya
Sandeep Vaidya

🤔
falk
falk

📖
ciadoh
ciadoh

🐛
Johan van Iperen
Johan van Iperen

💻
Fabio Zadrozny
Fabio Zadrozny

🐛
BCGST
BCGST

📖
Wilfried van Asten
Wilfried van Asten

🐛 💻
Mikal H Henriksen
Mikal H Henriksen

🐛
alexinoDr
alexinoDr

🐛
trybuskrzysztof
trybuskrzysztof

🐛
Aino1980
Aino1980

🐛
BjornAhmark
BjornAhmark

🐛
Mezohren
Mezohren

🐛
Zoupers Zou
Zoupers Zou

🤔
lasselindqvist
lasselindqvist

🐛
David Nieto Sanz
David Nieto Sanz

🐛
Gil Forcada Codinachs
Gil Forcada Codinachs

📖 🐛
Nathan Hannig
Nathan Hannig

🐛
Martin Kjellstrand
Martin Kjellstrand

🐛
Anton Medvedev
Anton Medvedev

💻
martamedovova-ext91522
martamedovova-ext91522

🐛 🤔
Dr. Dirk Richter
Dr. Dirk Richter

🤔
RatexMak
RatexMak

🤔
horzuff
horzuff

💻
naibra
naibra

🐛
Antti Pekka Vilkko
Antti Pekka Vilkko

🐛
Serafín Martín
Serafín Martín

🐛
JoostW21111
JoostW21111

🐛
Camatius
Camatius

🐛
terckert
terckert

🐛
Maksim Bondarew
Maksim Bondarew

🐛
HenrikSchuette
HenrikSchuette

🐛
Gurunatharudh Bhandarkavathe(Infosys)
Gurunatharudh Bhandarkavathe(Infosys)

🐛
alpip1997
alpip1997

🐛
terolindfors
terolindfors

🐛
Thisara Wijesundera
Thisara Wijesundera

🤔
masudparvez
masudparvez

🤔
gitkatsi
gitkatsi

🐛 💻

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

robotframework-browser-18.2.0.tar.gz (306.6 kB view hashes)

Uploaded Source

Built Distribution

robotframework_browser-18.2.0-py3-none-any.whl (312.6 kB view hashes)

Uploaded Python 3

Supported by

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