npm - html-snapshots - Versions diffs - 1.3.2 → 1.5.0 - Mend

html-snapshots 1.3.2 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (253) hide show

package/test/mocha/browsers/puppeteer.js DELETED Viewed

@@ -1,129 +0,0 @@
-/**
- * Tests that target the puppeteer script specifically.
- *
- * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
- */
-/* global before, it */
-const assert = require("assert");
-const path = require("path");
-const rimraf = require("rimraf").sync;
-const spawn = require("child_process").spawn;
-const server = require("../../server");
-const outputDir = path.join(__dirname, "tmp");
-const port = 9340;
-function puppeteerTests () {
-  const snapshotScript = path.resolve(__dirname, '../../../lib/puppeteer/index.js');
-  const outputFile = path.join(outputDir, "snapshot.html");
-  /**
-   * Launch the puppeteer script as a process.
-   *
-   * @param {Array} args - array of puppeteer args
-   */
-  function spawnPuppeteer (args, done) {
-    const cp = spawn(
-      snapshotScript,
-      args
-      , { cwd: process.cwd(), stdio: "inherit", detached: true }
-    );
-    cp.on("exit", code => {
-      if (code !== 0) {
-        return done(new Error(`error exit code: ${code}`));
-      }
-      done();
-    });
-  }
-  return function () {
-    before(function() {
-      server.start(path.join(__dirname, "./server"), port);
-    });
-    it("should succeed with minimal args", function (done) {
-      this.timeout(4000);
-      rimraf(outputDir);
-      spawnPuppeteer([
-        outputFile,
-        `http://localhost:${port}/`,
-        "body"
-      ], done);
-    });
-    it("should succeed with stringified puppeteerLaunchOptions", function (done) {
-      this.timeout(4000);
-      rimraf(outputDir);
-      // override the debug options to prove stringified launch opts worked.
-      const puppeteerLaunchOptions = {
-        headless: true,
-        devTools: false
-      };
-      spawnPuppeteer([
-        outputFile,
-        `http://localhost:${port}/`,
-        "body",
-        4000,
-        "false",
-        "true",
-        10,
-        JSON.stringify(puppeteerLaunchOptions)
-      ], done);
-    });
-    it("should fail if insufficient input args", function (done) {
-      rimraf(outputDir);
-      spawnPuppeteer([
-        outputFile,
-        "http://someurl.domain/path/resource"
-      ], e => {
-        const msg = "expected process error";
-        assert.ok(e, msg);
-        done(e ? undefined : new Error(msg));
-      });
-    });
-    it("should fail with bad url", function (done) {
-      rimraf(outputDir);
-      spawnPuppeteer([
-        outputFile,
-        "http://nonexistent.domain/path/resource",
-        "body",
-        1000
-      ], e => {
-        const msg = "expected process error";
-        assert.ok(e, msg);
-        done(e ? undefined : new Error(msg));
-      });
-    });
-    it("should launch debugging", function (done) {
-      const timeout = 5000;
-      this.timeout(timeout);
-      rimraf(outputDir);
-      spawnPuppeteer([
-        outputFile,
-        `http://localhost:${port}/`,
-        "body",
-        timeout - 1000,
-        "false",
-        "true",
-        10
-      ], done);
-    });
-  };
-}
-module.exports = {
-  testSuite: puppeteerTests
-};

package/test/mocha/browsers/server/index.html DELETED Viewed

@@ -1,9 +0,0 @@
-<!DOCTYPE html>
-<html lang="en-US">
-  <body>
-    <h1>Hello World</h1>
-    <p>
-      This is a simple test file, how do you do?
-    </p>
-  </body>
-</html>

package/test/mocha/browsers/test.js DELETED Viewed

@@ -1,11 +0,0 @@
-/**
- * browser process specific tests
- *
- * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
- */
-/* global describe */
-const puppeteer = require("./puppeteer");
-describe("browser process tests", function () {
-  describe("puppeteer", puppeteer.testSuite());
-});

package/test/mocha/common/helpers.js DELETED Viewed

@@ -1,87 +0,0 @@
-/**
- * Helpers tests.
- *
- * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
- */
-/* global describe, it */
-var assert = require("assert");
-var resHelper = require("../../helpers/result");
-describe("helpers", function() {
-  describe("result", function() {
-    describe("mustBeError", function() {
-      it("should succeed if get Error", function() {
-        resHelper.mustBeError(new Error());
-      });
-      it("should succeed if get String", function() {
-        resHelper.mustBeError("test error");
-      });
-      it("should fail if null string", function() {
-        var err;
-        try {
-          resHelper.mustBeError("");
-        } catch(e) {
-          err = e;
-        }
-        assert.notStrictEqual(typeof err, "undefined");
-      });
-      it("should fail if false", function() {
-        var err;
-        try {
-          resHelper.mustBeError(false);
-        } catch(e) {
-          err = e;
-        }
-        assert.notStrictEqual(typeof err, "undefined");
-      });
-      it("should fail if undefined", function() {
-        var err;
-        try {
-          resHelper.mustBeError();
-        } catch(e) {
-          err = e;
-        }
-        assert.notStrictEqual(typeof err, "undefined");
-      });
-      it("should fail if NaN", function() {
-        var err;
-        try {
-          resHelper.mustBeError(NaN);
-        } catch(e) {
-          err = e;
-        }
-        assert.notStrictEqual(typeof err, "undefined");
-      });
-      it("should fail if 0", function() {
-        var err;
-        try {
-          resHelper.mustBeError(0);
-        } catch(e) {
-          err = e;
-        }
-        assert.notStrictEqual(typeof err, "undefined");
-      });
-      it("should fail if null", function() {
-        var err;
-        try {
-          resHelper.mustBeError(null);
-        } catch(e) {
-          err = e;
-        }
-        assert.notStrictEqual(typeof err, "undefined");
-      });
-    });
-  });
-});

package/test/mocha/common/test.js DELETED Viewed

@@ -1,188 +0,0 @@
-/**
- * Common module tests.
- *
- * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
- */
-/* global describe, it */
-var assert = require("assert");
-var path = require("path");
-var common = require("../../../lib/common");
-describe("common", function () {
-  describe("ensure", function () {
-    it("should return the options if no defaults specified", function () {
-      var options = { one: "one", two: "two", three: "three" };
-      var result = common.ensure(options);
-      assert.equal(result.toString(), options.toString());
-    });
-    it("should return the result options", function () {
-      var defaults = { one: "two", two: "three", three: "four" };
-      var options = { one: "one", two: "two", three: "three" };
-      var result = common.ensure(options, defaults);
-      assert.equal(result.toString(), options.toString());
-    });
-    it("should not copy defaults when specified in options", function () {
-      var defaults = { one: "two", two: "three", three: "four" };
-      var options = { one: "one", two: "two", three: "three" };
-      common.ensure(options, defaults);
-      assert.equal("one", options.one);
-      assert.equal("two", options.two);
-      assert.equal("three", options.three);
-    });
-    it("should copy defaults when not specified in options", function () {
-      var defaults = { one: "two", two: "three", three: "four" };
-      var options = { one: "one", two: "two" };
-      common.ensure(options, defaults);
-      assert.equal("one", options.one);
-      assert.equal("two", options.two);
-      assert.equal("four", options.three);
-    });
-  });
-  describe("isUrl", function () {
-    it("should detect an http url", function () {
-      var result = common.isUrl("http://whatever.com/");
-      assert.equal(true, result);
-    });
-    it("should not detect a file", function () {
-      var result = common.isUrl(path.join(__dirname, __filename));
-      assert.equal(false, result);
-    });
-    it("should not detect an object", function () {
-      var result = common.isUrl({ url: "bogus" });
-      assert.equal(false, result);
-    });
-  });
-  describe("prependMsgToErr", function () {
-    it("should return undefined if given falsy error", function () {
-      var result = common.prependMsgToErr(undefined, "message", true);
-      assert.equal(result, undefined);
-    });
-    it("should return same error if given error and no message", function () {
-      // These need to have the same message.
-      var error = new Error("my test error");
-      var input = new Error("my test error");
-      var result = common.prependMsgToErr(input);
-      assert.deepEqual(result, error);
-    });
-    it("should quote the message when asked", function () {
-      var msg = "my message";
-      var result = common.prependMsgToErr(new Error("my test error"), msg, true);
-      assert.equal(result.message.indexOf("'"+msg+"'") > -1, true);
-    });
-    it("should not quote a message when asked", function () {
-      var msg = "my message";
-      var result = common.prependMsgToErr(new Error("my test error"), msg);
-      assert.equal(result.message.indexOf("'"+msg+"'") === -1, true);
-      assert.equal(result.message.indexOf(msg) > -1, true);
-    });
-    it("should make an error if string was given", function () {
-      var input = "my test error";
-      var msg = "my message";
-      var result = common.prependMsgToErr(input, msg, true);
-      assert.equal(result instanceof Error, true);
-      assert.equal(result.message.indexOf("'"+msg+"'") > -1, true);
-    });
-    it("should prepend message to error", function () {
-      var msg = "my message";
-      var errMsg = "my test error";
-      var result = common.prependMsgToErr(new Error(errMsg), msg);
-      var resultMessage = result.message.split(": ");
-      assert.equal(resultMessage.length > 1, true);
-      assert.equal(resultMessage[0], msg);
-      assert.equal(resultMessage[1], errMsg);
-    });
-  });
-  describe("checkResponse", function () {
-    it("should reject a non 200 response", function() {
-      var result = common.checkResponse({ statusCode: 206 }, "doesntmatter");
-      assert.notEqual(false, result);
-    });
-    it("should reject for missing content type", function() {
-      var result = common.checkResponse({
-        statusCode: 200,
-        headers: {}
-      }, "any");
-      assert.notEqual(false, result);
-    });
-    it("should reject for bad content type, single", function() {
-      var result = common.checkResponse({
-        statusCode: 200,
-        headers: {
-          "content-type": "text/plain"
-        }
-      }, "text/xml");
-      assert.notEqual(false, result);
-    });
-    it("should reject for bad content type, multiple", function() {
-      var result = common.checkResponse({
-        statusCode: 200,
-        headers: {
-          "content-type": "text/plain"
-        }
-      }, ["text/xml", "application/xml"]);
-      assert.notEqual(false, result);
-    });
-    it("should accept for good content type, single", function() {
-      var contentType = "text/plain";
-      var result = common.checkResponse({
-        statusCode: 200,
-        headers: {
-          "content-type": contentType
-        }
-      }, contentType);
-      assert.equal(false, result);
-    });
-    it("should accept for good content type, multiple, first", function() {
-      var contentType = "text/xml";
-      var result = common.checkResponse({
-        statusCode: 200,
-        headers: {
-          "content-type": contentType
-        }
-      }, [contentType, "application/xml"]);
-      assert.equal(false, result);
-    });
-    it("should accept for good content type, multiple, last", function() {
-      var contentType = "text/xml";
-      var result = common.checkResponse({
-        statusCode: 200,
-        headers: {
-          "content-type": contentType
-        }
-      }, ["application/xml", contentType]);
-      assert.equal(false, result);
-    });
-  });
-});

package/test/mocha/html-snapshots/basics.js DELETED Viewed

@@ -1,88 +0,0 @@
-/**
- * Basic library tests.
- *
- * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
- */
-/* global it */
-const assert = require("assert");
-const _ = require("lodash");
-const fs = require("fs");
-const path = require("path");
-const ss = require("../../../lib/html-snapshots");
-const utils = require("./utils");
-const optHelp = require("../../helpers/options");
-// missing destructuring, will write postcard...
-const {
-  bogusFile,
-  cleanupError,
-  unexpectedSuccess
-} = utils;
-function basicTests (options) {
-  const {
-    browsers
-  } = options;
-  return function () {
-    browsers.forEach(browser => {
-      it(`no arguments should fail - ${browser}`, function (done) {
-        const twice = _.after(2, cleanupError.bind(null, done, 0));
-        ss.run(optHelp.decorate({
-          browser
-        }), twice)
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(twice);
-      });
-      it(`invalid source should fail - ${browser}`, function (done) {
-        const twice = _.after(2, cleanupError.bind(null, done, 0));
-        ss.run(optHelp.decorate({
-          source: bogusFile,
-          browser
-        }), twice)
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(twice);
-      });
-      it(`should clean the output directory when specified - ${browser}`, function (done) {
-        const dir = path.join(__dirname, "./tmpdir");
-        const file = path.join(dir, "somefile.txt");
-        const twice = _.after(2, cleanupError.bind(null, done, 0));
-        fs.mkdirSync(dir);
-        fs.writeFileSync(file, "some data");
-        assert.doesNotThrow(fs.accessSync.bind(null, dir));
-        ss.run(optHelp.decorate({
-          source: bogusFile,
-          outputDir: dir,
-          outputDirClean: true,
-          browser
-        }), twice)
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(twice);
-        assert.throws(fs.accessSync.bind(null, dir));
-      });
-      it(`default snapshot script should exist - ${browser}`, function (done) {
-        const options = { source: "./bogus/file.txt", browser };
-        const twice = _.after(2, cleanupError.bind(null, done, 0));
-        const result = ss.run(optHelp.decorate(options), twice);
-        assert.doesNotThrow(fs.accessSync.bind(null, options.snapshotScript));
-        result
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(twice);
-      });
-    });
-  };
-}
-module.exports = {
-  testSuite: basicTests
-};

package/test/mocha/html-snapshots/myFilter.js DELETED Viewed

@@ -1,10 +0,0 @@
-/**
- * In-test, custom filter script.
- * Adds a custom tag onto the body.
- *
- * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
- */
-module.exports = function(content) {
-  console.log("IN THE CUSTOMFILTER");
-  return content.replace(/<body\b\s*/i, "<body data-someattrZZQy=\"true\" ");
-};

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

@@ -1,156 +0,0 @@
-/**
- * Library tests focused on the phantomjsOptions option.
- *
- * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
- */
-/* global it */
-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) {
-  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) {
-      const options = createOptions({});
-      rimraf(outputBase);
-      ss.run(optHelp.decorate(options))
-        .then(() => {
-          cleanup(done);
-        }).catch(e => {
-          checkActualFiles(e.notCompleted)
-            .then(() => {
-              cleanup(done, e || unexpectedError);
-            });
-        });
-    });
-    it("should work with one string option", function (done) {
-      const options = createOptions({});
-      rimraf(outputBase);
-      ss.run(optHelp.decorate(options), (err, completed) => {
-        if (err) {
-          console.log(`@@@ error = ${err}, completed=${completed.join(',')}`);
-        }
-      })
-        .then(() => {
-          let assertionError;
-          try {
-            fs.accessSync(cookiesFile);
-          } catch (e) {
-            assertionError = e;
-          }
-          cleanup(done, assertionError);
-        })
-        .catch(e => {
-          checkActualFiles(e.notCompleted)
-            .then(function () {
-              cleanup(done, e || unexpectedError);
-            });
-        });
-    });
-    it("should work with multiple options, test one", function (done) {
-      const options = createOptions({
-        selector: "#inline-image",
-        phantomjsOptions: [
-          `--cookies-file=${cookiesFile}`,
-          "--load-images=true"
-        ]
-      });
-      rimraf(outputBase);
-      ss.run(optHelp.decorate(options), (err, completed) => {
-        if (err) {
-          console.log(`@@@ error = ${err}, completed=${completed.join(',')}`);
-        }
-      })
-        .then(() => {
-          let assertionError;
-          try {
-            fs.accessSync(cookiesFile);
-          } catch (e) {
-            assertionError = e;
-          }
-          cleanup(done, assertionError);
-        })
-        .catch(e => {
-          checkActualFiles(e.notCompleted)
-            .then(() => {
-              cleanup(done, e || unexpectedError);
-            });
-        });
-    });
-    it("should work with multiple options, test two", function (done) {
-      const options = createOptions({
-        selector: "#inline-image",
-        timeout: 5000, // this should fail, so don't wait too long.
-        phantomjsOptions: [
-          `--cookies-file=${cookiesFile}`,
-          "--load-images=false"
-        ]
-      });
-      rimraf(outputBase);
-      ss.run(optHelp.decorate(options))
-        .then(unexpectedSuccess.bind(null, done))
-        .catch(err => {
-          let assertionError;
-          try {
-            resHelp.mustBeError(err);
-          } catch (e) {
-            assertionError = e;
-          }
-          cleanup(done, assertionError);
-        });
-    });
-    // most of these tests use no options, so not testing that again here
-  };
-}
-module.exports = {
-  testSuite: phantomjsOptionsTests
-};