html-snapshots 0.18.3 → 1.0.0

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

@@ -4,52 +4,96 @@
  * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global it */
-var assert = require("assert");
-var path = require("path");
-var _ = require("lodash");
-var optHelp = require("../../helpers/options");
-var ss = require("../../../lib/html-snapshots");
-var utils = require("./utils");
+const assert = require("assert");
+const path = require("path");
+const _ = require("lodash");
+const optHelp = require("../../helpers/options");
+const ss = require("../../../lib/html-snapshots");
+const utils = require("./utils");
 
 // missing destructuring, will write postcard...
-var outputDir = utils.outputDir;
-var cleanupError = utils.cleanupError;
-var unexpectedSuccess = utils.unexpectedSuccess;
+const {
+  outputDir,
+  cleanup,
+  cleanupError,
+  cleanupSuccess,
+  unexpectedSuccess,
+  testSuccess,
+  checkActualFiles
+} = utils;
 
 // Sitemap constants
-var inputFile = path.join(__dirname, "./test_sitemap.xml");
-var urls = 3; // must match test_sitemap.xml
+const inputFile = path.join(__dirname, "./test_sitemap.xml");
+const urls = 3; // must match public/page_sitemap.xml
 
 function sitemapTests (options) {
-  var port = options.port;
+  const {
+    port,
+    browsers
+  } = options;
 
   return function () {
-    it("should all fail, bad remote sitemap", function (done) {
-      var options = {
+    function createOptions(newOptions) {
+      const defaultOptions = {
         input: "sitemap",
-        source: "http://localhost:"+port+"/index.html",
-        port: port,
+        source: `http://localhost:${port}/index.html`,
         selector: "#dynamic-content",
-        outputDir: outputDir,
         outputDirClean: true,
-        timeout: 6000
+        timeout: 4000,
+        outputDir,
+        port
       };
-      var twice = _.after(2, cleanupError.bind(null, done, 0));
+      return {
+        ...defaultOptions,
+        ...newOptions
+      };
+    }
 
-      ss.run(optHelp.decorate(options), twice)
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(twice);
-    });
+    browsers.forEach(browser => {
+      it(`should all fail, bad remote sitemap - ${browser}`, function (done) {
+        const options = createOptions({
+          browser
+        });
 
-    it("TODO: write failure tests", function (done) {
-      assert.ok(true, "TODO");
-      done();
-    });
+        const twice = _.after(2, cleanupError.bind(null, done, 0));
+
+        ss.run(optHelp.decorate(options), twice)
+          .then(unexpectedSuccess.bind(null, done))
+          .catch(twice);
+      });
 
-    it("TODO: write success tests", function (done) {
-      assert.ok(true, "TODO");
-      done();
-    })
+      it("TODO: write more failure tests", function (done) {
+        assert.ok(true, "TODO");
+        done();
+      });
+
+      it(`should succeed simple case - ${browser}`, function (done) {
+        const options = createOptions({
+          source: `http://localhost:${port}/public/page-sitemap.xml`,
+          browser
+        });
+        
+        const twice = _.after(2, cleanupSuccess.bind(null, done));
+        const success = (err, completed) => {
+          assert.equal(completed.length, urls);
+          testSuccess(twice, completed);
+        };
+
+        ss.run(optHelp.decorate(options), success)
+          .then(success.bind(null, undefined))
+          .catch(e => {
+            checkActualFiles(e.notCompleted)
+              .then(() => {
+                cleanup(done, e);
+              });
+          });
+      });
+
+      it("TODO: write more success tests", function (done) {
+        assert.ok(true, "TODO");
+        done();
+      });
+    });
   };
 }
 

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

@@ -4,194 +4,199 @@
  * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global beforeEach, describe, it */
-// var assert = require("assert");
-var path = require("path");
-var fs = require("fs");
-var _ = require("lodash");
-var rimraf = require("rimraf").sync;
-var utils = require("./utils");
-var optHelp = require("../../helpers/options");
-var ss = require("../../../lib/html-snapshots");
-var inputFile = require("./robots").inputFile;
 
-// missing destructuring, will write postcard...
-var timeout = utils.timeout;
-var outputDir = utils.outputDir;
-var cleanup = utils.cleanup;
-var bogusFile = utils.bogusFile;
-var cleanupError = utils.cleanupError;
-var unexpectedSuccess = utils.unexpectedSuccess;
-var checkActualFiles = utils.checkActualFiles;
+const path = require("path");
+const fs = require("fs");
+const _ = require("lodash");
+const rimraf = require("rimraf").sync;
+const utils = require("./utils");
+const optHelp = require("../../helpers/options");
+const ss = require("../../../lib/html-snapshots");
+
+const {
+  timeout,
+  outputDir,
+  cleanup,
+  bogusFile,
+  cleanupError,
+  unexpectedSuccess,
+  checkActualFiles
+} = utils;
 
 function snapshotScriptTests (options) {
-  var port = options.port;
+  const {
+    localRobotsFile: inputFile,
+    port,
+    browsers
+  } = options;
 
   return function () {
-    var snapshotScriptTests = [
-      {
-        name: "removeScripts",
-        option: {
-          script: "removeScripts"
-        },
-        prove: function (completed, done) {
-          // console.log("@@@ removeScripts prove @@@");
-          var 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 @@@");
-          var content, err;
-          for (var 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 () {
-      var testNumber = 0, snapshotScriptTest, scriptNames = [
-        snapshotScriptTests[testNumber].name,
-        snapshotScriptTests[testNumber + 1].name
-        //, testNumber + 2, etc
-      ];
+      let testNumber = 0, snapshotScriptTest;
+      const scriptNames = snapshotScriptTests.map(test => test.name);
 
       beforeEach(function () {
         snapshotScriptTest = snapshotScriptTests[testNumber++];
       });
 
       function snapshotScriptTestDefinition (done) {
-        var options = {
+        const options = {
           source: inputFile,
           hostname: "localhost",
-          port: port,
           selector: "#dynamic-content",
-          outputDir: outputDir,
           outputDirClean: true,
           timeout: timeout,
-          snapshotScript: snapshotScriptTest.option
+          snapshotScript: snapshotScriptTest.option,
+          browser: snapshotScriptTest.browser,
+          outputDir,
+          port
         };
 
         rimraf(outputDir);
 
         ss.run(optHelp.decorate(options))
-          .then(function (completed) {
-            snapshotScriptTest.prove(completed, function (e) {
+          .then(completed => {
+            snapshotScriptTest.prove(completed, e => {
               cleanup(done, e);
             });
           })
-          .catch(function (err) {
+          .catch(err => {
             checkActualFiles(err.notCompleted)
-              .then(function () {
+              .then(() => {
                 cleanup(done, err);
               });
           });
       }
 
-      scriptNames.forEach(function (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) {
-      var options = {
-        source: inputFile,
-        hostname: "localhost",
-        port: port,
-        selector: "#dynamic-content",
-        outputDir: outputDir,
-        outputDirClean: true,
-        snapshotScript: bogusFile,
-        timeout: 2000
-      };
-      var 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) {
-      var options = {
-        source: inputFile,
-        hostname: "localhost",
-        port: port,
-        selector: "#dynamic-content",
-        outputDir: outputDir,
-        outputDirClean: true,
-        snapshotScript: {
-          script: bogusFile
-        },
-        timeout: 2000
-      };
-      var 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) {
-      var options = {
-        source: inputFile,
-        hostname: "localhost",
-        port: port,
-        selector: "#dynamic-content",
-        outputDir: outputDir,
-        outputDirClean: true,
-        snapshotScript: {
-          script: "customFilter"
-        },
-        timeout: 2000
-      };
-      var 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) {
-      var options = {
-        source: inputFile,
-        hostname: "localhost",
-        port: port,
-        selector: "#dynamic-content",
-        outputDir: outputDir,
-        outputDirClean: true,
-        snapshotScript: {
-          script: "customFilter",
-          module: bogusFile
-        },
-        timeout: 2000
-      };
-      var 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

@@ -4,19 +4,22 @@
  * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global describe, before, after */
-var path = require("path");
-var enableDestroy = require("server-destroy");
+const path = require("path");
+const enableDestroy = require("server-destroy");
 
-var timeout = require("./utils").timeout;
+const { timeout } = require("./utils");
 
-var basics = require("./basics");
-var robots = require("./robots");
-var sitemap = require("./sitemap");
-var sitemapIndex = require("./sitemap-index");
-var processLimit = require("./process-limit");
-var useJQuery = require("./use-jquery");
-var snapshotScripts = require("./snapshot-scripts");
-var phantomJSOptions = require("./phantomjs-options");
+const basics = require("./basics");
+const robots = require("./robots");
+const sitemap = require("./sitemap");
+const sitemapIndex = require("./sitemap-index");
+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");
 
 /**
  * Create a test context with a new server on a port.
@@ -28,10 +31,10 @@ var phantomJSOptions = require("./phantomjs-options");
  * @returns {Function} A test context with server management.
  */
 function serverContext (testSuiteFactory, port) {
-  var server = require("../../server");
+  const server = require("../../server");
 
   return function () {
-    var httpServer;
+    let httpServer;
 
     before(function (done) {
       server.start(path.join(__dirname, "./server"), port,
@@ -53,7 +56,9 @@ function serverContext (testSuiteFactory, port) {
     });
 
     describe("tests", testSuiteFactory({
-      port: port
+      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/test_robots.txt

@@ -9,7 +9,5 @@ Disallow: /vendor/
 Disallow: /fonts/
 Disallow: /images/
 
-Sitemap: http://test.local/sitemap.xml
-
 User-agent: ia_archiver
 Disallow: /