Skip to content

armgit / mocha

Public Imported from GitHub
0

☕️ Classic, reliable, trusted test framework for Node.js and the browser

11.2 KB
Raw Blame
"use strict";

const { version } = require("../package.json");
const { escapeRegExp } = require("../lib/utils/regexp.js");

module.exports = {
  name: "unexpected-mocha-internal",
  version,
  installInto(expect) {
    expect
      .addType({
        name: "RawResult",
        base: "object",
        identify(v) {
          return (
            this.baseType.identify(v) &&
            typeof v.output === "string" &&
            "code" in v && // may be null
            Array.isArray(v.args) &&
            typeof v.command === "string"
          );
        },
      })
      .addType({
        name: "JSONResult",
        base: "RawResult",
        identify(v) {
          return (
            this.baseType.identify(v) &&
            typeof v.stats === "object" &&
            Array.isArray(v.failures) &&
            Array.isArray(v.passes) &&
            Array.isArray(v.tests) &&
            Array.isArray(v.pending)
          );
        },
      })
      .addType({
        name: "SummarizedResult",
        base: "RawResult",
        identify(v) {
          return (
            this.baseType.identify(v) &&
            typeof v.passing === "number" &&
            typeof v.failing === "number" &&
            typeof v.pending === "number"
          );
        },
      })
      .addAssertion(
        "<JSONResult> [not] to have (passed|succeeded)",
        (expect, result) => {
          expect(result, "to satisfy", {
            code: expect.it("[not] to be", 0),
            stats: {
              failures: expect.it("[not] to be", 0),
            },
            failures: expect.it("[not] to be empty"),
          });
        },
      )
      .addAssertion(
        "<SummarizedResult|RawResult> [not] to have (passed|succeeded)",
        (expect, result) => {
          expect(result, "[not] to have property", "code", 0);
        },
      )
      .addAssertion(
        "<SummarizedResult|JSONResult> [not] to have completed with [exit] code <number>",
        (expect, result, code) => {
          expect(result.code, "[not] to be", code);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have passed (with|having) count <number>",
        (expect, result, count) => {
          expect(result, "[not] to pass").and("[not] to satisfy", {
            stats: { passes: expect.it("to be", count) },
          });
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have failed (with|having) count <number>",
        (expect, result, count) => {
          expect(result, "[not] to have failed").and("[not] to satisfy", {
            stats: { failures: expect.it("to be", count) },
          });
        },
      )
      .addAssertion("<JSONResult> [not] to have failed", (expect, result) => {
        expect(result, "[not] to satisfy", {
          code: expect.it("to be greater than", 0),
          stats: {
            failures: expect.it("to be greater than", 0),
          },
          failures: expect.it("to be non-empty"),
        });
      })
      .addAssertion(
        "<SummarizedResult|RawResult> [not] to have failed",
        (expect, result) => {
          expect(result, "[not] to satisfy", {
            code: expect.it("to be greater than", 0),
          });
        },
      )
      .addAssertion(
        "<SummarizedResult|RawResult> [not] to have failed (with|having) output <any>",
        (expect, result, output) => {
          expect(result, "[not] to satisfy", {
            code: expect.it("to be greater than", 0),
            output,
          });
        },
      )
      .addAssertion(
        "<SummarizedResult|RawResult> [not] to have passed (with|having) output <any>",
        (expect, result, output) => {
          expect(result, "[not] to satisfy", {
            code: 0,
            output,
          });
        },
      )
      .addAssertion(
        "<SummarizedResult> [not] to have failed [test] count <number>",
        (expect, result, count) => {
          expect(result.failing, "[not] to be", count);
        },
      )
      .addAssertion(
        "<SummarizedResult> [not] to have passed [test] count <number>",
        (expect, result, count) => {
          expect(result.passing, "[not] to be", count);
        },
      )
      .addAssertion(
        "<SummarizedResult> [not] to have pending [test] count <number>",
        (expect, result, count) => {
          expect(result.pending, "[not] to be", count);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have test count <number>",
        (expect, result, count) => {
          expect(result.stats.tests, "[not] to be", count);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have failed [test] count <number>",
        (expect, result, count) => {
          expect(result.stats.failures, "[not] to be", count);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have passed [test] count <number>",
        (expect, result, count) => {
          expect(result.stats.passes, "[not] to be", count);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have pending [test] count <number>",
        (expect, result, count) => {
          expect(result.stats.pending, "[not] to be", count);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have run (test|tests) <string+>",
        (expect, result, ...titles) => {
          titles.forEach((title) => {
            expect(
              result,
              "[not] to have a value satisfying",
              expect.it(
                "to have an item satisfying",
                expect
                  .it("to have property", "title", title)
                  .or("to have property", "fullTitle", title),
              ),
            );
          });
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have failed (test|tests) <string+>",
        (expect, result, ...titles) => {
          titles.forEach((title) => {
            expect(
              result.failures,
              "[not] to have an item satisfying",
              expect
                .it("to have property", "title", title)
                .or("to have property", "fullTitle", title),
            );
          });
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have (error|errors) <any+>",
        (expect, result, ...errors) => {
          errors.forEach((error) => {
            expect(result, "[not] to satisfy", {
              failures: expect.it("to have an item satisfying", {
                err: expect
                  .it("to satisfy", error)
                  .or("to satisfy", { message: error }),
              }),
            });
          });
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have passed (test|tests) <string+>",
        (expect, result, ...titles) => {
          titles.forEach((title) => {
            expect(result.passes, "[not] to have an item satisfying", {
              title,
            });
          });
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have test order <string> <array>",
        (expect, result, state, titles) => {
          expect(
            result[state].slice(0, titles.length),
            "[not] to satisfy",
            titles.map((title) => {
              return typeof title === "string" ? { title } : title;
            }),
          );
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have passed test order <array>",
        (expect, result, titles) => {
          expect(result, "[not] to have test order", "passes", titles);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have passed test order <string+>",
        (expect, result, ...titles) => {
          expect(result, "[not] to have test order", "passes", titles);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have failed test order <array>",
        (expect, result, titles) => {
          expect(result, "[not] to have test order", "failures", titles);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have failed test order <string+>",
        (expect, result, ...titles) => {
          expect(result, "[not] to have test order", "failures", titles);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have pending test order <array>",
        (expect, result, titles) => {
          expect(result, "[not] to have test order", "pending", titles);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have pending test order <string+>",
        (expect, result, ...titles) => {
          expect(result, "[not] to have test order", "pending", titles);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have pending tests",
        (expect, result) => {
          expect(result.stats.pending, "[not] to be greater than", 0);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have passed tests",
        (expect, result) => {
          expect(result.stats.passes, "[not] to be greater than", 0);
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have failed tests",
        (expect, result) => {
          expect(result.stats.failed, "[not] to be greater than", 0);
        },
      )
      .addAssertion("<JSONResult> [not] to have tests", (expect, result) => {
        expect(result.stats.tests, "[not] to be greater than", 0);
      })
      .addAssertion(
        "<JSONResult> [not] to have retried test <string>",
        (expect, result, title) => {
          expect(result.tests, "[not] to have an item satisfying", {
            title,
            currentRetry: expect.it("to be positive"),
          });
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have retried test <string> <number>",
        (expect, result, title, count) => {
          expect(result.tests, "[not] to have an item satisfying", {
            title,
            currentRetry: count,
          });
        },
      )
      .addAssertion(
        "<JSONResult> [not] to have failed with (error|errors) <any+>",
        function (expect, result, ...errors) {
          errors.forEach((error) => {
            expect(result, "[not] to have failed").and("[not] to satisfy", {
              failures: expect.it("to have an item satisfying", {
                err: expect
                  .it("to satisfy", error)
                  .or("to satisfy", { message: error }),
              }),
            });
          });
        },
      )
      .addAssertion(
        "<RawResult|SummarizedResult> [not] to contain [output] <any>",
        (expect, result, output) => {
          expect(result.output, "[not] to satisfy", output);
        },
      )
      .addAssertion(
        "<RawResult|SummarizedResult> to contain [output] once <any>",
        (expect, result, output) => {
          if (typeof output === "string") {
            output = escapeRegExp(output);
          } else if (!(output instanceof RegExp)) {
            throw new TypeError("expected a string or regexp");
          }
          output = new RegExp(output, "g");
          expect(result.output.match(output), "to have length", 1);
        },
      )
      .addAssertion(
        "<RawResult|SummarizedResult|JSONResult> to have [exit] code <number>",
        (expect, result, code) => {
          expect(result.code, "to be", code);
        },
      );
  },
};