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 2021!

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.7 or newer is 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.

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(page, args) {
  return await page.goto(args[0]);
}
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
Execute JavaScript    (elem) => elem.innerText = "abc"    ${ref}
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

๐Ÿ’ป

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

๐Ÿ›

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-11.3.0.tar.gz (203.2 kB view details)

Uploaded Source

Built Distribution

robotframework_browser-11.3.0-py3-none-any.whl (219.8 kB view details)

Uploaded Python 3

File details

Details for the file robotframework-browser-11.3.0.tar.gz.

File metadata

  • Download URL: robotframework-browser-11.3.0.tar.gz
  • Upload date:
  • Size: 203.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for robotframework-browser-11.3.0.tar.gz
Algorithm Hash digest
SHA256 e562e865ee8bb9805ea1c28c6f9b631c7f2a406f7117a2d217bd67683b058934
MD5 7f0b34a180f1f2e6346a46948a2c8fd3
BLAKE2b-256 4acc722fc555b9303f5eb5080fdb355a6300978770a59815a6f1eedfbcb567c4

See more details on using hashes here.

Provenance

File details

Details for the file robotframework_browser-11.3.0-py3-none-any.whl.

File metadata

  • Download URL: robotframework_browser-11.3.0-py3-none-any.whl
  • Upload date:
  • Size: 219.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for robotframework_browser-11.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ef8033619023caade4540da95bd225788e8894c4e9c7243727745ce52ed9fbd
MD5 1c5f4f436a2e40a55ba5227c6cdb395f
BLAKE2b-256 8522983b363b521b3527fc9131cf73b2e15368e581630786f7736b7e14086047

See more details on using hashes here.

Provenance

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