Eyes SDK core

This package contains the low level API for working with Applitools' JS SDK's.

Usage

API

makeSDK

Initializes the SDK with a name, version and implementation of a driver.

Parameters (passed as a single destructured object):

• name - name of the SDK (this will appear in Applitools reports as part of the agentId)
• version - version of the SDK
• spec - implementation of the SpecDriver
• VisualGridClient - this is an implementation detail, and will be removed in a future version. For now, it's required to pass require('@applitools/visual-grid-client) in this property.

Returns an instance of the SDK, which can be used to create a Manager.

For example:

const {makeSDK} = require('@applitools/eyes-sdk-core')

const sdk = makeSDK({
    name: 'my.special.SDK',
    version: '1.2.3',
    spec,
    VisualGridClient: require('@applitools/visual-grid-client')
})

sdk.makeManager

Initializes a Manager instance. The Manager is responsible for creating multiple visual tests. A single manager should be created for an entire execution of test suites, in order to get benefits of caching and parallelism.

Parameters: EyesManagerConfig

Returns: EyesManager

For example:

// creates a manager for Ultrafast Grid tests:
const manager = await sdk.makeManager({type: 'vg', concurrency: 10})

// creates a manager for classic tests:
const manager = await sdk.makeManager()

manager.openEyes

Creates a visual test and returns the Eyes interface for performing various visual operations that Applitools provides.

Parameters (passed as a single destructured object):

• driver - the driver which is used to automate the application under test. This will be fed to SpecDriver methods as the first paramters.
• config - configuration of type EyesConfig.

Returns: Eyes

For example:

const eyes = await manager.openEyes({
    driver,
    config: {
        appName: 'My app',
        testName: 'My test',
        viewportSize: {width: 1000, height: 800},
        apiKey: '<Your API key>',
    }
})

manager.closeAllEyes

Closes all open tests, and waits for all of them to finish.

Parameters:

• throwOnDiff - boolean indicating whether to throw an exception if a visual difference is detected in one or more tests.

Returns: Array of TestResults (i.e. TestResults[]).

For example:

const allTestResults = await manager.closeAllEyes()

for (const testResults of allTestResults) {
    console.log(`Test ${testResults.name}: ${testResults.status}`)
}

eyes.check

Creates a visual checkpoint.

Parameters (passed as a single destructured object):

• settings - CheckSettings
• config - EyesConfig

Returns: MatchResult

For example:

// full page screenshot:
await eyes.check({
    settings: {fully: true}
})

// element screenshot:
await eyes.check({
    settings: {region: '.some-element'}
})

eyes.checkAndClose

IMPORTANT: this is still under development. In the meantime, use await eyes.check(); await eyes.close() instead

Creates a visual checkpoint and closes the test.

Parameters (passed as a single destructured object):

• settings - CheckSettings
• config - EyesConfig
• throwErr - boolean indicating whether to throw an exception if a visual difference is detected in one or more tests. Default: false.

Returns: TestResults

For example:

const testResults = await eyes.checkAndClose({settings, config, throwErr: true})

eyes.close

Closes the visual test.

Parameters (passed as a single destructured object):

• throwErr - boolean indicating whether to throw an exception if a visual difference is detected in one or more tests. Default: false.

Returns: TestResults

For example:

const testResults = await eyes.close({throwErr: true})

eyes.abort

Aborts the visual test.

Parameters:

none

Returns: TestResults

For example:

const testResults = await eyes.abort()

Developing the SpecDriver

Implementing the interface SpecDriver is one of the more tedious tasks involved in creating an SDK for Eyes. For this, we can offer tooling and reference implementations.

checkSpecDriver method

The @applitools/eyes-sdk-core package exports a debugging tool to help detect if SpecDriver is implemented correctly.

To use it, require and call the following:

const {checkSpecDriver} = require('@applitools/eyes-sdk-core')
const result = await checkSpecDriver({driver, spec})

Where driver is the driver you would pass in manager.openEyes, and spec is the object implementing SpecDriver.

Example script for using this tool with Selenium:

const {checkSpecDriver} = require('@applitools/eyes-sdk-core')
const {Builder} = require('selenium-webdriver')
const spec = require('./spec-driver')
const chalk = require('chalk')

;(async function main() {
    const driver = await new Builder()
      .withCapabilities({browserName: 'chrome', 'goog:chromeOptions': {args: ['headless']}})
      .build()

    try {
        const results = await checkSpecDriver({driver, spec})
        
        let errCount = 0
        results.forEach(result => {
            if (result.error) {
                console.log(chalk.red(`${++errCount})`), result.test)
                console.log(`\t${chalk.cyan(result.error.message)}`)
                console.log(`\texpected:`, result.error.expected)
                console.log(`\tactual:`, result.error.actual)
            } else if (result.skipped) {
                console.log(chalk.yellow('?'), result.test)
            } else {
                console.log(chalk.green('✓'), result.test)
            }
        })
    } finally {
        await driver.close()
    }
})()

SpecDriver for browser extension

Reference implementation can be found here.

SpecDriver for Selenium

Reference implementation can be found here.

Examples

Using selenium-webdriver

const {Builder} = require('selenium-webdriver')
const {makeSDK} = require('@applitools/eyes-sdk-core')
const spec = require('./spec-driver')

const config = {
    appName: 'My app',
    testName: 'My test',
    viewportSize: {width: 1000, height: 800},
    apiKey: '<Your API key>',
};

const sdk = makeSDK({
    name: 'my.special.SDK',
    version: '1.2.3',
    spec,
    VisualGridClient: require('@applitools/visual-grid-client')
})

;(async function main() {
    const driver = await new Builder().forBrowser('chrome').build()
    await driver.get('https://demo.applitools.com')
    const manager = await sdk.makeManager()
    const eyes = await manager.openEyes({driver, config})
    const testResults = await eyes.checkAndClose({settings: {fully: true}})
    console.log(testResults)
})()