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/ (only < v15 supported; if unsure, use 14.15.0 LTS)
  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 atest/docker/README.md.

Update instructions

To upgrade your already installed robotframework-browser library

  1. Update from commandline: pip install -U robotframework-browser
  2. Install the node dependencies for the newly installed version: rfbrowser init

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]);
}
exports.__esModule = true;
exports.myGoToKeyword = myGoToKeyword;
*** Settings ***
Library   Browser  jsextension=${CURDIR}/mymodule.js

*** Test Cases ***
Example Test
   New Page
   myGoToKeyword   https://www.robotframework.org

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}

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

🐛

Project details


Release history Release notifications | RSS feed

This version

7.0.0

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

Uploaded Source

Built Distribution

robotframework_browser-7.0.0-py3-none-any.whl (627.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: robotframework-browser-7.0.0.tar.gz
  • Upload date:
  • Size: 96.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.7

File hashes

Hashes for robotframework-browser-7.0.0.tar.gz
Algorithm Hash digest
SHA256 f2b96909e7274405d590691dd52b726680e2b457b90bb10f5c1a8d3516cb3555
MD5 a725345bcf4b56086e4979c2a6f0273c
BLAKE2b-256 a830a71dcf99ae6b043a32b8ff55d6e4464783e37fbff46cb77e3d77935837e2

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: robotframework_browser-7.0.0-py3-none-any.whl
  • Upload date:
  • Size: 627.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.7

File hashes

Hashes for robotframework_browser-7.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d876643dcf522d6f896ca7102d8327ca3a7516db0ecd5960981af3ed8fe40baf
MD5 02cd0991d67bb3b1615eb7bdf651db01
BLAKE2b-256 2308deaba1ef372eda93e9ccdbaf9c30f2ca41737349c6a11935518d01a8d30b

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