html-snapshots 0.19.0 → 1.0.1

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

@@ -4,39 +4,51 @@
  * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global it */
-var path = require("path");
-var fs = require("fs");
-var rimraf = require("rimraf").sync;
-var utils = require("./utils");
-var optHelp = require("../../helpers/options");
-var resHelp = require("../../helpers/result");
-var ss = require("../../../lib/html-snapshots");
-
-// missing destructuring, will write postcard...
-var timeout = utils.timeout;
-var outputDir = utils.outputDir;
-var cleanup = utils.cleanup;
-var unexpectedError = utils.unexpectedError;
-var unexpectedSuccess = utils.unexpectedSuccess;
-var checkActualFiles = utils.checkActualFiles;
-
-var outputBase = path.resolve(outputDir, "..");
-var cookiesFile = path.join(outputBase, "cookies.txt");
+const path = require("path");
+const fs = require("fs");
+const rimraf = require("rimraf").sync;
+const utils = require("./utils");
+const optHelp = require("../../helpers/options");
+const resHelp = require("../../helpers/result");
+const ss = require("../../../lib/html-snapshots");
+
+const {
+  timeout,
+  outputDir,
+  cleanup,
+  unexpectedError,
+  unexpectedSuccess,
+  checkActualFiles
+} = utils;
+
+const outputBase = path.resolve(outputDir, "..");
+const cookiesFile = path.join(outputBase, "cookies.txt");
 
 function phantomjsOptionsTests (options) {
-  var port = options.port;
+  const {
+    port
+  } = options;
+
+  function createOptions (newOptions) {
+    const defaultOptions = {
+      input: "array",
+      source: [ `http://localhost:${port}/pjsopts` ],
+      outputDir,
+      outputDirClean: false,
+      selector: ".content-complete",
+      timeout,
+      browser: "phantomjs",
+      phantomjsOptions: `--cookies-file=${cookiesFile}`
+    }
+    return {
+      ...defaultOptions,
+      ...newOptions
+    };
+  }
 
   return function () {
     it ("should work on first vanilla full invocation, no checks", function (done) {
-      var options = {
-        input: "array",
-        source: [ "http://localhost:"+port+"/pjsopts" ],
-        outputDir: outputDir,
-        outputDirClean: false,
-        selector: ".content-complete",
-        timeout: timeout,
-        phantomjsOptions: "--cookies-file="+cookiesFile
-      };
+      const options = createOptions({});
 
       rimraf(outputBase);
 
@@ -52,25 +64,17 @@ function phantomjsOptionsTests (options) {
     });
 
     it("should work with one string option", function (done) {
-      var options = {
-        input: "array",
-        source: [ "http://localhost:"+port+"/pjsopts" ],
-        outputDir: outputDir,
-        outputDirClean: false,
-        selector: ".content-complete",
-        timeout: timeout,
-        phantomjsOptions: "--cookies-file="+cookiesFile
-      };
+      const options = createOptions({});
 
       rimraf(outputBase);
 
-      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(() => {
-          var assertionError;
+          let assertionError;
           try {
             fs.accessSync(cookiesFile);
           } catch (e) {
@@ -87,28 +91,23 @@ function phantomjsOptionsTests (options) {
     });
 
     it("should work with multiple options, test one", function (done) {
-      var options = {
-        input: "array",
-        source: [ "http://localhost:"+port+"/pjsopts" ],
-        outputDir: outputDir,
-        outputDirClean: false,
+      const options = createOptions({
         selector: "#inline-image",
-        timeout: timeout,
         phantomjsOptions: [
-          "--cookies-file="+cookiesFile,
+          `--cookies-file=${cookiesFile}`,
           "--load-images=true"
         ]
-      };
+      });
 
       rimraf(outputBase);
 
-      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(() => {
-          var assertionError;
+          let assertionError;
           try {
             fs.accessSync(cookiesFile);
           } catch (e) {
@@ -125,25 +124,21 @@ function phantomjsOptionsTests (options) {
     });
 
     it("should work with multiple options, test two", function (done) {
-      var options = {
-        input: "array",
-        source: [ "http://localhost:"+port+"/pjsopts" ],
-        outputDir: outputDir,
-        outputDirClean: false,
+      const options = createOptions({
         selector: "#inline-image",
         timeout: 5000, // this should fail, so don't wait too long.
         phantomjsOptions: [
-          "--cookies-file="+cookiesFile,
+          `--cookies-file=${cookiesFile}`,
           "--load-images=false"
         ]
-      };
+      });
 
       rimraf(outputBase);
 
       ss.run(optHelp.decorate(options))
         .then(unexpectedSuccess.bind(null, done))
         .catch(err => {
-          var assertionError;
+          let assertionError;
           try {
             resHelp.mustBeError(err);
           } catch (e) {
@@ -152,7 +147,6 @@ function phantomjsOptionsTests (options) {
           cleanup(done, assertionError);
         });
     });
-
     // most of these tests use no options, so not testing that again here
   };
 }

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

@@ -25,7 +25,11 @@ const {
 const urls = robotsTests.urlCount;
 
 function processLimitTests (options) {
-  const { port, localRobotsFile: inputFile } = options;
+  const {
+    port,
+    localRobotsFile: inputFile,
+    browsers
+  } = options;
   const pollInterval = 50;
   let phantomCount = 0;
   let timer;
@@ -47,98 +51,102 @@ function processLimitTests (options) {
   }
 
   return function () {
-    it("should limit as expected", function (done) {
-      const processLimit = urls - 1;
-      const complete = completeTest.bind(null, done, processLimit);
-
-      if (process.platform === "win32") {
-        assert.ok(true, "Skipping posix compliant tests for processLimit");
-        done();
-      } else {
-        rimraf(outputDir);
-
-        killSpawnedProcesses(function (err) {
-          const options = {
-            source: inputFile,
-            hostname: "localhost",
-            selector: "#dynamic-content",
-            outputDirClean: true,
-            outputDir,
-            timeout,
-            processLimit,
-            port
-          };
-
-          if (err) {
-            return done(err);
-          }
-
-          ss.run(optHelp.decorate(options))
-            .then(() => {
-              complete();
-            })
-            .catch(e => {
-              complete(e || unexpectedError, e.notCompleted);
-            });
-
-          timer = setInterval(() => {
-            countSpawnedProcesses(function (count) {
-              // console.log("@@@ DEBUG @@@ phantom count: "+count);
-              if (count > processLimit) {
-                phantomCount = count;
-                clearInterval(timer);
-              }
-            });
-          }, pollInterval);
-        });
-      }
-    });
+    browsers.forEach(browser => {
+      it(`should limit as expected - ${browser}`, function (done) {
+        const processLimit = urls - 1;
+        const complete = completeTest.bind(null, done, processLimit);
+
+        if (process.platform === "win32") {
+          assert.ok(true, "Skipping posix compliant tests for processLimit");
+          done();
+        } else {
+          rimraf(outputDir);
+
+          killSpawnedProcesses(function (err) {
+            const options = {
+              source: inputFile,
+              hostname: "localhost",
+              selector: "#dynamic-content",
+              outputDirClean: true,
+              outputDir,
+              timeout,
+              processLimit,
+              port,
+              browser
+            };
+
+            if (err) {
+              return done(err);
+            }
+
+            ss.run(optHelp.decorate(options))
+              .then(() => {
+                complete();
+              })
+              .catch(e => {
+                complete(e || unexpectedError, e.notCompleted);
+              });
+
+            timer = setInterval(() => {
+              countSpawnedProcesses(function (count) {
+                // console.log("@@@ DEBUG @@@ phantom count: "+count);
+                if (count > processLimit) {
+                  phantomCount = count;
+                  clearInterval(timer);
+                }
+              });
+            }, pollInterval);
+          });
+        }
+      });
 
-    it("should limit to just one process", function (done) {
-      const processLimit = 1;
-      const complete = completeTest.bind(null, done, processLimit);
-
-      if (process.platform === "win32") {
-        assert.ok(true, "Skipping posix compliant tests for processLimit");
-        done();
-      } else {
-        rimraf(outputDir);
-
-        killSpawnedProcesses(function (err) {
-          const options = {
-            source: inputFile,
-            hostname: "localhost",
-            selector: "#dynamic-content",
-            outputDirClean: true,
-            outputDir,
-            timeout,
-            processLimit,
-            port
-          };
-
-          if (err) {
-            return done(err);
-          }
-
-          ss.run(optHelp.decorate(options))
-            .then(() => {
-              complete();
-            })
-            .catch(e => {
-              complete(e || unexpectedError, e.notCompleted);
-            });
-
-          timer = setInterval(function () {
-            countSpawnedProcesses(function (count) {
-              // console.log("@@@ DEBUG @@@ phantom count: "+count);
-              if (count > processLimit) {
-                phantomCount = count;
-                clearInterval(timer);
-              }
-            });
-          }, pollInterval);
-        });
-      }
+      it(`should limit to just one process - ${browser}`, function (done) {
+        const processLimit = 1;
+        const complete = completeTest.bind(null, done, processLimit);
+
+        if (process.platform === "win32") {
+          assert.ok(true, "Skipping posix compliant tests for processLimit");
+          done();
+        } else {
+          rimraf(outputDir);
+
+          killSpawnedProcesses(function (err) {
+            const options = {
+              source: inputFile,
+              hostname: "localhost",
+              selector: "#dynamic-content",
+              outputDirClean: true,
+              outputDir,
+              timeout,
+              processLimit,
+              port,
+              browser
+            };
+
+            if (err) {
+              return done(err);
+            }
+
+            ss.run(optHelp.decorate(options))
+              .then(() => {
+                complete();
+              })
+              .catch(e => {
+                complete(e || unexpectedError, e.notCompleted);
+              });
+
+            timer = setInterval(function () {
+              countSpawnedProcesses(function (count) {
+                // console.log("@@@ DEBUG @@@ phantom count: "+count);
+                if (count > processLimit) {
+                  phantomCount = count;
+                  clearInterval(timer);
+                }
+              });
+            }, pollInterval);
+          });
+        }
+      });
     });
   };
 }

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

@@ -0,0 +1,47 @@
+/**
+ * Tests unique to the puppeteer browser.
+ * 
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
+ */
+/* global it */
+const optHelp = require("../../helpers/options");
+const ss = require("../../../lib/html-snapshots");
+const {
+  outputDir,
+  cleanupSuccess,
+  testSuccess
+} = require("./utils");
+
+function puppeteerTests (options) {
+  const {
+    port
+  } = options;
+
+  return function () {
+
+    it("should launch debugger when requested", function (done) {
+      const options = {
+        source: [
+          `http://localhost:${port}/contact`
+        ],
+        outputDir,
+        timeout: 5000,
+        debug: {
+          flag: true,
+          slowMo: 50
+        }
+      };
+
+      const success = testSuccess.bind(null, cleanupSuccess.bind(null, done));
+
+      // TODO: check for headless: false chrome invocation
+      ss.run(optHelp.decorate(options))
+        .then(success)
+        .catch(done);
+    });
+  };
+}
+
+module.exports = {
+  testSuite: puppeteerTests
+};