Package: robotframework-eyeslibrary
EyesLibrary for Robot FrameworkTable of ContentsIntroductionRequirementsInstallationDirectory LayoutUsageRunning the DemoThings to Note When Using ApplitoolsGetting HelpCreditsIntroductionEyesLibrary is a Robot Framework Library to automate visual software testing verification. EyesLibrary uses a Python SDK calledEyes-Seleniumfrom the toolApplitools Eyes, and can be used with theSeleniumLibraryand/or theAppiumLibrary.This library is a fork ofRobot-AppEyes.
In order to use EyesLibrary, you are required tosign upfor a free account with Applitools. See theUsagesection.Information about EyesLibrary keywords can be found on theKeyword Documentationpage.TheApplitools Documentationmay be consulted in order to understand how Eyes works.More information about the SeleniumLibrary can be found on theSeleniumLibrary Repoand in theKeyword Documentation.More information about the AppiumLibrary can be found on theAppiumLibrary Repoand in theKeyword Documentation.RequirementsThe following versions were used to test the library:Python 2.7.14 or 3.6.0Robot Framework 3.1.1Eyes-Selenium 3.16.2SeleniumLibrary 3.3.1 (For Web Tests)AppiumLibrary 1.5.0.3 (For Mobile Tests)InstallationThe recommendedinstallationmethod is usingpip:pip install robotframework-eyeslibraryToupdateboth the library and all
its dependencies to the latest version:pip install --upgrade robotframework-eyeslibraryTo install aspecific version:pip install robotframework-eyeslibrary==(DesiredVersion)UninstallTo uninstall EyesLibrary use the following pip command:pip uninstall robotframework-eyeslibraryDirectory LayoutEyesLibrary/The Robot Framework Python Library that makes use of the Applitools Eyes Python SDKtests/acceptance/Test files to display what the keywords from EyesLibrary accomplishdocs/Documentation for the EyesLibrary: Keyword Documentation and ChangeLogUsageYou must create afree accountwith Applitools in order to run
EyesLibrary and return results.Then, to use the library, followEyesLibrary Keyword Documentation.This is a Robot Framework library. If you're not familiarized with Robot Framework,
please consultRobot Framework User Guide.Running the DemoAttests/acceptancedirectory, you can find Robot Framework tests for:WebAndroid BrowserAndroid Native AppAndroid Hybrid AppiOS BrowseriOS Native AppiOS Hybrid AppBefore running the tests, your Applitools API Key must be set intests/acceptance/resources/common.robot, by replacing "YourApplitoolsApiKey" with your own key.When running the mobile tests, you must replace the variables withintests/acceptance/resources/mobile.robotwith your own, as well as the ones intests/acceptance/resources/android.robotortests/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 withTestingBot, for example, you'd have to replace the Remote URL variable intests/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 attests/resources) in your device.For in depth detail on how the keywords function, read the Keyword documentation found here:Keyword DocumentationRemember to include your Applitools API key otherwise the
test will not run.To run a test, open a command prompt within thetests/acceptancefolder 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.Things to Note When Using ApplitoolsThe tests will be accepted automatically by Applitools Eyes after the first run because a new baseline is being created. A second test run will show a comparison between screens.Changing the Applitools baseline parameters will create a new baseline, that is automatically accepted on the first run. (For more information, read the article:What is a ‘baseline’ and how is a baseline created?The viewport size should not be set to greater values than the maximum size of the device's window.
(For more information on using viewports, consultUsing viewports in Eyes)Getting HelpTo be defined. It might be helpful to readApplitools Documentation.CreditsEyesLibrary was forked fromRobot-AppEyeson version 1.2.Robot-AppEyes authors:Thomas ArmstrongSimon McMorranGareth NixonAdam SimmonsEyesLibrary then emerged as an independent library from the original one, on version 2.0.