WebdriverIO 6 tutorial
Getting Started
- 🤖 How it works
- 🖼 Analyzing differences
- 🐞 Reporting bugs (straight into Jira or Github)
- ✅ Prerequisites
- 🚀 Run Tests
More Resources
Note: This is for WebdriverIO 6. There are different tutorials for WebdriverIO 4 and WebdriverIO 5.
1. 🤖 How it works
Applitools SDKs work with existing test frameworks to take screenshots of pages, elements, regions or iframes and upload them along with DOM snapshots to our Eyes server. Our AI then compares them with previous test executions' screenshots (aka Baselines) and reports if there is a bug or not. It's that simple!
1.1 Baseline vs. Checkpoint images
When you first run the test, our A.I. server stores those first set of screenshots as Baseline images. When you run the same test again (and everytime there after), the A.I. server compares the new set of screenshots, aka Checkpoint images, with the corresponding Baseline images and highlights differences in a pink color.
1.2 Marking the test as "Pass" or "Fail"
When the AI compares the baseline and the checkpoint image, if it finds a legitimate difference, it will mark the test as Unresolved. This is because the AI doesn't know if the difference is because of a new feature or a real bug and will wait for you to manually mark it as a Pass/Fail for the 1st time.
If you mark the Unresolved checkpoint image as "Failed", it'll only mark the current test result as Failed.
Note:
To automatically mark the checkpoint as a "Fail" in the future test runs, you need to do the following:
- Annotate at least one of differences as a "bug region"
- Select the "Fail tests" checkbox in the popup window
- Press "Thumbs Up" (not "Thumbs Down") button in the checkpoint image's toolbar (Note: this is counter-intuitive. But what happens is that, we now create a new Baseline along with this bug and "Failed" metadata. So if the same image with the exact bug appears, it'll fail again)
- Press "Save" in the main toolbar
If you mark the Unresolved checkpoint image as a "Pass", then it means that the difference is due to a new feature so we set the new checkpoint image as the new baseline and mark the current test as Pass. Going forward we'll compare any future tests with this new baseline.
Note:
Applitools AI has been trained with 100s of millions of images. It doesn't do pixel-to-pixel comparison as this can lead to a lot of false positives. It instead simulates human eyes that ignore differences that humans can't detect and highlight differences that humans can detect.
ACCURACY: Our A.I.'s current accuracy rate is 99.9999%! Which means for most applications the odds that you'll see false-positives are 1 in a million!
A powerful test results dashboard
We provide a state-of-the-art dashboard that makes it very easy for you to analyze differences, report bugs and much more. For more information on the Applitools dashboard check out these articles.
2. 🖼 Analyzing differences
The following Gifs show various tools Applitools provides to easily analyze various differences
Highlight differences between the baseline and checkpoint
Zoom into differences
Toggle between baseline and checkpoint
Show both the baseline and checkpoint side-by-side
3. 🐞 Reporting bugs (straight into Jira or Github)
You can select a section of the image and directly file a bug in Jira or Github. No need to manually take screenshots, write steps and explain things! To read more about bug regions check out this article.
4. ✅ Prerequisites
A free Applitools account and Applitools API KEY
Node.js https://nodejs.org
-
TIP
Installing
gitis optional. You need this mainly to clone the demo project from the Github repository. Instead of installinggit, you can simply download the Zip file from the repo. Further, If you are Mac, you already havegit. Google Chrome Browser https://www.google.com/chrome/
ChromeDriver https://chromedriver.chromium.org/getting-started
ChromeDriver must be intsalled and in your PATH
Below are some resources from the internet that'll help you
Tip: On Mac, place the chromedriver executable in /usr/local/bin folder so Eclipse and IntelliJ can find it.
5. 🚀 Run Tests
There are two main ways in which you can run tests.
The Applitools Ultrafast Grid (option 1) Test across all browsers and viewports 30-70 times faster than traditional test clouds. Using this approach, your tests will execute on a local browser once with the DOM, CSS, and additional artifacts captured by the SDK and sent to the Ultrafast Grid for parallel rendering and Visual AI comparison. This is the preferred execution method, however please note that it is a premium feature.
The second approach is to Run Local (option 2). This is the classic test execution in which your tests execute locally and each call to eyes via the SDK will send a screenshot to Eyes for Visual AI comparison.
While running tests using the classic approach is a great start - we recommend running tests on the Ultrafast Grid, the fastest way to ensure quality and consistency across all browsers, viewports, and devices.
Option 1 - Run With The Ultrafast Grid
1. Introduction To the Ultrafast Grid
In real world testing, you'll need to test your app on multiple browsers, viewports and mobile devices. So you'll need to run and re-run ALL the tests in different browsers and multiple viewports to ensure things are fine - which could take hours and hours to complete. You may also encounter browsers not opening properly, or hanging and what not.
What if you could run in just one browser, just once, and still do cross-browser tests across various browsers, viewports and multiple mobile emulators? That's where Ultrafast Grid comes in.
TL;DR
When you execute this tutorial, it'll run the test locally in Chrome browser but will show results in the following 5 combinations:
- Chrome browser (800 X 600 viewport)
- Chrome browser (700 X 500 viewport)
- Firefox browser (1200 X 800 viewport)
- Firefox browser (1600 X 1200 viewport)
- An iPhone4 emulator
... all in ~30 seconds!⏰🚀
2. What Is The Ultrafast Grid?
The Ultrafast Grid provides an elegant and an ultra fast way to render pages in different browsers, viewports and mobile simulators and then take screenshots and then send those screenshots to Applitools AI server. With Ultrafast Grid you just need to run your test in a single browser but perform end-to-end and cross-browser tests in various browsers such as Chrome,Firefox, IE, and also numerous combinations of viewports and in mobile simulators -- all in under a minute. Without Ultrafast Grid, you'll be wasting a lot of time and money running those tests in multiple browsers which could take hours and are error-prone.
And since Ultrafast Grid is integrated with our Eyes AI, you'll actually find a lot more functional and visual bugs than you'd normally find.
Further, you can use our Root-Cause-Analysis (RCA) feature to figure out exactly which DOM element or CSS caused difference! So you can go backwards, from the screenshot to the code!
Best part: All you need to do is to simply make eyes.check calls in your existing Selenium tests after adding our SDK and instantiating Ultrafast Grid. And that's all there is to it!
How it works
Once you add and instantiate the Applitools SDK, simply add eyes.check calls wherever you want to check if the state of the page looks OK. Then run the Selenium test as usual. And while running the tests, anytime it encounters eyes.check (or similar methods), Applitools SDK uploads the DOM resource of that page to our Ultrafast Grid behind the scenes and in batches. The Ultrafast Grid then renders every page in different browsers and mobile emulators (in parallel) and takes screenshots as per the configuration you set. Finally, it sends those screenshots to our AI Server.
When you first run the test, our AI server simply stores those 1st set of screenshots as Baseline images. When you run the same test again, the AI server will compare the new set of screenshots, aka Checkpoint images, with the corresponding Baseline images and highlights bugs.
3. Getting Started With The Ultrafast Grid
Pre-requisites
- Node.js https://nodejs.org/en/
Running the Example Project
- Clone or download the repository and navigate to that folder
git clone https://github.com/applitools/tutorial-webdriverio6-ultrafastgrid
cd tutorial-webdriverio6-ultrafastgrid
2
Note: you can alternatively download the project as a Zip file and extract it
- 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 --save-dev
Sample test
'use strict';
const {
VisualGridRunner,
RunnerOptions,
Eyes,
Target,
Configuration,
BatchInfo,
BrowserType,
DeviceName,
ScreenOrientation
} = require('@applitools/eyes-webdriverio');
let eyes;
let runner;
let configuration;
describe('ACME Demo App - wdio6', function () {
before(async () => {
// Create a runner with concurrency of 5
// You can increase this value if your plan supports a higher concurrency
const runnerOptions = new RunnerOptions().testConcurrency(5);
runner = new VisualGridRunner(runnerOptions);
// Create Eyes object with the runner, meaning it'll be a Visual Grid eyes.
eyes = new Eyes(runner);
if (browser.config.enableEyesLogs) {
eyes.setLogHandler(new ConsoleLogHandler(true));
}
// Initialize the eyes configuration
configuration = eyes.getConfiguration();
// use new Configuration() when not setting eyes setter methods. e.g. eyes.setLogHandler() etc...
//new Configuration();
// You can get your api key from the Applitools dashboard
configuration.setApiKey(process.env.APPLITOOLS_API_KEY)
// create a new batch info instance and set it to the configuration
configuration.setBatch(new BatchInfo('Ultrafast Batch'))
configuration.addBrowser(800, 600, BrowserType.CHROME);
configuration.addBrowser(700, 500, BrowserType.FIREFOX);
configuration.addBrowser(1600, 1200, BrowserType.IE_11);
configuration.addBrowser(1024, 768, BrowserType.EDGE_CHROMIUM);
configuration.addBrowser(800, 600, BrowserType.SAFARI);
// Add mobile emulation devices in Portrait mode
configuration.addDeviceEmulation(DeviceName.iPhone_X, ScreenOrientation.PORTRAIT);
configuration.addDeviceEmulation(DeviceName.Pixel_2, ScreenOrientation.PORTRAIT);
});
beforeEach(async function () {
const appName = await this.test.parent.title;
const testName = await this.currentTest.title;
configuration.setAppName(appName);
configuration.setTestName(testName);
// Set the configuration to eyes
eyes.setConfiguration(configuration);
await eyes.open(browser);
});
it('ultraFastTest', async () => {
// Navigate to the url we want to test
await browser.url('https://demo.applitools.com/');
await expect(browser).toHaveTitle('ACME demo app');
// ⭐️ Note to see visual bugs, run the test using the above URL for the 1st run.
// but then change the above URL to https://demo.applitools.com/index_v2.html
// (for the 2nd run)
// check the login page with fluent api, see more info here
// https://applitools.com/docs/topics/sdk/the-eyes-sdk-check-fluent-api.html
await eyes.check('Login Window', Target.window().fully());
// Click the "Log in" button.
const loginButton = await browser.$('#log-in');
await loginButton.click();
// Check the app page
await eyes.check('App Window', Target.window().fully());
// Call Close on eyes to let the server know it should display the results
await eyes.closeAsync();
});
afterEach(async () => {
// If the test was aborted before eyes.close was called, ends the test as aborted.
await eyes.abortAsync();
});
after(async () => {
const results = await runner.getAllTestResults(false);
console.log(results);
});
});
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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-webdriverio6-basic
cd tutorial-webdriverio6-basic
2
Note: you can alternatively download the project as a Zip file and extract it
- 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 --save-dev
Sample test
'use strict';
const {
ClassicRunner,
RunnerOptions,
Eyes,
Target,
Configuration,
RectangleSize,
BatchInfo,
BrowserType,
DeviceName,
ScreenOrientation
} = require('@applitools/eyes-webdriverio');
let eyes;
let configuration;
let runner;
describe('ACME Demo App - wdio6', function () {
before(async () => {
// Create a runner with concurrency of 5
// You can increase this value if your plan supports a higher concurrency
const runnerOptions = new RunnerOptions().testConcurrency(5);
runner = new ClassicRunner(runnerOptions);
// Create Eyes object with the runner, meaning it'll be a Visual Grid eyes.
eyes = new Eyes(runner);
if (browser.config.enableEyesLogs) {
eyes.setLogHandler(new ConsoleLogHandler(true));
}
// Initialize the eyes configuration
configuration = eyes.getConfiguration();
// use new Configuration() when not setting eyes setter methods. e.g. eyes.setLogHandler() etc...
// new Configuration();
// You can get your api key from the Applitools dashboard
configuration.setApiKey(process.env.APPLITOOLS_API_KEY)
// create a new batch info instance and set it to the configuration
configuration.setBatch(new BatchInfo('Classic Batch'))
});
beforeEach(async function () {
const appName = await this.test.parent.title;
const testName = await this.currentTest.title;
configuration.setAppName(appName);
configuration.setTestName(testName);
// Set the configuration to eyes
eyes.setConfiguration(configuration);
browser = await eyes.open(browser);
});
it('classicTest', async () => {
// Navigate to the url we want to test
await browser.url('https://demo.applitools.com');
await expect(browser).toHaveTitle('ACME demo app');
// ⭐️ Note to see visual bugs, run the test using the above URL for the 1st run.
// but then change the above URL to https://demo.applitools.com/index_v2.html
// (for the 2nd run)
// check the login page with fluent api, see more info here
// https://applitools.com/docs/topics/sdk/the-eyes-sdk-check-fluent-api.html
await eyes.check('Login Window', Target.window().fully());
// Click the "Log in" button.
const loginButton = await browser.$('#log-in');
await loginButton.click();
// Check the app page
await eyes.check('App Window', Target.window().fully());
// Call Close on eyes to let the server know it should display the results
await eyes.closeAsync();
});
afterEach(async () => {
// If the test was aborted before eyes.close was called, ends the test as aborted.
await eyes.abortAsync();
});
after(async () => {
const results = await runner.getAllTestResults(false);
console.log(results);
});
});
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
6. ⚙️ Troubleshooting Common Issues
Forgetting to set your API key (or getting 401 exception).
Applitools is not opening the app (appears to crash).
- In order to make sure the screenshots are consistent across different tests runs. Applitools uses Viewport as an input. A viewport is simply the size of the screenshot you are taking (width and height). Applitools tries to resize the browser to that size before taking the screenshot. If you are running the app on a small laptop and/or have set the Viewport much larger than the laptop’s screen, then you’ll see this error.
- Solution: Reduce the height or the width. For more see here.
Not properly loading the API key from the environment variable into your IDE (like Eclipse).
- After setting the APPLITOOLS_API_KEY in the environment variable to hold your Applitools API key, open the IDE from the command line terminal (and not from the IDE directly). On Mac, it’d look like this: Open a Terminal and then type:
open ~/Applications/Eclipse.app. This will load Eclipse with all the environment variables.
- After setting the APPLITOOLS_API_KEY in the environment variable to hold your Applitools API key, open the IDE from the command line terminal (and not from the IDE directly). On Mac, it’d look like this: Open a Terminal and then type:
Trying to run the test but nothing happens
- Check if the APPLITOOLS_API_KEY is null
Incompatibility between Chrome browser and Chrome driver.
- Make sure for your version of Google Chrome, you are using the corresponding Chrome driver
Debug logs
- See this article to enable debug logs to help file support ticket
🧰 Resources
Terms & Conditions Privacy Policy GDPR© 2020 Applitools. All rights reserved.