html-snapshots 0.19.0 → 1.0.1

package/test/mocha/html-snapshots/snapshot-scripts.js

@@ -24,58 +24,75 @@ const {
 } = utils;
 
 function snapshotScriptTests (options) {
-  const { localRobotsFile: inputFile, port } = options;
+  const {
+    localRobotsFile: inputFile,
+    port,
+    browsers
+  } = options;
 
   return function () {
-    const snapshotScriptTests = [
-      {
-        name: "removeScripts",
-        option: {
-          script: "removeScripts"
-        },
-        prove: function (completed, done) {
-          // console.log("@@@ removeScripts prove @@@");
-          let content, err;
-          for (var i = 0; i < completed.length; i++) {
-            content = fs.readFileSync(completed[i], { encoding: "utf8" });
-            if (/<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi.test(content)) {
-              err = new Error("removeScripts failed. Script tag found in "+completed[i]);
-              break;
-            }
+    const removeScriptsConfig = {
+      name: "removeScripts",
+      option: {
+        script: "removeScripts"
+      },
+      browser: "phantomjs",
+      prove: (completed, done) => {
+        // console.log("@@@ removeScripts prove @@@");
+        let content, err;
+        for (var i = 0; i < completed.length; i++) {
+          content = fs.readFileSync(completed[i], { encoding: "utf8" });
+          if (/<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi.test(content)) {
+            err = new Error("removeScripts failed. Script tag found in "+completed[i]);
+            break;
           }
-          done(err);
         }
+        done(err);
+      }
+    };
+    const customFilterConfig = {
+      name: "customFilter",
+      option: {
+        script: "customFilter",
+        module: path.join(__dirname, "myFilter.js")
       },
-      {
-        name: "customFilter",
-        option: {
-          script: "customFilter",
-          module: path.join(__dirname, "myFilter.js")
-        },
-        prove: function (completed, done) {
-          // console.log("@@@ customFilter prove @@@");
-          let content, err;
-          for (let i = 0; i < completed.length; i++) {
-            // console.log("@@@ readFile "+completed[i]);
-            content = fs.readFileSync(completed[i], { encoding: "utf8" });
-            // this is dependent on myFilter.js adding someattrZZQy anywhere
-            if (content.indexOf("someattrZZQy") < 0) {
-              err = new Error("customFilter snapshotScript failed. Special sequence not found in "+completed[i]);
-              break;
-            }
+      browser: "phantomjs",
+      prove: (completed, done) => {
+        // console.log("@@@ customFilter prove @@@");
+        let content, err;
+        for (let i = 0; i < completed.length; i++) {
+          // console.log("@@@ readFile "+completed[i]);
+          content = fs.readFileSync(completed[i], { encoding: "utf8" });
+          // this is dependent on myFilter.js adding someattrZZQy anywhere
+          if (content.indexOf("someattrZZQy") < 0) {
+            err = new Error("customFilter snapshotScript failed. Special sequence not found in "+completed[i]);
+            break;
           }
-          done(err);
         }
+        done(err);
       }
-    ];
-
+    };
+    const snapshotScriptTests = [];
+    browsers.forEach(browser => {
+      snapshotScriptTests.push({
+        ...removeScriptsConfig,
+        ...{
+          name: `${removeScriptsConfig.name}-${browser}`,
+          browser
+        }
+      });
+      snapshotScriptTests.push({
+        ...customFilterConfig,
+        ...{
+          name: `${customFilterConfig.name}-${browser}`,
+          browser
+        }
+      });
+    });
+    
     describe("should succeed for scripts", function () {
       let testNumber = 0, snapshotScriptTest;
-      const scriptNames = [
-        snapshotScriptTests[testNumber].name,
-        snapshotScriptTests[testNumber + 1].name
-        //, testNumber + 2, etc
-      ];
+      const scriptNames = snapshotScriptTests.map(test => test.name);
 
       beforeEach(function () {
         snapshotScriptTest = snapshotScriptTests[testNumber++];
@@ -89,6 +106,7 @@ function snapshotScriptTests (options) {
           outputDirClean: true,
           timeout: timeout,
           snapshotScript: snapshotScriptTest.option,
+          browser: snapshotScriptTest.browser,
           outputDir,
           port
         };
@@ -109,90 +127,76 @@ function snapshotScriptTests (options) {
           });
       }
 
-      scriptNames.forEach(scriptName => {
-        it(`snapshot script ${scriptName}`, function (done) {
+      scriptNames.forEach((scriptName, i) => {
+        it(`snapshot script ${scriptName}, ${snapshotScriptTests[i].browser}`, function (done) {
           setTimeout(snapshotScriptTestDefinition, 3000, done);
         });
       });
     });
 
-    it("should fail if a bogus script string is supplied", function (done) {
-      const options = {
-        source: inputFile,
-        hostname: "localhost",
-        selector: "#dynamic-content",
-        outputDirClean: true,
-        snapshotScript: bogusFile,
-        timeout: 2000,
-        outputDir,
-        port
-      };
-      const twice = _.after(2, cleanupError.bind(null, done, 0));
-
-      ss.run(optHelp.decorate(options), twice)
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(twice);
-    });
-
-    it("should fail if a bogus script object is supplied", function(done) {
-      const options = {
-        source: inputFile,
-        hostname: "localhost",
-        selector: "#dynamic-content",
-        outputDirClean: true,
-        snapshotScript: {
-          script: bogusFile
-        },
-        timeout: 2000,
-        outputDir,
-        port
-      };
-      const twice = _.after(2, cleanupError.bind(null, done, 0));
-
-      ss.run(optHelp.decorate(options), twice)
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(twice);
-    });
-
-    it("should fail if a customFilter is defined but no module", function(done) {
-      const options = {
-        source: inputFile,
-        hostname: "localhost",
-        selector: "#dynamic-content",
-        outputDirClean: true,
-        snapshotScript: {
-          script: "customFilter"
-        },
-        timeout: 2000,
-        outputDir,
-        port
-      };
-      const twice = _.after(2, cleanupError.bind(null, done, 0));
-
-      ss.run(optHelp.decorate(options), twice)
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(twice);
-    });
-
-    it("should fail if a customFilter is defined and bogus module", function(done) {
-      const options = {
-        source: inputFile,
-        hostname: "localhost",
-        selector: "#dynamic-content",
-        outputDirClean: true,
-        snapshotScript: {
-          script: "customFilter",
-          module: bogusFile
-        },
-        timeout: 2000,
-        outputDir,
-        port
-      };
-      const twice = _.after(2, cleanupError.bind(null, done, 0));
+    describe("should fail for scripts", function () {
+      function createOptions (newOptions) {
+        const defaultOptions = {
+          source: inputFile,
+          hostname: "localhost",
+          selector: "#dynamic-content",
+          outputDirClean: true,
+          snapshotScript: bogusFile,
+          timeout: 2000,
+          outputDir,
+          port
+        };
+        return {
+          ...defaultOptions,
+          ...newOptions
+        };
+      }
 
-      ss.run(optHelp.decorate(options), twice)
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(twice);
+      const testOptions = [{
+        name: "should fail if a bogus script string is supplied",
+        options: {
+          snapshotScript: bogusFile
+        }
+      }, {
+        name: "should fail if a bogus script object is supplied",
+        options: {
+          snapshotScript: {
+            script: bogusFile
+          }
+        }
+      }, {
+        name: "should fail if a customFilter is defined but no module",
+        options: {
+          snapshotScript: {
+            script: "customFilter"
+          }
+        }
+      }, {
+        name: "should fail if a customFilter is defined and bogus module",
+        options: {
+          browser: "phantomjs",
+          snapshotScript: {
+            script: "customFilter",
+            module: bogusFile
+          }
+        }
+      }];
+      const driverOptions = browsers.map(browser => {
+        return testOptions.map(test => {
+          test.options.browser = browser;
+          return JSON.parse(JSON.stringify(test));
+        });
+      }).flat();
+
+      driverOptions.forEach(driver => {
+        it(driver.name, function (done) {
+          const options = createOptions(driver.options);
+          const twice = _.after(2, cleanupError.bind(null, done, 0));
+          ss.run(optHelp.decorate(options), twice)
+            .then(unexpectedSuccess.bind(null, done))
+            .catch(twice);
+        });
+      });
     });
   };
 }

package/test/mocha/html-snapshots/test.js

@@ -7,7 +7,7 @@
 const path = require("path");
 const enableDestroy = require("server-destroy");
 
-const timeout = require("./utils").timeout;
+const { timeout } = require("./utils");
 
 const basics = require("./basics");
 const robots = require("./robots");
@@ -17,6 +17,7 @@ const processLimit = require("./process-limit");
 const useJQuery = require("./use-jquery");
 const snapshotScripts = require("./snapshot-scripts");
 const phantomJSOptions = require("./phantomjs-options");
+const puppeteer = require("./puppeteer");
 
 const localRobotsFile = path.join(__dirname, "./test_robots.txt");
 
@@ -54,7 +55,11 @@ function serverContext (testSuiteFactory, port) {
       });
     });
 
-    describe("tests", testSuiteFactory({ port, localRobotsFile }));
+    describe("tests", testSuiteFactory({
+      port,
+      localRobotsFile,
+      browsers: ["phantomjs", "puppeteer"]
+    }));
   };
 }
 
@@ -68,6 +73,10 @@ describe("html-snapshots", function () {
     "phantomjsOptions option", serverContext(phantomJSOptions.testSuite, 8035)
   );
 
+  describe(
+    "puppeteer specific tests", serverContext(puppeteer.testSuite, 8042)
+  );
+
   describe(
     "additional snapshot scripts", serverContext(snapshotScripts.testSuite, 8036)
   );

package/test/mocha/html-snapshots/use-jquery.js

@@ -4,48 +4,61 @@
  * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global it */
-var assert = require("assert");
-var path = require("path");
-var _ = require("lodash");
-var utils = require("./utils");
-var optHelp = require("../../helpers/options");
-var ss = require("../../../lib/html-snapshots");
-
-// missing destructuring, will write postcard...
-var timeout = utils.timeout;
-var outputDir = utils.outputDir;
-var cleanup = utils.cleanup;
-var cleanupError = utils.cleanupError;
-var unexpectedError = utils.unexpectedError;
-var unexpectedSuccess = utils.unexpectedSuccess;
-var checkActualFiles = utils.checkActualFiles;
-
-var useJQOutputDir = path.resolve(outputDir, "..", "useJQuery");
+const assert = require("assert");
+const path = require("path");
+const _ = require("lodash");
+const utils = require("./utils");
+const optHelp = require("../../helpers/options");
+const ss = require("../../../lib/html-snapshots");
+
+const {
+  timeout,
+  outputDir,
+  cleanup,
+  cleanupError,
+  unexpectedError,
+  unexpectedSuccess,
+  checkActualFiles
+} = utils;
+
+const useJQOutputDir = path.resolve(outputDir, "..", "useJQuery");
 
 function useJQueryTests (options) {
-  var port = options.port;
+  const {
+    port
+  } = options;
+
+  function createOptions (newOptions) {
+    const defaultOptions = {
+      input: "array",
+      source: [ `http://localhost:${port}/nojq` ],
+      selector: ".nojq-dynamic",
+      outputDir: useJQOutputDir,
+      outputDirClean: true,
+      browser: "phantomjs",
+      timeout,
+      useJQuery: true
+    };
+    return {
+      ...defaultOptions,
+      ...newOptions
+    };
+  }
 
   return function () {
     it("should succeed if useJQuery=false, jQuery NOT loaded, dynamic element",
     function (done) {
-      var options = {
-        input: "array",
-        source: [ "http://localhost:"+port+"/nojq" ],
-        selector: ".nojq-dynamic", // nojq-dynamic is created onload
-        //selector: "#pocs1",
-        outputDir: useJQOutputDir,
-        outputDirClean: true,
-        timeout: timeout,
+      const options = createOptions({
         useJQuery: false
-      };
+      });
 
-      ss.run(optHelp.decorate(options), function (err, completed) {
+      ss.run(optHelp.decorate(options), (err, completed) => {
         if (err) {
-          console.log('@@@ error = '+err+", completed="+completed.join(','));
+          console.log(`@@@ error = ${err}, completed=${completed.join(',')}`);
         }
       })
-        .then(function (completed) {
-          var assertionError;
+        .then(completed => {
+          let assertionError;
           try {
             assert.equal(completed.length, 1);
             assert.equal(completed[0], path.join(useJQOutputDir, "nojq", "index.html"));
@@ -54,31 +67,27 @@ function useJQueryTests (options) {
           }
           cleanup(done, assertionError);
         })
-        .catch(function (e) {
+        .catch(e => {
           checkActualFiles(e.notCompleted)
-            .then(function () {
+            .then(() => {
               cleanup(done, e || unexpectedError);
             });
         });
     });
 
     it("should succeed if useJQuery=true, jQuery loaded", function (done) {
-      var options = {
-        input: "array",
-        source: [ "http://localhost:"+port+"/" ],
+      const options = createOptions({
+        source: [ `http://localhost:${port}/` ],
         selector: "#dynamic-content",
-        outputDir: outputDir,
-        outputDirClean: true,
-        timeout: timeout,
-        useJQuery: true
-      };
+        outputDir
+      });
 
-      ss.run(optHelp.decorate(options), function (err, completed) {
+      ss.run(optHelp.decorate(options), (err, completed) => {
         if (err) {
-          console.log('@@@ error = '+err+", completed="+completed.join(','));
+          console.log(`@@@ error = ${err}, completed=${completed.join(',')}`);
         }
       })
-        .then(function (completed) {
+        .then(completed => {
           var assertionError;
           try {
             assert.equal(completed.length, 1);
@@ -88,9 +97,9 @@ function useJQueryTests (options) {
           }
           cleanup(done, assertionError);
         })
-        .catch(function (e) {
+        .catch(e => {
           checkActualFiles(e.notCompleted)
-            .then(function () {
+            .then(() => {
               cleanup(done, e || unexpectedError);
             });
         });
@@ -98,16 +107,12 @@ function useJQueryTests (options) {
 
     it("should fail if useJQuery is true and no jQuery loads in target page",
     function (done) {
-      var options = {
-        input: "array",
-        source: [ "http://localhost:"+port+"/nojq" ],
+      const options = createOptions({
         selector: "#pocs1",
-        outputDir: useJQOutputDir,
-        outputDirClean: true,
-        timeout: 5000,
-        useJQuery: true
-      };
-      var twice = _.after(2, cleanupError.bind(null, done, 0));
+        timeout: 4000
+      });
+
+      const twice = _.after(2, cleanupError.bind(null, done, 0));
 
       ss.run(optHelp.decorate(options), twice)
         .then(unexpectedSuccess.bind(null, done))
@@ -116,16 +121,12 @@ function useJQueryTests (options) {
 
     it("should fail if useJQuery is false, no jQuery loads in page, BUT the element is not visible",
     function (done) {
-      var options = {
-        input: "array",
-        source: [ "http://localhost:"+port+"/nojq" ],
+      const options = createOptions({
         selector: ".nojq-notvisible",
-        outputDir: useJQOutputDir,
-        outputDirClean: true,
-        timeout: 5000,
-        useJQuery: true
-      };
-      var twice = _.after(2, cleanupError.bind(null, done, 0));
+        timeout: 4000
+      });
+
+      const twice = _.after(2, cleanupError.bind(null, done, 0));
 
       ss.run(optHelp.decorate(options), twice)
         .then(unexpectedSuccess.bind(null, done))

package/test/mocha/html-snapshots/utils.js

@@ -1,28 +1,28 @@
 /**
- * html-snapshots test utilities and constants.
+ * html-snapshots test debug utilities and constants.
  *
  * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
-var path = require("path");
-var fs = require("fs");
-var _ = require("lodash");
-var spawn = require("child_process").spawn;
-var assert = require("assert");
-var combineErrors = require("combine-errors");
-var resHelp = require("../../helpers/result");
-var pathExists = require("../../../lib/async/exists");
+const path = require("path");
+const fs = require("fs");
+const _ = require("lodash");
+const spawn = require("child_process").spawn;
+const assert = require("assert");
+const combineErrors = require("combine-errors");
+const resHelp = require("../../helpers/result");
+const pathExists = require("../../../lib/async/exists");
 
 // Constants
-var unexpectedError = new Error("unexpected error flow");
-var outputDir = path.join(__dirname, "./tmp/snapshots");
-var spawnedProcessPattern = "^phantomjs$";
-var bogusFile = "./bogus/file.txt";
-var timeout = 40000;
+const unexpectedError = new Error("unexpected error flow");
+const outputDir = path.join(__dirname, "./tmp/snapshots");
+const spawnedProcessPattern = "^phantomjs$";
+const bogusFile = "./bogus/file.txt";
+const timeout = 20000;
 
 function dumpTree (p) {
-  fs.readdirSync(p).forEach(function (file) {
-    var curPath = path.join(p, path.sep, file);
-    var stats = fs.statSync(curPath);
+  fs.readdirSync(p).forEach(file => {
+    const curPath = path.join(p, path.sep, file);
+    const stats = fs.statSync(curPath);
 
     if (stats.isDirectory()) {
       dumpTree(curPath);
@@ -33,7 +33,7 @@ function dumpTree (p) {
 }
 
 function checkActualFiles (files) {
-  var shortFile, outputRoot;
+  let shortFile, outputRoot;
 
   if (files.length > 0) {
     shortFile = outputDir;
@@ -45,7 +45,7 @@ function checkActualFiles (files) {
       return prev;
     }, files[0]);
     */
-    var exists = false;
+    let exists = false; // toggle to dumpTree
     outputRoot = path.dirname(shortFile);
     try {
       fs.statSync(outputRoot).isDirectory();
@@ -58,9 +58,9 @@ function checkActualFiles (files) {
     }
   }
 
-  return Promise.all(files.map(function (file) {
+  return Promise.all(files.map(file => {
     return pathExists(file)
-      .then(function (result) {
+      .then(result => {
         if (result) {
           console.log("@@@ actually exists:" + file);
         }
@@ -92,10 +92,10 @@ function countSpawnedProcesses (cb) {
   if (process.platform === "darwin") {
     wc = spawn("wc", ["-l"]);
     pgrep = spawn("pgrep", [spawnedProcessPattern]);
-    pgrep.stdout.on("data", function (data) {
+    pgrep.stdout.on("data", data => {
       wc.stdin.write(data);
     });
-    pgrep.stdout.on("end", function () {
+    pgrep.stdout.on("end", () => {
       wc.stdin.end();
     });
     wc.stdout.on("data", cb);
@@ -105,16 +105,16 @@ function countSpawnedProcesses (cb) {
   }
 }
 
-// Clear any lingering phantomjs processes in play
+// Clear any lingering browser processes in play
 function killSpawnedProcesses (cb) {
   var pkill = spawn("pkill", [spawnedProcessPattern]);
   var guardedCb = _.once(cb);
 
-  pkill.on("exit", function () {
+  pkill.on("exit", () => {
     setTimeout(guardedCb, 2000);
   });
-  pkill.on("error", function () {
-    guardedCb(new Error("failed to kill phantomjs processes"));
+  pkill.on("error", () => {
+    guardedCb(new Error("failed to kill browser processes"));
   });
 }
 
@@ -123,8 +123,8 @@ function cleanup (done, arg) {
   if (process.platform === "win32") {
     setTimeout(done, 1000, arg);
   } else {
-    setImmediate(function () {
-      killSpawnedProcesses(function (err) {
+    setImmediate(() => {
+      killSpawnedProcesses(err => {
         done(multiError(err, arg));
       });
     });

package/examples/utils/index.js

@@ -1,25 +0,0 @@
-/**
- * Utilities for the examples.
- * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
- */
-const spawn = require('child_process').spawn;
-
-function cleanupAndExit (failure) {
-  var pkill;
-
-  if (failure) {
-    if (process.platform === 'win32') {
-      process.exit(0);
-    } else {
-      // kill any lingering phantomjs processes
-      pkill = spawn('pkill', ['^phantomjs$']);
-      pkill.on('exit', function () {
-        process.exit(0);
-      });
-    }
-  }
-}
-
-module.exports = {
-  cleanupAndExit
-};