No project description provided
Project description
robotframework-browser
:construction_worker: :construction: Work in Progress :construction: :performing_arts:
Robot Framework Browser library powered by Playwright. Moving browser automation to year 2020 (or 2021)!
Aiming for :rocket: speed, :white_check_mark: reliability and :microscope: visibility.
Supporting testing and automation with Robot Framework and Python.
Official post about this venture.
Installation instructions
Only Python 3.8 or later is supported.
- Install node.js e.g. from https://nodejs.org/en/download/
- Install robotframework-browser from the commandline:
pip install robotframework-browser - Install the node dependencies needed to run Playwright from the commandline:
rfbrowser init
Development
Source code organization
These are the directories containing source code and tests:
Browser, contains the Python source code for the actual Robot Framework test library.node/playwright-wrapper, contains a wrapper for Playwirght that implements the grpc protocol, implemented in Typescript.node/dynamic-test-app, contains a test application used in the acceptance tests, implemented in Typescript + React.protobuf, contains the Protocol Buffer definitions used by the communication between the library and Playwirght wrapper.utest, unit tests for the Python code.atest, acceptance tests written with Robot Framework.
Development environment
Install Python, nodejs and yarn. Make sure you have make available.
Setup development environment with make dev-env.
This creates a Python virtualenv in .venv directory, and install both Python and
nodejs dependencies.
To update the dependencies use either make dev-env to update all or
alternatively make .venv or make node-deps to update only Python or nodejs
dependencies, respectively.
Make sure to run source .venv/bin/activate to activate the correct virtualenv.
Run make build or yarn build to build the Typescript code. Also run make build
after changes to the protocol (protos/playwright.proto) to re-generate protobuffer code.
Development in Windows
Install Chocolatey and then install development tools with
choco install sed make.
After that, the development workflow should work as described in the previous chapter.
The only difference is that the virtualenv needs to be activated by running
.venv\Scripts\activate in the command prompt.
Testing
There are both unit tests written with pytest and acceptance test written with
Robot Framework. These can be run manually with make utest and make atest.
To run continuously pytests in a watch mode make utest-watch.
To rerun failed tests you can use make test-failed The tests are also executed in a prepush hook.
Running tests in docker container
Docker container builds a clean install package. This can be used to check that a builded package works correctly in a clean environment without development dependencies.
- Build the container
make docker - Run tests mounted from host machine
make docker-test. - See results in
atest/output
Releasing
- Ensure generated code and types are up to date with
make build - Ensure tests and linting pass on CI
- Check that you have permissions to release on Github and PyPi
- Run
make version VERSION=<new_version>to update the version information to both Python and Node components. - Use
make releaseto create and release artifacts and upload to PyPi - Create Github release
Code style
Python code style is enforced with flake8 and black. These are executed in a
precommit hook, but can also be invoked manually with make lint-python.
JS / TS code style is enforced with eslint. Lints are run in precommit hooks, but can be run manually with make lint-node.
Architecture
There are 3 different interfaces that the library is targeting to use in browser automation and testing:
- User interface: Interactions with DOM elements.
- Internals of a webapp: State, Cookies, Storage, Methods.
- Requests & Responses: Interface between a browser and servers .
Python Library <--> gRPC <---> TypeScript and Playwright
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 📓 |
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
Built Distribution
Hashes for robotframework-browser-0.9.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ed79d0f66d49e9871d9b07029c29bea92526cf9e69a1e947d8d3cc9f5a764bc7 |
|
| MD5 | 7be2ccdbfe709e91cda927496949f2f9 |
|
| BLAKE2b-256 | 9e811e08a15f7abd8f6e9c819763b47bc16b2c40fcd21fde1851cce0404983f5 |
Hashes for robotframework_browser-0.9.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ed88d323b9888a4518859ef6a4a329722c27da5fdb36a1afe758650563a23337 |
|
| MD5 | 85977a5ade8abcbcf77019d129d0a780 |
|
| BLAKE2b-256 | a91aea07160715464d32228c20b749c345d286d7a8efd1ee86d179d6c90faf1c |
