WebdriverIO Tutorial

The Applitools Eyes WebdriverIO SDK allows you to easily add visual checkpoints to your JavaScript Selenium tests. It takes care of getting screenshots of your application from the underlying WebDriver, sending them to the Eyes server for validation and failing the test in case differences are found.

Install the SDK

npm install '@applitools/eyes.webdriverio' --save-dev

Run your first test

Applitools Eyes reports differences by comparing screenshots of your application with baseline images that define the expected appearance of the application at each step of the test. By default, the Eyes SDK detects the environment in which the application is running (namely, the operating system, the type of browser and its viewport size) and compares the screenshots against baseline images that are specific to that environment. The first time you run a test in a given environment, its screenshots will be automatically saved as its baseline. Starting from the second run onward, you always have a baseline to compare against.

The test below is a simple WebdriverIO code that visually validates the Hello World web-page at https://applitools.com/helloworld. It consists of two visual checkpoints, each validating the entire application window. The first time you run this test a new baseline will be created, and subsequent test runs will be compared to this baseline. If any screenshot mismatch its baseline image in a perceptible way, $eyes.close() will throw a DiffsFoundException which includes a URL that points to a detailed report where you can see the detected differences and take appropriate actions such as reporting bugs, updating the baseline and more.

Before running the test, make sure to set the API key that identifies your account in the environment variable APPLITOOLS_API_KEY or directly assign it to the $eyes->setApiKey() method. You can find your API key under the user menu located at the right hand side of the test manager toolbar. If you don't yet have an account create it now to obtain your key.

async function main() {
  const webdriverio = require('webdriverio');

  // Open a Chrome browser.
  const browserOptions = {
      remoteHost: "http://localhost:4444",
      desiredCapabilities: {
          browserName: 'chrome',
          chromeOptions: {
              args: [
                  'disable-infobars',
              ]
          }
      }
  };
  const driver = webdriverio.remote(browserOptions);
  let browser = driver.init();

  // Initialize the eyes SDK and set your private API key.
  const {Eyes, Target} = require('@applitools/eyes.webdriverio');
  let eyes = new Eyes();
  eyes.setApiKey('YOUR_API_KEY');

  try {

      // Start the test and set the browser's viewport size to 800x600.
      await eyes.open(browser, 'Hello World!', 'My first WebdriverIO test!', {width: 800, height: 600});

      // Navigate the browser to the "hello world!" web-site.
      await browser.url('https://applitools.com/helloworld');

      // Visual checkpoint #1.
      await eyes.check('Main Page', Target.window());

      // Click the "Click me!" button.
      await browser.click('button');

      // Visual checkpoint #2.
      await eyes.check('Click!', Target.window());

      // End the test.
      await eyes.close();

  } finally {

      // Close the browser.
      await browser.end();

      // If the test was aborted before eyes.close was called ends the test as aborted.
      await eyes.abortIfNotClosed();

  }

}

main();

Analyze your test results

Congratulations! You've successfully run your first visual UI test with Applitools Eyes! A detailed report is ready for your inspection at the Applitools Eyes test manager. Watch this 5 minute video to get acquainted with the test manager and to learn the basics of baseline maintenance.

Login to Applitools and analyze the results.

Learn more

Applitools Eyes is a powerful platform for automated visual UI testing that supports full page screenshots, page layout matching, cross-device and browser testing, test batching, baseline branching and merging, automated baseline maintenance, collaboration features, and much more. Applitools has over 40 SDKs supporting a broad range of testing environments.

Reference documentation

To learn more, check out the Applitools Eyes documentation and tutorials for other testing environments.

Request a demo

If you want to see a demo of all our other features, you do request a demo

Knowledge base and Support

You can search our Knowldege base for more information. You can also file a contact our support team and file a Ticket.


Terms & Conditions Privacy Policy GDPRĀ© 2018 Applitools. All rights reserved.

Last Updated: 10/23/2018, 12:49:37 PM