html-snapshots 0.18.2 → 0.19.0

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

@@ -4,156 +4,174 @@
  * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global it */
-var path = require("path");
-var rimraf = require("rimraf").sync;
-var _ = require("lodash");
-var optHelp = require("../../helpers/options");
-var ss = require("../../../lib/html-snapshots");
-var utils = require("./utils");
-
-// missing destructuring, will write postcard...
-var timeout = utils.timeout;
-var outputDir = utils.outputDir;
-var cleanup = utils.cleanup;
-var cleanupSuccess = utils.cleanupSuccess;
-var cleanupError = utils.cleanupError;
-var testSuccess = utils.testSuccess;
-var bogusFile = utils.bogusFile;
-var unexpectedSuccess = utils.unexpectedSuccess;
-var checkActualFiles = utils.checkActualFiles;
-
-// Robots constants
-var inputFile = path.join(__dirname, "./test_robots.txt");
-var urls = 3; // must match test_robots.txt
+const rimraf = require("rimraf").sync;
+const _ = require("lodash");
+const common = require("../../../lib/common");
+const optHelp = require("../../helpers/options");
+const ss = require("../../../lib/html-snapshots");
+const utils = require("./utils");
+
+const {
+  timeout,
+  outputDir,
+  cleanup,
+  cleanupSuccess,
+  cleanupError,
+  testSuccess,
+  bogusFile,
+  unexpectedSuccess,
+  checkActualFiles  
+} = utils;
+
+const urls = 3; // must match url # in robots files test fixtures.
 
 /**
  * The robots test suite.
  */
 function robotsTests (options) {
-  var port = options.port;
+  const { port, localRobotsFile } = options;
 
-  return function () {
-    it("should all succeed, no output dir pre-exists", function (done) {
-      var options = {
-        source: inputFile,
-        hostname: "localhost",
-        port: port,
-        selector: "#dynamic-content",
-        outputDir: outputDir,
-        outputDirClean: true,
-        timeout: timeout
-      };
-      var twice = _.after(2, cleanupSuccess.bind(null, done));
-
-      rimraf(outputDir);
-
-      ss.run(optHelp.decorate(options), twice)
-        .then(testSuccess.bind(null, twice))
-        .catch(function (e) {
-          checkActualFiles(e.notCompleted)
-            .then(function () {
-              cleanup(done, e);
-            });
-        });
-    });
-
-    it("should all succeed, output dir does pre-exist", function (done) {
-      var options = {
-        source: inputFile,
-        hostname: "localhost",
-        port: port,
-        selector: "#dynamic-content",
-        outputDir: outputDir,
-        outputDirClean: true,
-        timeout: timeout
-      };
-      var twice = _.after(2, cleanupSuccess.bind(null, done));
-
-      ss.run(optHelp.decorate(options), twice)
-        .then(testSuccess.bind(null, twice))
-        .catch(function (e) {
-          checkActualFiles(e.notCompleted)
-            .then(function () {
-              cleanup(done, e);
-            });
-        });
-    });
-
-    it("should all fail with bad phantomjs process to spawn",
-    function (done) {
-      var options = {
-        source: inputFile,
-        hostname: "localhost",
-        port: port,
-        selector: "#dynamic-content",
-        outputDir: outputDir,
-        outputDirClean: true,
-        phantomjs: bogusFile,
-        timeout: 1000
-      };
-      var twice = _.after(2, cleanupError.bind(null, done, 0));
-
-      ss.run(options, twice)
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(twice);
-    });
+  // Robots.txt fixtures
+  const inputFiles = [
+    localRobotsFile,
+    `http://localhost:${port}/test_robots.txt`,
+    `http://localhost:${port}/test_robots_sitemap.txt`
+  ];
 
-    it("should all fail, bad remote robots", function (done) {
-      var options = {
-        input: "robots",
-        source: "http://localhost:"+port+"/index.html",
-        port: port,
-        selector: "#dynamic-content",
-        outputDir: outputDir,
-        outputDirClean: true,
-        timeout: 6000
-      };
-      var twice = _.after(2, cleanupError.bind(null, done, 0));
-
-      ss.run(optHelp.decorate(options), twice)
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(twice);
-    });
-
-    it("should all fail, non-existent selector", function (done) {
-      var options = {
-        source: inputFile,
-        hostname: "localhost",
-        port: port,
-        selector: "#dynamic-content-notexist",
-        outputDir: outputDir,
-        outputDirClean: true,
-        timeout: 6000
-      };
-      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 one snapshot, one non-existent selector",
-    function (done) {
-      var options = {
-        source: inputFile,
-        hostname: "localhost",
-        port: port,
-        selector: { "__default": "#dynamic-content", "/": "#dynamic-content-notexist" },
-        outputDir: outputDir,
-        outputDirClean: true,
-        timeout: 6000
-      };
-      var twice = _.after(2, cleanupError.bind(null, done, urls - 1));
-
-      ss.run(optHelp.decorate(options), twice)
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(twice);
+  return function () {
+    inputFiles.forEach(inputFile => {
+      it(`should succeed, no output dir pre-exists, ${inputFile}`, function (done) {
+        const options = {
+          source: inputFile,
+          hostname: "localhost",
+          selector: "#dynamic-content",
+          outputDirClean: true,
+          outputDir,
+          timeout,
+          port
+        };
+        const twice = _.after(2, cleanupSuccess.bind(null, done));
+
+        rimraf(outputDir);
+
+        ss.run(optHelp.decorate(options), twice)
+          .then(testSuccess.bind(null, twice))
+          .catch(e => {
+            checkActualFiles(e.notCompleted)
+              .then(() => {
+                cleanup(done, e);
+              });
+          });
+      });
+
+      it(`should succeed, output dir does pre-exist, ${inputFile}`, function (done) {
+        const options = {
+          source: inputFile,
+          hostname: "localhost",
+          selector: "#dynamic-content",
+          outputDirClean: true,
+          outputDir,
+          timeout,
+          port
+        };
+        const twice = _.after(2, cleanupSuccess.bind(null, done));
+
+        ss.run(optHelp.decorate(options), twice)
+          .then(testSuccess.bind(null, twice))
+          .catch(e => {
+            checkActualFiles(e.notCompleted)
+              .then(() => {
+                cleanup(done, e);
+              });
+          });
+      });
+
+      it(`should fail with bad phantomjs process to spawn, ${inputFile}`,
+        function (done) {
+        const options = {
+          source: inputFile,
+          hostname: "localhost",
+          selector: "#dynamic-content",
+          outputDirClean: true,
+          phantomjs: bogusFile,
+          timeout: 1000,
+          outputDir,
+          port
+        };
+        const twice = _.after(2, cleanupError.bind(null, done, 0));
+
+        ss.run(options, twice)
+          .then(unexpectedSuccess.bind(null, done))
+          .catch(twice);
+      });
+
+      it(`should fail, bad remote robots, ${inputFile}`, function (done) {
+        const options = {
+          input: "robots",
+          source: `http://localhost:${port}/index.html`,
+          selector: "#dynamic-content",
+          outputDirClean: true,
+          timeout: 6000,
+          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, non-existent selector, ${inputFile}`, function (done) {
+        const options = {
+          source: inputFile,
+          hostname: "localhost",
+          selector: "#dynamic-content-notexist",
+          outputDirClean: true,
+          timeout: 6000,
+          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 one snapshot, one non-existent selector, ${inputFile}`, function (done) {
+        let exceptionUrl = "/";
+        if (common.isUrl(inputFile)) {
+          // assume the origin of the inputFile is the same as the contents of the remote urls within it.
+          const url = new URL(inputFile);
+          const isSitemap = url.pathname.includes('sitemap');
+          if (isSitemap) {
+            exceptionUrl = `${url.origin}${exceptionUrl}`;
+          }
+        }
+        const options = {
+          source: inputFile,
+          hostname: "localhost",
+          selector: {
+            "__default": "#dynamic-content",
+            [exceptionUrl]: "#dynamic-content-notexist"
+          },
+          outputDirClean: true,
+          timeout: 6000,
+          outputDir,
+          port
+        };
+        const twice = _.after(2, cleanupError.bind(null, done, urls - 1));
+
+        ss.run(optHelp.decorate(options), twice)
+          .then(unexpectedSuccess.bind(null, done))
+          .catch(twice);
+      });
     });
   };
 }
 
 module.exports = {
   testSuite: robotsTests,
-  inputFile: inputFile,
   urlCount: urls
 };

package/test/mocha/html-snapshots/server/test_robots.txt

@@ -0,0 +1,13 @@
+User-agent: *
+
+Allow: /
+Allow: /contact
+Allow: /services/carpets
+
+Disallow: /api/
+Disallow: /vendor/
+Disallow: /fonts/
+Disallow: /images/
+
+User-agent: ia_archiver
+Disallow: /

package/test/mocha/html-snapshots/server/test_robots_sitemap.txt

@@ -0,0 +1,15 @@
+User-agent: *
+
+Allow: /
+Allow: /contact
+Allow: /services/carpets
+
+Disallow: /api/
+Disallow: /vendor/
+Disallow: /fonts/
+Disallow: /images/
+
+User-agent: ia_archiver
+Disallow: /
+
+Sitemap: http://localhost:8038/test_robots_sitemap.xml

package/test/mocha/html-snapshots/server/test_robots_sitemap.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url>
+    <loc>http://localhost:8038/</loc>
+    <lastmod>2012-08-11T12:16:09+00:00</lastmod>
+    <changefreq>daily</changefreq>
+    <priority>1.0</priority>
+  </url>
+  <url>
+    <loc>http://localhost:8038/contact</loc>
+    <lastmod>2012-11-02T02:53:40+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.6</priority>
+  </url>
+  <url>
+    <loc>http://localhost:8038/services/carpets</loc>
+    <lastmod>2012-10-19T10:45:23+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.6</priority>
+  </url>
+</urlset>

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

@@ -4,48 +4,49 @@
  * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global it */
-var assert = require("assert");
-var path = require("path");
-var optHelp = require("../../helpers/options");
-var ss = require("../../../lib/html-snapshots");
-var utils = require("./utils");
+const assert = require("assert");
+const path = require("path");
+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 timeout = utils.timeout;
-var unexpectedError = utils.unexpectedError;
-var unexpectedSuccess = utils.unexpectedSuccess;
-var cleanup = utils.cleanup;
-var checkActualFiles = utils.checkActualFiles;
+const {
+  outputDir,
+  timeout,
+  unexpectedError,
+  unexpectedSuccess,
+  cleanup,
+  checkActualFiles
+} = utils;
 
 // Sitemap-index constants
-var sitemapIndexFile = "test_sitemap_index.xml";
-var inputFile = path.join(__dirname, "./", sitemapIndexFile);
-var urls = 3; // must match the unqiue # of urls in all the sitemap files referenced in sitemap-index.
+const sitemapIndexFile = "test_sitemap_index.xml";
+const inputFile = path.join(__dirname, "./", sitemapIndexFile);
+const urls = 3; // must match the unqiue # of urls in all the sitemap files referenced in sitemap-index.
 
 function getClass (obj) {
-  var string = Object.prototype.toString.call(obj);
-  var m = /\[object ([^\]]+)/.exec(string);
+  const string = Object.prototype.toString.call(obj);
+  const m = /\[object ([^\]]+)/.exec(string);
   return m && m[1];
 }
 
 function sitemapIndexTests (options) {
-  var port = options.port;
+  const port = options.port;
 
   return function () {
     it("should succeed for typical sitemap-index usage", function (done) {
-      var options = {
-        source: "http://localhost:"+port+"/"+sitemapIndexFile,
+      const options = {
+        source: `http://localhost:${port}/${sitemapIndexFile}`,
         input: "sitemap-index",
         selector: "#dynamic-content",
-        outputDir: outputDir,
         outputDirClean: true,
-        timeout: timeout
+        outputDir,
+        timeout
       };
 
       ss.run(optHelp.decorate(options))
         .then(function (completed) {
-          var assertionError;
+          let assertionError;
           try {
             assert.equal(getClass(completed), "Array");
             assert.equal(completed.length, urls);
@@ -54,61 +55,61 @@ function sitemapIndexTests (options) {
           }
           cleanup(done, assertionError);
         })
-        .catch(function (err) {
+        .catch(err => {
           checkActualFiles(err.notCompleted)
-            .then(function () {
+            .then(() => {
               cleanup(done, err || unexpectedError);
             });
         });
     });
 
     it("should fail fast for bad sitemap url", function (done) {
-      var sitemapIndexFile3 = path.basename(sitemapIndexFile, ".xml") + "-3" +
+      const sitemapIndexFile3 = path.basename(sitemapIndexFile, ".xml") + "-3" +
         path.extname(sitemapIndexFile);
-        var options = {
-          source: "http://localhost:" + port + "/" + sitemapIndexFile3,
-          input: "sitemap-index",
-          selector: "#dynamic-content",
-          outputDir: outputDir,
-          outputDirClean: true,
-          timeout: timeout
-        };
+      const options = {
+        source: `http://localhost:${port}/${sitemapIndexFile3}`,
+        input: "sitemap-index",
+        selector: "#dynamic-content",
+        outputDirClean: true,
+        outputDir,
+        timeout
+      };
 
-        ss.run(optHelp.decorate(options))
-          .then(unexpectedSuccess)
-          .catch(function (err) {
-            var assertionError;
-            try {
-              assert.equal(getClass(err.notCompleted), "Array");
-              // fails fast:
-              assert.equal(err.notCompleted.length, 0);
-            } catch (e) {
-              assertionError = e;
-            }
-            cleanup(done, assertionError);
-          });
+      ss.run(optHelp.decorate(options))
+        .then(unexpectedSuccess)
+        .catch(err => {
+          let assertionError;
+          try {
+            assert.equal(getClass(err.notCompleted), "Array");
+            // fails fast:
+            assert.equal(err.notCompleted.length, 0);
+          } catch (e) {
+            assertionError = e;
+          }
+          cleanup(done, assertionError);
+        });
     });
 
     it("should eventually fail for bad page url", function (done) {
-      var eventually = 1000;
-      var sitemapIndexFile2 = path.basename(sitemapIndexFile, ".xml") + "-2" +
+      const eventually = 1000;
+      const sitemapIndexFile2 = path.basename(sitemapIndexFile, ".xml") + "-2" +
         path.extname(sitemapIndexFile);
-      var options = {
-        source: "http://localhost:" + port + "/" + sitemapIndexFile2,
+      const options = {
+        source: `http://localhost:${port}/${sitemapIndexFile2}`,
         input: "sitemap-index",
         selector: "#dynamic-content",
-        outputDir: outputDir,
         outputDirClean: true,
         timeout: {
           "http://localhost:8040/services/bad": eventually,
           __default: timeout
-        }
+        },
+        outputDir
       };
 
       ss.run(optHelp.decorate(options))
         .then(unexpectedSuccess)
-        .catch(function (err) {
-          var assertionError;
+        .catch(err => {
+          let assertionError;
           try {
             assert.equal(getClass(err.completed), "Array");
             assert.equal(err.completed.length, urls - 1);
@@ -125,6 +126,6 @@ function sitemapIndexTests (options) {
 
 module.exports = {
   testSuite: sitemapIndexTests,
-  inputFile: inputFile,
-  urlCount: urls
+  urlCount: urls,
+  inputFile
 };