Just contact Joel Oliveira with your Github user account!
EyesLibrary is a Robot Framework Library to automate visual software testing verification. EyesLibrary uses a Python SDK called Eyes-Selenium from the tool Applitools Eyes, and can be used with the SeleniumLibrary and/or the AppiumLibrary .
This library is a fork of Robot-AppEyes. In order to use EyesLibrary, you are required to sign up for a free account with Applitools. See the Usage section.
Information about EyesLibrary keywords can be found on the Keyword Documentation page.
The Applitools Documentation may be consulted in order to understand how Eyes works.
More information about the SeleniumLibrary can be found on the SeleniumLibrary Repo and in the Keyword Documentation.
More information about the AppiumLibrary can be found on the AppiumLibrary Repo and in the Keyword Documentation.
The following versions were used to test the library:
The recommended installation method is using pip:
pip install robotframework-eyeslibraryTo update both the library and all its dependencies to the latest version:
pip install --upgrade robotframework-eyeslibraryTo install a specific version:
pip install robotframework-eyeslibrary==(DesiredVersion)To uninstall EyesLibrary use the following pip command:
pip uninstall robotframework-eyeslibraryEyesLibrary/
The Robot Framework Python Library that makes use of the Applitools Eyes Python SDK
tests/acceptance/
Test files to display what the keywords from EyesLibrary accomplish
docs/
Documentation for the EyesLibrary: Keyword Documentation and ChangeLog
You must create a free account with Applitools in order to run EyesLibrary and return results.
Then, to use the library, follow EyesLibrary Keyword Documentation.
This is a Robot Framework library. If you're not familiarized with Robot Framework, please consult Robot Framework User Guide.
At tests/acceptance directory, you can find Robot Framework tests for:
Before running the tests, your Applitools API Key must be set in tests/acceptance/resources/common.robot, by replacing "YourApplitoolsApiKey" with your own key.
When running the mobile tests, you must replace the variables within tests/acceptance/resources/mobile.robot with your own, as well as the ones in tests/acceptance/resources/android.robot or tests/acceptance/resources/ios.robot, according to the OS in use.
For instance, you may want to use a different Remote URL than the one provided in the variables. So, if you are working with TestingBot, for example, you'd have to replace the Remote URL variable in tests/acceptance/resources/mobile.robot:
${REMOTE URL} http://${CREDENTIALS}@hub.testingbot.com/wd/hubBefore running the Android Hybrid App tests, you need to install the Demo App (APK found at tests/resources) in your device.
For in depth detail on how the keywords function, read the Keyword documentation found here: Keyword Documentation
Remember to include your Applitools API key otherwise the test will not run. To run a test, open a command prompt within the tests/acceptance folder and run:
robot FILENAME.robotFor example, to run the Test Suite for Web:
robot web.robotNote: It is assumed that anyone who wants to use this demo is already able to execute robot tests using SeleniumLibrary (for web tests) and/or AppiumLibrary (for mobile tests). The browser used to navigate with SeleniumLibrary is Google Chrome.
To be defined. It might be helpful to read Applitools Documentation.
EyesLibrary was forked from Robot-AppEyes on version 1.2.
Robot-AppEyes authors:
EyesLibrary then emerged as an independent library from the original one, on version 2.0.