patrick/KaTeX
1
0
Fork 0
mirror of https://github.com/Smaug123/KaTeX synced 2025-10-05 19:28:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Screenshotter: Add --diff and --attempts options. (#736)

Browse Source 
--diff produces a texcmp-like diff in test/screenshotter/diff.
This commit is contained in:
Eddie Kohler
2017-07-06 08:49:34 -04:00
committed by Kevin Barabash
parent 1704d3b003
commit f43b00b50f
1 changed files with 63 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
dockers/Screenshotter/screenshotter.js
View File

@@ -17,6 +17,8 @@ const data = require("../../test/screenshotter/ss_data");
const dstDir = path.normalize(
path.join(__dirname, "..", "..", "test", "screenshotter", "images"));
const diffDir = path.normalize(
path.join(__dirname, "..", "..", "test", "screenshotter", "diff"));
//////////////////////////////////////////////////////////////////////
// Process command line arguments
@@ -73,6 +75,14 @@ const opts = require("nomnom")
flag: true,
help: "Check whether screenshot matches current file content",
})
.option("diff", {
flag: true,
help: "With `--verify`, produce image diffs when match fails",
})
.option("attempts", {
help: "Retry this many times before reporting failure",
"default": 5,
})
.option("wait", {
help: "Wait this many seconds between page load and screenshot",
})
@@ -271,7 +281,7 @@ function setSize(reqW, reqH) {
findHostIP();
return;
}
if (++attempts > 5) {
if (++attempts > opts.attempts) {
throw new Error("Failed to set window size correctly.");
}
return setSize(targetW + reqW - actualW, targetH + reqH - actualH);
@@ -426,10 +436,13 @@ function takeScreenshot(key) {
if (loadExpected) {
return loadExpected.then(function(expected) {
if (!buf.equals(expected)) {
if (++retry === 5) {
if (++retry >= opts.attempts) {
console.error("FAIL! " + key);
listOfFailed.push(key);
exitStatus = 3;
if (opts.diff) {
return saveScreenshotDiff(key, buf);
}
} else {
console.log("error " + key);
browserSideWait(300 * retry);
@@ -449,6 +462,36 @@ function takeScreenshot(key) {
}
}
function saveScreenshotDiff(key, buf) {
const filenamePrefix = key + "-" + opts.browser;
const baseFile = path.join(dstDir, filenamePrefix + ".png");
const diffFile = path.join(diffDir, filenamePrefix + "-diff.png");
const bufFile = path.join(diffDir, filenamePrefix + "-fail.png");
return promisify(fs.mkdir, diffDir)
.then(null, function() { }) /* Ignore EEXIST error (XXX & others) */
.then(function() {
return promisify(fs.writeFile, bufFile, buf);
})
.then(function() {
return execFile("convert", [
"-fill", "white",
// First image: saved screenshot in red
"(", baseFile, "-colorize", "100,0,0", ")",
// Second image: new screenshot in green
"(", bufFile, "-colorize", "0,80,0", ")",
// Composite them
"-compose", "darken", "-composite",
"-trim", // remove everything with the same color as the
// corners
diffFile, // output file name
]);
})
.then(function() {
return promisify(fs.unlink, bufFile);
});
}
function oneDone() {
if (--countdown === 0) {
if (listOfFailed.length) {
@@ -486,3 +529,21 @@ function promisify(f) {
f.apply(null, args);
return deferred.promise;
}
// Execute a given command, and return a promise to its output.
// Don't denodeify here, since fail branch needs access to stderr.
function execFile(cmd, args, opts) {
const deferred = new selenium.promise.Deferred();
childProcess.execFile(cmd, args, opts, function(err, stdout, stderr) {
if (err) {
console.error("Error executing " + cmd + " " + args.join(" "));
console.error(stdout + stderr);
err.stdout = stdout;
err.stderr = stderr;
deferred.reject(err);
} else {
deferred.fulfill(stdout);
}
});
return deferred.promise;
}