Code Monkey home page Code Monkey logo

vrt's Introduction

Visual Regression Testing Tool

Install

npm i vrt-tool

Setup VRT

Add VRT scripts to your project package.json file

{
  "scripts": {
    "vrt-init": "vrt-tool init",
    "vrt-setup": "vrt-tool setup",
    "vrt-test": "vrt-tool test",
    "vrt-reports": "vrt-tool reports"
  }
}

Then run

npm run vrt-init

This will create vrt.config.js file and .vrt directory in your project root.

Open the vrt.config.js file and add testing scenarios.

Example:

module.exports = {
    scenarios: [
        {
            name: 'Homepage',
            sourceUrl: 'http://localhost:10008/home',
            testUrl: 'http://localhost:10008/home',
            onPage: async page => {
                await page.waitForTimeout(3000);
            },
        },
    ],
};

onPage callback will receive the page argument which is the Puppeteer's Page class instance.

Running tests

  • Run npm run vrt-setup

    This command will take a screenshot of sourceUrl for each defined scenario.

  • Make changes to sourceUrl page (edit html, etc. )

  • Run npm run vrt-test

    This will take a screenshot of testUrl and compare it with sourceUrl screenshot.

If sourceUrl and testUrl screenshots don't match, a report will be generated.

Reports

Report will be generated each time when sourceUrl and testUrl screenshots don't match.

You can list all reports by running npm run vrt-reports

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.