wdio-eyes.selenium-service

Applitools Eyes support for webdriver.io. This wrapper built around the most maintained JS package of Applitools.Eyes that is more stable and contains the most recent features.

If you don't have an Applitools account yet, signup for free for a trial account.

To install run: npm i wdio-eyes.selenium-service --save-dev

Initial setup:

• Insert the following sections in your config file (wdio.conf.js)
  • services: ['eyes.selenium'], //To enable eyes.selenium service
  • Configuration params, a subset of the following object:

  applitools: {
      apiKey: process.env.API_KEY,                //Required
      appName: "My Application",                  //Recommended
      viewport: {width: 1111, height: 650},       //Recommended for web, don't use in mobile
      batchName: "Config Batch",                  //Optional
      globalMatchLevel: "Layout",                 //Optional
      disableCSSScrolling: true,                  //Optional
      disableFullPageScreenshot: true,            //Optional
      serverUrl: "https://myeyes.applitools.com", //Optional
      debug: true,                                //Optional
      disable: false,                             //Optional, relevant only if =true
      useEyesWDIO: true,                          //Optional, Use Applitools new WDIO sdk under the hood
      sendDom: true,                              //Optional, Currently for EyesWDIO, default:true
  },

• Create your first test in tests/specs folder (if needed create the folders too)

  describe('Simple cases', function () {
      this.timeout(300000);
      describe("Test native App", function () {
          it("test-function-1",function () {
              browser.eyesOpen("Hello world 1");
              browser.url('/helloworld');
              browser.eyesCheckWindow("Homepage");
              browser.click('button');
              browser.eyesCheckWindow("After click");
              browser.eyesClose(false);
          });
      });
  });

• Advanced scenarios:
  • Fluent syntax - Describe all you need from your checkpoint in one liner short syntax:

  var Target = require('edio-eyes.selenium-service').getTarget();
  //...
  //Checking the window with Layout algorithm
  browser.eyesCheck("Checkpoint1", Target.window().layout());
  //Working with regions and Page objects
  browser.eyesCheck("Checkpoint2", Target.region(HelloWorldPage.title).layout());

  • Tags - Tagging interesting metrics of your tests later to be used with the "group by feature"

  browser.eyesTag("Feature", "Feature1"); //can be called x #of different metrics you want to introduce
  browser.eyesOpen("Hello world 1");
  //... rest of the test
  browser.eyesClose(false);
  // Clearing up tags if we want a fresh start for the next test
  browser.eyesClearTags();