@visual-regression-tracker/agent-codeceptjs

Native integration for CodeceptJS with Visual Regression Tracker

Npm

https://www.npmjs.com/package/@visual-regression-tracker/agent-codeceptjs

Install

Add package

npm install @visual-regression-tracker/agent-codeceptjs

Add helper

Update codeceptjs.conf.js

helpers: {
    VisualRegressionTrackerHelper: {
        require: "@visual-regression-tracker/agent-codeceptjs",

        // URL where backend is running
        // Required
        apiUrl: "http://localhost:4200",

        // Project name or ID
        // Required
        project: "Default project",

        // User apiKey
        // Required
        apiKey: "tXZVHX0EA4YQM1MGDD",

        // Current git branch
        // Required
        branchName: "develop",

        // Log errors instead of throwing exceptions
        // Optional - default false
        enableSoftAssert: true,

        // Unique ID related to one CI build
        // Optional - default null
        ciBuildId: "SOME_UNIQUE_ID",
    },
}

Update TypeScript Definitions

More on this in official COdeceptJS (docs)[https://codecept.io/commands/#typescript-definitions]

npx codeceptjs def

Usage

Setup

I.vrtStart();

Teardown

I.vrtStop();

Assert

// default
I.vrtTrack("Default");

// With additional options
I.vrtTrack("Additional options", {
  os: "windows",
  device: "device",
  browser: "chrome",
  diffTollerancePercent: 1,
  ignoreAreas: [
    {
      x: 10,
      y: 10,
      width: 200,
      height: 200,
    },
  ],
});

Examples

https://github.com/Visual-Regression-Tracker/examples-js