html-snapshots 0.19.0 → 1.0.0

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

@@ -29,7 +29,11 @@ const urls = 3; // must match url # in robots files test fixtures.
  * The robots test suite.
  */
 function robotsTests (options) {
-  const { port, localRobotsFile } = options;
+  const {
+    port,
+    localRobotsFile,
+    browsers
+   } = options;
 
   // Robots.txt fixtures
   const inputFiles = [
@@ -39,133 +43,146 @@ function robotsTests (options) {
   ];
 
   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);
-              });
+    function createOptions (newOptions) {
+      const options = {
+        hostname: "localhost",
+        selector: "#dynamic-content",
+        outputDirClean: true,
+        outputDir,
+        timeout,
+        port
+      };
+      return {
+        ...options,
+        ...newOptions
+      };
+    }
+    browsers.forEach(browser => {
+      inputFiles.forEach(inputFile => {
+        it(`should succeed, no output dir pre-exists, ${browser}, ${inputFile}`, function (done) {
+          const options = createOptions({
+            source: inputFile,
+            browser
           });
-      });
 
-      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);
-              });
+          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, ${browser}, ${inputFile}`, function (done) {
+          const options = createOptions({
+            source: inputFile,
+            browser
           });
-      });
 
-      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);
-      });
+          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, succeed otherwise, ${browser}, ${inputFile}`,
+          function (done) {
+          const options = createOptions({
+            source: inputFile,
+            browser,
+            phantomjs: bogusFile,
+            timeout: 1000
+          });
 
-      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);
-      });
+          if (browser === "phantomjs") {
+            const twice = _.after(2, cleanupError.bind(null, done, 0));
+
+            ss.run(options, twice)
+              .then(unexpectedSuccess.bind(null, done))
+              .catch(twice);
+          } else {
+            options.timeout = utils.timeout;
+            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, bad remote robots, ${browser}, ${inputFile}`, function (done) {
+          const options = createOptions({
+            input: "robots",
+            source: `http://localhost:${port}/index.html`,
+            timeout: 5000,
+            browser
+          });
 
-      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);
-      });
+          const twice = _.after(2, cleanupError.bind(null, done, 0));
 
-      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}`;
+          ss.run(optHelp.decorate(options), twice)
+            .then(unexpectedSuccess.bind(null, done))
+            .catch(twice);
+        });
+
+        it(`should fail, non-existent selector, ${browser}, ${inputFile}`, function (done) {
+          const options = createOptions({
+            source: inputFile,
+            selector: "#dynamic-content-notexist",
+            timeout: 5000,
+            browser
+          });
+
+          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, ${browser}, ${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);
+          const options = createOptions({
+            source: inputFile,
+            selector: {
+              "__default": "#dynamic-content",
+              [exceptionUrl]: "#dynamic-content-notexist"
+            },
+            timeout: 5000,
+            browser
+          });
+
+          const twice = _.after(2, cleanupError.bind(null, done, urls - 1));
+
+          ss.run(optHelp.decorate(options), twice)
+            .then(unexpectedSuccess.bind(null, done))
+            .catch(twice);
+        });
       });
     });
   };

package/test/mocha/html-snapshots/server/public/page-sitemap.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?><?xml-stylesheet type="text/xsl" href="//core.codekraft.it/public/wordpress/main-sitemap.xsl"?>
+<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" 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:8039/</loc>
+	</url>
+	<url>
+		<loc>http://localhost:8039/contact</loc>
+		<lastmod>2017-01-06T21:06:08+01:00</lastmod>
+	</url>
+	<url>
+		<loc>http://localhost:8039/services/carpets</loc>
+		<lastmod>2017-01-09T22:38:33+01:00</lastmod>
+	</url>
+</urlset>
+<!-- XML Sitemap generated by Yoast SEO -->
+<!-- 24.04MB | Served from transient cache -->

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

@@ -31,95 +31,104 @@ function getClass (obj) {
 }
 
 function sitemapIndexTests (options) {
-  const port = options.port;
+  const {
+    port,
+    browsers
+  } = options;
 
-  return function () {
-    it("should succeed for typical sitemap-index usage", function (done) {
-      const options = {
-        source: `http://localhost:${port}/${sitemapIndexFile}`,
-        input: "sitemap-index",
-        selector: "#dynamic-content",
-        outputDirClean: true,
-        outputDir,
-        timeout
-      };
+  function createOptions (newOptions) {
+    const options = {
+      source: `http://localhost:${port}/${sitemapIndexFile}`,
+      input: "sitemap-index",
+      selector: "#dynamic-content",
+      outputDirClean: true,
+      outputDir,
+      timeout
+    };
+
+    return {
+      ...options,
+      ...newOptions
+    };
+  }
 
-      ss.run(optHelp.decorate(options))
-        .then(function (completed) {
-          let assertionError;
-          try {
-            assert.equal(getClass(completed), "Array");
-            assert.equal(completed.length, urls);
-          } catch (e) {
-            assertionError = e;
-          }
-          cleanup(done, assertionError);
-        })
-        .catch(err => {
-          checkActualFiles(err.notCompleted)
-            .then(() => {
-              cleanup(done, err || unexpectedError);
-            });
+  return function () {
+    browsers.forEach(browser => {
+      it(`should succeed for typical sitemap-index usage - ${browser}`, function (done) {
+        const options = createOptions({
+          browser
         });
-    });
 
-    it("should fail fast for bad sitemap url", function (done) {
-      const sitemapIndexFile3 = path.basename(sitemapIndexFile, ".xml") + "-3" +
-        path.extname(sitemapIndexFile);
-      const options = {
-        source: `http://localhost:${port}/${sitemapIndexFile3}`,
-        input: "sitemap-index",
-        selector: "#dynamic-content",
-        outputDirClean: true,
-        outputDir,
-        timeout
-      };
+        ss.run(optHelp.decorate(options))
+          .then(function (completed) {
+            let assertionError;
+            try {
+              assert.equal(getClass(completed), "Array");
+              assert.equal(completed.length, urls);
+            } catch (e) {
+              assertionError = e;
+            }
+            cleanup(done, assertionError);
+          })
+          .catch(err => {
+            checkActualFiles(err.notCompleted)
+              .then(() => {
+                cleanup(done, err || unexpectedError);
+              });
+          });
+      });
 
-      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 fail fast for bad sitemap url - ${browser}`, function (done) {
+        const sitemapIndexFile3 = path.basename(sitemapIndexFile, ".xml") + "-3" +
+          path.extname(sitemapIndexFile);
+        const options = createOptions({
+          source: `http://localhost:${port}/${sitemapIndexFile3}`,
+          browser
         });
-    });
 
-    it("should eventually fail for bad page url", function (done) {
-      const eventually = 1000;
-      const sitemapIndexFile2 = path.basename(sitemapIndexFile, ".xml") + "-2" +
-        path.extname(sitemapIndexFile);
-      const options = {
-        source: `http://localhost:${port}/${sitemapIndexFile2}`,
-        input: "sitemap-index",
-        selector: "#dynamic-content",
-        outputDirClean: true,
-        timeout: {
-          "http://localhost:8040/services/bad": eventually,
-          __default: timeout
-        },
-        outputDir
-      };
+        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);
+          });
+      });
 
-      ss.run(optHelp.decorate(options))
-        .then(unexpectedSuccess)
-        .catch(err => {
-          let assertionError;
-          try {
-            assert.equal(getClass(err.completed), "Array");
-            assert.equal(err.completed.length, urls - 1);
-            assert.equal(getClass(err.notCompleted), "Array");
-            assert.equal(err.notCompleted.length, 1);
-          } catch (e) {
-            assertionError = e;
-          }
-          cleanup(done, assertionError);
+      it(`should eventually fail for bad page url - ${browser}`, function (done) {
+        const eventually = 1000;
+        const sitemapIndexFile2 = path.basename(sitemapIndexFile, ".xml") + "-2" +
+          path.extname(sitemapIndexFile);
+        const options = createOptions({
+          source: `http://localhost:${port}/${sitemapIndexFile2}`,
+          timeout: {
+            "http://localhost:8040/services/bad": eventually,
+            __default: timeout
+          },
+          browser
         });
+
+        ss.run(optHelp.decorate(options))
+          .then(unexpectedSuccess)
+          .catch(err => {
+            let assertionError;
+            try {
+              assert.equal(getClass(err.completed), "Array");
+              assert.equal(err.completed.length, urls - 1);
+              assert.equal(getClass(err.notCompleted), "Array");
+              assert.equal(err.notCompleted.length, 1);
+            } catch (e) {
+              assertionError = e;
+            }
+            cleanup(done, assertionError);
+          });
+      });
     });
   };
 }

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