Workflow:MarketSquare Robotframework browser Installation and Setup
| Knowledge Sources | |
|---|---|
| Domains | Browser_Automation, Test_Infrastructure, Installation |
| Last Updated | 2026-02-12 04:00 GMT |
Overview
End-to-end process for installing and configuring the robotframework-browser library, including Node.js dependencies and Playwright browser binaries.
Description
This workflow covers the complete installation and setup of the Browser library for Robot Framework. There are two installation paths: one using BrowserBatteries (which bundles precompiled Node.js binaries, removing the need for a local Node.js installation) and one requiring the user to install Node.js separately. Both paths culminate in installing Playwright browser binaries (Chromium, Firefox, WebKit) and verifying the installation works correctly.
Usage
Execute this workflow when setting up a new test automation environment that requires browser-based testing with Robot Framework. This applies to fresh installations on developer machines, CI/CD pipelines, or Docker containers where the Browser library has not yet been configured.
Execution Steps
Step 1: Choose Installation Path
Determine whether to use the BrowserBatteries package (no Node.js required) or the standard installation (Node.js required). BrowserBatteries bundles precompiled Node.js binaries and dependencies, simplifying setup but with limited OS/architecture support. The standard path offers more flexibility and is required for plugin development with third-party Node.js modules.
Key considerations:
- BrowserBatteries may not be available for all OS/architecture combinations
- Plugin developers needing custom Node.js modules must use the standard path
- Both paths require Python 3.10 or newer
Step 2: Install Python Package
Install the robotframework-browser Python package using pip. For the BrowserBatteries path, install with the bb extra to include the batteries package. For the standard path, install the base package only. Ensure pip is up to date before installation.
Key considerations:
- Always update pip first to ensure compatibility
- BrowserBatteries and robotframework-browser versions must match
- Optional Robocop integration available via the robocop extra
Step 3: Initialize Node Dependencies
For the standard installation path, run the rfbrowser init CLI command to install Node.js dependencies via npm. This step downloads and installs the Node.js packages required by the Playwright gRPC wrapper. For BrowserBatteries, this step is skipped as dependencies are pre-bundled.
Key considerations:
- Requires Node.js 20, 22, or 24 LTS for standard installations
- The init command runs npm ci internally for reproducible installs
- Falls back to python -m Browser.entry init if rfbrowser CLI is not on PATH
Step 4: Install Browser Binaries
Install Playwright browser binaries using rfbrowser install (BrowserBatteries) or as part of rfbrowser init (standard). By default, Chromium, Firefox, and WebKit are all installed. Selective installation is possible by specifying individual browsers as arguments.
Key considerations:
- Default installation is approximately 700MB or more depending on OS
- Use --skip-browsers flag to skip binary installation if managing Playwright browsers separately
- Individual browsers can be specified: rfbrowser init firefox chromium
Step 5: Verify Installation
Confirm the installation by running a minimal Robot Framework test that imports the Browser library, opens a page, and performs a basic assertion. Alternatively, use rfbrowser show-versions to display installed versions of Browser library, Robot Framework, and Playwright.
Key considerations:
- Verify all three browser engines if tests require cross-browser coverage
- Check gRPC communication between Python and Node.js processes
- Confirm the correct Playwright version is reported