https://github.com/samska/robot-applitools-tests
Visual Tests with Robot Framework using Applitools
https://github.com/samska/robot-applitools-tests
robotframework
Last synced: about 1 month ago
JSON representation
Visual Tests with Robot Framework using Applitools
- Host: GitHub
- URL: https://github.com/samska/robot-applitools-tests
- Owner: Samska
- Created: 2024-02-29T13:03:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-20T22:24:26.000Z (about 2 years ago)
- Last Synced: 2025-07-20T08:50:21.954Z (11 months ago)
- Topics: robotframework
- Language: RobotFramework
- Homepage: https://samska.github.io/robot-applitools-tests/report.html
- Size: 158 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Robot Framework Visual Tests using Applitools
Sample project on how to setup robot framework for visual tests using Applitools (with EyesLibrary).
```
robot-applitools-tests/
├── .github/
│ ├── workflows/
│ ├── robot.yml # Configuration for the tests on CI
├── config/
│ ├── requirements.txt # Required dependencies for the tests
├── resources/ # Resources used in the project like keywords and variables
│ ├── common_keywords.robot # Common keywords used for the visual tests
│ ├── common_settings.robot # Common settings used for the visual tests
│ ├── common_variables.robot # Common variables used for the visual tests
├── reports/ # Test results generated by Robot
│ ├── log.html
│ ├── output.xml
│ ├── report.html
├── tests/ # Project tests separated by test type folder
│ ├── applitools.yaml # Configuration for Applitools tests
│ ├── visual_test_1.robot # Visual test file
│ ├── visual_test_2.robot # Visual test file
│ ├── visual_test_3.robot # Visual test file
├── .gitignore # Untracked folder and files
├── README.md # README with project overview and instructions
```
## Getting started
These instructions will get you a copy of the project and running on your local environment.
### Prerequisites
- Python 3
- ChromeDriver (or another webdriver of your choice)
### Installing
1. Clone the repository
2. Update the api_key in the applitools.yaml file
3. Install the dependencies:
```sh
pip install -r requirements.txt
```
### Running the Tests
To run the tests, use the following command:
```sh
pabot --outputdir reports tests
```
This will run all the visual tests in parallel mode, this was necessary for the Applitools since if you run using a unique suite (using the robot default command), all the visual tests will be grouped in a unique batch.
### Test Reports
The test results will be generated in the reports directory. Open the report.html file to view the HTML report.