wdio-syngrisi-cucumber-service

WDIO Service for Syngrisi visual tests using Cucumber

Usage no npm install needed!

<script type="module">
  import wdioSyngrisiCucumberService from 'https://cdn.skypack.dev/wdio-syngrisi-cucumber-service';
</script>

README

WDIO Syngrisi Cucumber Service

The service helps integrate WebdriverIO test framework and Syngrisi visual testing tool.

Installation

npm i wdio-syngrisi-cucumber-service

Configuration

In order to use the service with WebdriverIO test runner add these settings to services array:

// wdio.conf.js
export.config = {
  // ...
  services: [
                'syngrisi-cucumber',
                {
                    // syngrisi server endpoint
                    endpoint: `http://localhost:3000/`,
                    // syngrisi API key
                    apikey: process.env['SYNGRISI_API_KEY'] || '',
                    // project name
                    project: 'My Project',
                    // the tested branch
                    branch: 'master',
                    // run name (will be auto generated if not present)
                    runname: process.env['RUN_NAME'],
                    // run name (will be auto generated if not present)
                    runident: process.env['RUN_IDENT'],
                    // tag for visual regression scenarios
                    // for all scenarios with this tag the service will create session on syngrisi
                    // if tag is empty the visual session will be created for all scenarios
                    // tag: '@visual',
                },
            ],
  // ...
};

Usage

After all the preparations, you can use the browser.syngrisiCheck(checkName, imageBuffer) method in which:

  • checkName - the name of the check in Syngrisi
  • imageBuffer - the screenshot image buffer