html-snapshots 0.18.3 → 1.0.0

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,29 +1,28 @@
 /**
- * html-snapshots test utilities and constants.
+ * html-snapshots test debug utilities and constants.
  *
  * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
-/* global Promise */
-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);
@@ -34,7 +33,7 @@ function dumpTree (p) {
 }
 
 function checkActualFiles (files) {
-  var shortFile, outputRoot;
+  let shortFile, outputRoot;
 
   if (files.length > 0) {
     shortFile = outputDir;
@@ -46,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();
@@ -59,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);
         }
@@ -93,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);
@@ -106,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"));
   });
 }
 
@@ -124,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/test/mocha/input-generators/server/test_robots.txt

@@ -11,7 +11,5 @@ Disallow: /vendor/
 Disallow: /fonts/
 Disallow: /images/
 
-Sitemap: http://northstarcleaningme.com/sitemap.xml
-
 User-agent: ia_archiver
 Disallow: /

package/test/mocha/input-generators/server/test_robots_bad.txt

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

package/test/mocha/input-generators/server/test_robots_sitemap.txt

@@ -0,0 +1,17 @@
+User-agent: *
+
+Allow: /
+Allow: /contact
+Allow: /services/carpets
+Allow: /services/test?arg=one
+Allow: /services/#hash
+
+Disallow: /api/
+Disallow: /vendor/
+Disallow: /fonts/
+Disallow: /images/
+
+Sitemap: http://localhost:8033/test_sitemap.xml
+
+User-agent: ia_archiver
+Disallow: /

package/test/mocha/input-generators/server/test_robots_sitemap_bad.txt

@@ -0,0 +1,17 @@
+User-agent: *
+
+Allow: /
+Allow: /contact
+Allow: /services/carpets
+Allow: /services/test?arg=one
+Allow: /services/#hash
+
+Disallow: /api/
+Disallow: /vendor/
+Disallow: /fonts/
+Disallow: /images/
+
+Sitemap: http://badhost.nowhere/sitemap.xml
+
+User-agent: ia_archiver
+Disallow: /

package/test/mocha/input-generators/server/test_robots_sitemap_multi.txt

@@ -0,0 +1,18 @@
+User-agent: *
+
+Allow: /
+Allow: /contact
+Allow: /services/carpets
+Allow: /services/test?arg=one
+Allow: /services/#hash
+
+Disallow: /api/
+Disallow: /vendor/
+Disallow: /fonts/
+Disallow: /images/
+
+Sitemap: http://localhost:8033/test_sitemap.xml
+Sitemap: http://localhost:8033/test_sitemap_index.xml
+
+User-agent: ia_archiver
+Disallow: /

package/test/mocha/input-generators/server/test_sitemap_index_empty.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?><?xml-stylesheet type="text/xsl" href="//core.codekraft.it/public/wordpress/main-sitemap.xsl"?>
+<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+</sitemapindex>

package/test/mocha/input-generators/server/test_sitemap_index_malformed.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?><?xml-stylesheet type="text/xsl" href="//core.codekraft.it/public/wordpress/main-sitemap.xsl"?>
+</sitemapindex>

package/test/mocha/input-generators/sitemap-index.js

@@ -4,14 +4,13 @@
  * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global describe, it, before */
-var assert = require("assert");
-// var path = require("path");
-// var rimraf = require("rimraf").sync;
-// var factory = require("../../../lib/input-generators");
-// var server = require("../../server");
-// var options = require("../../helpers/options");
+const assert = require("assert");
+const path = require("path");
+const factory = require("../../../lib/input-generators");
+const server = require("../../server");
+const options = require("../../helpers/options");
 // var smHelper = require("../../helpers/sitemap");
-// var port = 9334;
+const port = 9334;
 
 describe("input-generator", function () {
 
@@ -19,13 +18,70 @@ describe("input-generator", function () {
   // This is just about specific sitemap index option processing
 
   describe("sitemap-index", function () {
+    let gen;
+    const outputDir = path.join(__dirname, "snapshots");
+
+    function createOptions (overrideOptions) {
+      const basicOptions = {
+        input: "sitemap-index",
+        outputDirClean: true,
+        outputDir,
+        port
+      };
+      return {
+        ...basicOptions,
+        ...overrideOptions
+      };
+    }
+
+    function fail (done, message) {
+      const msg = message.toString();
+      assert.fail(msg);
+      done(new Error(msg));
+    }
 
     before(function () {
-      // server.start(path.join(__dirname, "./server"), port);
+      server.start(path.join(__dirname, "./server"), port);
+      gen = factory.create("sitemap-index");
+    });
+
+    it("should handle empty sitemap-index", function (done) {
+      const source = `http://localhost:${port}/test_sitemap_index_empty.xml`;
+      const opts = createOptions({
+        source,
+        _abort: err => {
+          const msg = `empty sitemap-index should not abort, ${err}`;
+          fail(done, msg);
+        }
+      });
+
+      const result = gen.run(options.decorate(opts), () => {
+        fail(done, "empty sitemap-index should not produce input");
+      });
+
+      result.then(() => done()).catch(fail.bind(null, done));
+    });
+
+    it("should handle malformed sitemap-index", function (done) {
+      const source = `http://localhost:${port}/test_sitemap_index_malformed.xml`;
+      const opts = createOptions({
+        source,
+        _abort: err => {
+          assert.equal(true, !!err, `${source} should have aborted with error`);
+          done();
+        }
+      });
+
+      const result = gen.run(
+        options.decorate(opts),
+        fail.bind(null, done, `Input handler was called unexpectedly for badSource: ${source}`)
+      );
+
+      result.then(() => assert.ok(true)).catch(fail.bind(null, done));
     });
 
     it("TODO: write specific sitemap-index tests", function () {
       assert.ok(true);
-    })
+    });
   });
 });