html-snapshots 0.18.2 → 0.19.0

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

@@ -4,30 +4,30 @@
  * 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 } = options;
 
   return function () {
-    var snapshotScriptTests = [
+    const snapshotScriptTests = [
       {
         name: "removeScripts",
         option: {
@@ -35,7 +35,7 @@ function snapshotScriptTests (options) {
         },
         prove: function (completed, done) {
           // console.log("@@@ removeScripts prove @@@");
-          var content, err;
+          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)) {
@@ -54,8 +54,8 @@ function snapshotScriptTests (options) {
         },
         prove: function (completed, done) {
           // console.log("@@@ customFilter prove @@@");
-          var content, err;
-          for (var i = 0; i < completed.length; i++) {
+          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
@@ -70,7 +70,8 @@ function snapshotScriptTests (options) {
     ];
 
     describe("should succeed for scripts", function () {
-      var testNumber = 0, snapshotScriptTest, scriptNames = [
+      let testNumber = 0, snapshotScriptTest;
+      const scriptNames = [
         snapshotScriptTests[testNumber].name,
         snapshotScriptTests[testNumber + 1].name
         //, testNumber + 2, etc
@@ -81,52 +82,52 @@ function snapshotScriptTests (options) {
       });
 
       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,
+          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 => {
+        it(`snapshot script ${scriptName}`, function (done) {
           setTimeout(snapshotScriptTestDefinition, 3000, done);
         });
       });
     });
 
     it("should fail if a bogus script string is supplied", function (done) {
-      var options = {
+      const options = {
         source: inputFile,
         hostname: "localhost",
-        port: port,
         selector: "#dynamic-content",
-        outputDir: outputDir,
         outputDirClean: true,
         snapshotScript: bogusFile,
-        timeout: 2000
+        timeout: 2000,
+        outputDir,
+        port
       };
-      var twice = _.after(2, cleanupError.bind(null, done, 0));
+      const twice = _.after(2, cleanupError.bind(null, done, 0));
 
       ss.run(optHelp.decorate(options), twice)
         .then(unexpectedSuccess.bind(null, done))
@@ -134,19 +135,19 @@ function snapshotScriptTests (options) {
     });
 
     it("should fail if a bogus script object is supplied", function(done) {
-      var options = {
+      const options = {
         source: inputFile,
         hostname: "localhost",
-        port: port,
         selector: "#dynamic-content",
-        outputDir: outputDir,
         outputDirClean: true,
         snapshotScript: {
           script: bogusFile
         },
-        timeout: 2000
+        timeout: 2000,
+        outputDir,
+        port
       };
-      var twice = _.after(2, cleanupError.bind(null, done, 0));
+      const twice = _.after(2, cleanupError.bind(null, done, 0));
 
       ss.run(optHelp.decorate(options), twice)
         .then(unexpectedSuccess.bind(null, done))
@@ -154,19 +155,19 @@ function snapshotScriptTests (options) {
     });
 
     it("should fail if a customFilter is defined but no module", function(done) {
-      var options = {
+      const options = {
         source: inputFile,
         hostname: "localhost",
-        port: port,
         selector: "#dynamic-content",
-        outputDir: outputDir,
         outputDirClean: true,
         snapshotScript: {
           script: "customFilter"
         },
-        timeout: 2000
+        timeout: 2000,
+        outputDir,
+        port
       };
-      var twice = _.after(2, cleanupError.bind(null, done, 0));
+      const twice = _.after(2, cleanupError.bind(null, done, 0));
 
       ss.run(optHelp.decorate(options), twice)
         .then(unexpectedSuccess.bind(null, done))
@@ -174,20 +175,20 @@ function snapshotScriptTests (options) {
     });
 
     it("should fail if a customFilter is defined and bogus module", function(done) {
-      var options = {
+      const options = {
         source: inputFile,
         hostname: "localhost",
-        port: port,
         selector: "#dynamic-content",
-        outputDir: outputDir,
         outputDirClean: true,
         snapshotScript: {
           script: "customFilter",
           module: bogusFile
         },
-        timeout: 2000
+        timeout: 2000,
+        outputDir,
+        port
       };
-      var twice = _.after(2, cleanupError.bind(null, done, 0));
+      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/test.js

@@ -4,19 +4,21 @@
  * 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").timeout;
 
-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 localRobotsFile = path.join(__dirname, "./test_robots.txt");
 
 /**
  * Create a test context with a new server on a port.
@@ -28,10 +30,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,
@@ -52,9 +54,7 @@ function serverContext (testSuiteFactory, port) {
       });
     });
 
-    describe("tests", testSuiteFactory({
-      port: port
-    }));
+    describe("tests", testSuiteFactory({ port, localRobotsFile }));
   };
 }
 

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: /

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

@@ -3,7 +3,6 @@
  *
  * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
-/* global Promise */
 var path = require("path");
 var fs = require("fs");
 var _ = require("lodash");

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);
-    })
+    });
   });
 });