Testing web apps using WebdriverIO 5
WebdriverIO 5 has been deprecated since January 2021. We recommend using WebdriverIO 7 or higher.
Running Tests with Applitools
Prerequisites
A free Applitools account and Applitools API KEY
Tip: Unsure how to find your API key?Read Retrieving your API key to find your API key.
Node.js https://nodejs.org
Note: Installing git
is optionalInstalling git is used to clone the demo project from the Github repository. Instead of installing
git
, you can simply download the Zip file from the repository. Further, if you are Mac, you already havegit
.Selenium Standalone Server https://www.seleniumhq.org/download/
Note that this is a jar fileYou should also have Java installed on your machine.
Google Chrome Browser https://www.google.com/chrome/
ChromeDriver https://chromedriver.chromium.org/getting-started
ChromeDriver must be installed and in your PATH
Below are some resources from the internet that'll help you
On Mac, place the
chromedriver
executable in/usr/local/bin
folder so Eclipse and IntelliJ can find it. :::
Option 1 - Run With The Ultrafast Grid
Running the Example Project
- Clone or download the repository and navigate to that folder
git clone https://github.com/applitools/tutorial-webdriverio5-ultrafastgrid
cd tutorial-webdriverio5-ultrafastgrid
Note: you can alternatively download the project as a Zip file and extract it
- Run the standalone server jar file
java -jar selenium-server-standalone-3.141.59.jar
Replace the jar file name with your jar file name
- Install the dependencies
npm install
- Run the example test
APPLITOOLS_API_KEY="[Your API Key]" npm test
This will first set your APPLITOOLS_API_KEY
into the node process then run npm test
.
Adding Applitools Eyes to an Existing Node.js WebdriverIO Project
Install Applitools Eyes dependencies:
npm install @applitools/eyes-webdriverio webdriverio@5 --save-dev
Sample test
Option 2 - Run Locally
Running the Example Project
- Clone or download the repository and navigate to that folder
git clone https://github.com/applitools/tutorial-webdriverio5-basic
cd tutorial-webdriverio5-basic
Note: you can alternatively download the project as a Zip file and extract it
- Run the standalone server jar file
java -jar selenium-server-standalone-3.141.59.jar
Replace the jar file name with your jar file name
- Install the dependencies
npm install
- Run the example test
APPLITOOLS_API_KEY="[Your API Key]" npm test
This will first set your APPLITOOLS_API_KEY
into the node process then run npm test
.
Adding Applitools Eyes to an Existing Node.js WebdriverIO Project
Install Applitools Eyes dependencies:
npm install @applitools/eyes-webdriverio webdriverio@5 --save-dev
Sample test
Don't suffer in silence! Let us help you. Please reach out to us to get your project working.
Taking the next steps with Applitools
Congratulations on completing this quickstart! There's still so much to learn about visual testing with Applitools, but you're off to a great start.
Resources for next steps:
- 🤖 Learning how visual testing works
- ↔️ Setting match levels for visual checkpoints
- 💥 Troubleshooting common issues
- 🐞 Reporting bugs
- 🗺 Detailed overview of visual testing with Applitools