Screenshot-tester NPM

screenshot-tester

Take screenshots (= snapshots) of desktop (node) apps (i.e. libui-node) to test for regressions.

An example report generated by screenshot-tester

Usage:

const test = require("screenshot-tester")();

(async function(){
    await test("my_example.js", "The Window Title");
})();

or for native apps:

const test = require("screenshot-tester")({raw: true});

(async function(){
    await test("app", "The Window Title");
})();

This will:

Run node my_example.js or app.
Take a screenshot of the window with the specified title.
Close the app.
Compare with or create a new reference screenshot.

A failed test will generate a diff file, hightlighting the differing areas in red:

─ outDir ('.')
  ├─ reference
  │  └─ my_example.js.png
  └─ tmp
     ├─ my_example.js.png
     └─ my_example.js_diff.png

Reference

const test = require("screenshot-tester")({
        outDir = ".",
        raw = false,
        interactive = false,
        delay = 0,
        accuracy = "0.01%",
        logger = require("screenshot-tester").defaultLogger
    });

async function test(file, title, {delay, raw, delta = 20}){};

function test.generateHTML(){};

async function test.pushToServer(host, repoId, issue, onlyFailed, osAppend) {};

Parameters

`require("screenshot-tester")(...)`

outDir: Optional - The folder in which the screenshots will be saved (see above).
raw: Optional - Set to true to run a binary instead of a node script. It is applied to all following test() calls.
interactive: Optional - Whether to prompt the user if the reference image should be updated if a test failed.
delay: Optional - Additional delay after starting the application (in ms). It is applied to all following test() calls.
accuracy: Optional - The threshold (500 or "500" => 500px, "0.01%" => 0.01%)
logger: Optional - A function to call for logging: function(type, file, error){}. Types: PASSED, FAILED, MISSING, ERROR, REPORT, OS, RETRY, PUSH