Skip to content

Add Robot Framework support via PercyLibrary #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
neha-sanse wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Add Robot Framework support via PercyLibrary #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
642906c
Add Robot Framework support via PercyLibrary
neha-sanse Apr 21, 2026
7c762d7
Add Robot Framework section to README and dev deps
neha-sanse Apr 21, 2026
61cafd3
Add Robot Framework integration test suite
neha-sanse Apr 21, 2026
5c86c43
Fix lint: replace em dashes in .robot, ignore .robot files and import…
neha-sanse Apr 22, 2026
a0c120f
Fix create_region kwargs to match camelCase signature
neha-sanse Apr 22, 2026
1464514
Fix lint: top-level imports, remove unused imports in test file
neha-sanse Apr 22, 2026
cd2a3e0
Fix all remaining lint: line length, too-many-arguments, too-few-publ…
neha-sanse Apr 22, 2026
e7e9776
Fix labels: join list to comma-separated string before passing to per…
neha-sanse Apr 22, 2026
80787d0
Fix padding: convert int to {top,bottom,left,right} object per Percy …
neha-sanse Apr 22, 2026
91d3c6e
Add Create Percy Region usage examples to keyword docstrings
neha-sanse Apr 22, 2026
800ddc2
Fix Robot Framework builds showing selenium instead of robotframework…
neha-sanse Apr 23, 2026
f024f45
Fix lint: import order and line-too-long in docstrings
neha-sanse Apr 23, 2026
a277854
chore: bump version to 2.2.0 for Robot Framework support
neha-sanse Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .pylintrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
[MASTER]
fail-under=10.0
ignore-patterns=.*\.robot$
disable=
broad-except,
broad-exception-raised,
global-statement,
import-error,
Copy link
Copy Markdown
Contributor

@amandeepsingh333 amandeepsingh333 Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LOW — Globally disabling import-error is too broad

This suppresses legitimate import errors across the entire codebase, not just for the optional robotframework imports. The Robot-specific imports are already wrapped in try/except ImportError in the code.

Consider using targeted inline disables instead:

from robot.api.deco import keyword, library  # pylint: disable=import-error

Or scope it to the specific file only.

invalid-name,
missing-class-docstring,
missing-function-docstring,
Expand Down
70 changes: 70 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,3 +195,73 @@ $ percy exec -- [python test command]
```

Refer to docs here: [Percy on Automate](https://www.browserstack.com/docs/percy/integrate/functional-and-visual)

## Robot Framework Support

This package includes built-in Robot Framework support. Install the additional dependencies:

```sh-session
$ pip install robotframework robotframework-seleniumlibrary
```

Then use `PercyLibrary` in your Robot tests:

```robot
*** Settings ***
Library SeleniumLibrary
Library percy.robot_library.PercyLibrary

*** Test Cases ***
Homepage Visual Test
Open Browser https://example.com chrome
Percy Snapshot Homepage
Percy Snapshot Responsive widths=375,768,1280
Percy Snapshot Tagged labels=regression,v2
Close Browser
```

Run with `percy exec`:

```sh-session
$ percy exec -- robot tests/
```

### Robot Keywords

#### Percy Snapshot

`Percy Snapshot name [widths] [min_height] [percy_css] [scope] [enable_javascript] [enable_layout] [labels] [regions]`

- `name` (**required**) - The snapshot name; must be unique to each snapshot
- `widths` - Comma-separated responsive widths (e.g., `375,768,1280`)
- `min_height` - Minimum screenshot height in pixels
- `percy_css` - Custom CSS to inject before snapshot
- `scope` - CSS selector to limit the snapshot area
- `enable_javascript` - Enable JS in Percy rendering (default: not set)
- `enable_layout` - Enable layout comparison mode (default: not set)
- `labels` - Comma-separated labels/tags (e.g., `regression,homepage`)
- `test_case` - Test case identifier
- `regions` - JSON string of region definitions (use `Create Percy Region`)
- `responsive_snapshot_capture` - Enable responsive capture mode

#### Percy Screenshot (Automate)

`Percy Screenshot name [options] [ignore_region_selenium_elements] [consider_region_selenium_elements]`

#### Create Percy Region

`Create Percy Region [algorithm] [element_css] [element_xpath] [bounding_box] [padding]`

```robot
${region}= Create Percy Region algorithm=ignore element_css=.ad-banner
Percy Snapshot Homepage regions=${{json.dumps([${region}])}}
```

#### Percy Is Running

```robot
${running}= Percy Is Running
Run Keyword If ${running} Percy Snapshot Homepage
```

> Note: Robot Framework support is optional. If `robotframework` is not installed, the rest of `percy-selenium` works unchanged.
2 changes: 2 additions & 0 deletions development.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
httpretty==1.0.*
pylint==2.*
twine
robotframework>=5.0
robotframework-seleniumlibrary>=5.0
6 changes: 6 additions & 0 deletions percy/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
from percy.snapshot import percy_automate_screenshot
from percy.exception import UnsupportedWebDriverException

# Robot Framework support — graceful when robotframework is not installed
try:
from percy.robot_library import PercyLibrary
except ImportError:
pass

# import snapshot command
try:
from percy.snapshot import percy_snapshot
Expand Down
Loading
Loading