@sprucelabs/test-utils 3.1.83 → 3.2.0

package/build/AbstractSpruceTest.d.ts

@@ -0,0 +1,10 @@
+export default class AbstractSpruceTest {
+    protected static cwd: string;
+    protected static beforeAll(): Promise<void>;
+    protected static afterAll(): Promise<void>;
+    protected static beforeEach(): Promise<void>;
+    protected static afterEach(): Promise<void>;
+    protected static resolvePath(...filePath: string[]): string;
+    protected static wait(ms?: number): Promise<unknown>;
+    protected static log(...args: any[]): void;
+}

package/build/AbstractSpruceTest.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+class AbstractSpruceTest {
+    static async beforeAll() {
+        this.cwd = process.cwd();
+    }
+    static async afterAll() { }
+    static async beforeEach() { }
+    static async afterEach() { }
+    static resolvePath(...filePath) {
+        const cwd = this.cwd;
+        let builtPath = path_1.default.join(...filePath);
+        if (!cwd) {
+            throw new Error('You must call super.beforeAll().');
+        }
+        if (builtPath[0] !== '/') {
+            if (builtPath.substr(0, 2) === './') {
+                builtPath = builtPath.substr(1);
+            }
+            builtPath = path_1.default.join(cwd, builtPath);
+        }
+        return builtPath;
+    }
+    static async wait(ms = 1000) {
+        return new Promise((resolve) => {
+            setTimeout(() => resolve(true), ms);
+        });
+    }
+    static log(...args) {
+        const str = args.map((a) => `${a}`).join(' ');
+        process.stderr.write(str);
+    }
+}
+exports.default = AbstractSpruceTest;

package/build/AssertionError.d.ts

@@ -0,0 +1,3 @@
+export default class AssertionError extends Error {
+    constructor(message: string, stack?: string);
+}

package/build/AssertionError.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const StackCleaner_1 = __importDefault(require("./StackCleaner"));
+class AssertionError extends Error {
+    constructor(message, stack) {
+        var _a;
+        super(message);
+        this.message = StackCleaner_1.default.clean(message ? `${message}\n` : '');
+        this.stack = StackCleaner_1.default.clean(`${this.message}${((_a = stack !== null && stack !== void 0 ? stack : this.stack) !== null && _a !== void 0 ? _a : '').replace(message, '')}`);
+    }
+}
+exports.default = AssertionError;

package/build/StackCleaner.d.ts

@@ -0,0 +1,4 @@
+export default class StackCleaner {
+    private static matchPattern;
+    static clean(stack: string): string;
+}

package/build/StackCleaner.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class StackCleaner {
+    static clean(stack) {
+        const lines = stack.split(/\r?\n/);
+        const filtered = lines.filter((line) => line.search(this.matchPattern) === -1);
+        const newStack = filtered.join('\n');
+        return newStack;
+    }
+}
+exports.default = StackCleaner;
+StackCleaner.matchPattern = /spruce-test\/(?!src\/__tests__)|node_modules|internal\/process\/task_queues|@babel|regenerator-runtime\/runtime/gi;

package/build/assert/assert.d.ts

@@ -0,0 +1,44 @@
+import { expectType } from 'ts-expect';
+declare type RecursivePartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object ? RecursivePartial<T[P]> : T[P];
+};
+declare type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
+declare type IsAny<T> = IfAny<T, true, never>;
+declare type TypeEqual<T, U> = IsAny<T> extends never ? Exclude<T, U> extends never ? Exclude<U, T> extends never ? true : false : false : false;
+declare function isExactType<T, E, Pass = TypeEqual<T, E>>(_: Pass): void;
+export interface ISpruceAssert {
+    isNumber(actual: any, message?: string): asserts actual is number;
+    isType: typeof expectType;
+    isExactType: typeof isExactType;
+    isArray<T extends any[]>(actual: any, message?: string): asserts actual is T;
+    areSameType<T>(actual: T, expected: T): asserts actual is T;
+    isEqual<T>(actual: T, expected: T, message?: string): asserts actual is T;
+    isNotEqual<T>(actual: T, expected: T, message?: string): asserts actual is T;
+    isEqualDeep<T>(actual: T, expected: T, message?: string, shouldAppendDelta?: boolean): asserts actual is T;
+    isAbove<T>(actual: T, floor: T, message?: string): void;
+    isBelow<T>(actual: T, ceiling: T, message?: string): void;
+    isUndefined<T>(actual: T, message?: string): void;
+    isTruthy<T = any>(value: T, message?: string): asserts value is NonNullable<T>;
+    isFalsy(value: any, message?: string): void;
+    isTrue(actual: boolean | undefined | null, message?: string): asserts actual is true;
+    isFalse(actual: boolean | undefined | null, message?: string): asserts actual is false;
+    isObject<T>(actual: T, message?: string): void;
+    isLength(actual: any[] | undefined | null, expected: number, message?: string): void;
+    isNull(actual: any, message?: string): void;
+    doesNotInclude<T>(haystack: T, needle: RecursivePartial<T>, message?: string): void;
+    doesNotInclude(haystack: string, needle: string, message?: string): void;
+    doesNotInclude(haystack: any, needle: string, message?: string): void;
+    doesNotInclude(haystack: any, needle: any, message?: string): void;
+    doesInclude<T>(haystack: T, needle: RecursivePartial<T>, message?: string): void;
+    doesInclude(haystack: string, needle: string, message?: string): void;
+    doesInclude(haystack: any, needle: string, message?: string): void;
+    doesInclude(haystack: any, needle: any, message?: string): void;
+    isString(actual: any, message?: string): asserts actual is string;
+    isFunction(actual: any, message?: string): asserts actual is Function;
+    hasAllFunctions(obj: any, functionNames: string[]): void;
+    doesThrow(cb: () => any, matcher?: string | RegExp | undefined, msg?: string | undefined): Error;
+    doesThrowAsync(cb: () => any | Promise<any>, matcher?: string | RegExp | undefined, msg?: string | undefined): Promise<Error>;
+    fail(message?: string): void;
+}
+declare const assert: ISpruceAssert;
+export default assert;

package/build/assert/assert.js

@@ -0,0 +1,227 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const deep_equal_1 = __importDefault(require("deep-equal"));
+const escapeRegExp_1 = __importDefault(require("lodash/escapeRegExp"));
+const isObjectLike_1 = __importDefault(require("lodash/isObjectLike"));
+const ts_expect_1 = require("ts-expect");
+const variable_diff_1 = __importDefault(require("variable-diff"));
+const assert_utility_1 = __importDefault(require("./assert.utility"));
+const stringify = assert_utility_1.default.stringify.bind(assert_utility_1.default);
+function isExactType(_) { }
+const assert = {
+    areSameType() { },
+    isType: ts_expect_1.expectType,
+    isExactType,
+    isNumber(actual, message) {
+        if (typeof actual !== 'number') {
+            this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} is not a number!`);
+        }
+    },
+    isEqual(actual, expected, message) {
+        if (actual !== expected) {
+            this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} does not equal ${stringify(expected)}`);
+        }
+    },
+    isNotEqual(actual, expected, message) {
+        if (actual === expected) {
+            this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} should not equal ${stringify(expected)}`);
+        }
+    },
+    isEqualDeep(actual, expected, message, shouldAppendDelta = true) {
+        if (!(0, deep_equal_1.default)(actual, expected, { strict: true })) {
+            let result = (0, variable_diff_1.default)(actual, expected);
+            this.fail(`${message !== null && message !== void 0 ? message : `Deep equal failed.\n\nActual would need the following changes to match expected:`}${shouldAppendDelta ? `\n\n${result.text}` : ``}`);
+        }
+    },
+    isAbove(actual, floor, message) {
+        if (typeof actual !== 'number') {
+            this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} is not a number!`);
+        }
+        if (actual <= floor) {
+            this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} is not above ${stringify(floor)}`);
+        }
+    },
+    isBelow(actual, ceiling, message) {
+        if (typeof actual !== 'number') {
+            this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} is not a number!`);
+        }
+        if (actual >= ceiling) {
+            this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} is not below ${stringify(ceiling)}`);
+        }
+    },
+    isUndefined(actual, message) {
+        if (typeof actual !== 'undefined') {
+            this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} is not undefined`);
+        }
+    },
+    isTruthy(actual, message) {
+        if (actual === false ||
+            actual === null ||
+            typeof actual === 'undefined' ||
+            actual === 0) {
+            this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} is not truthy`);
+        }
+    },
+    isFalsy(actual, message) {
+        if (actual) {
+            this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} is not falsy`);
+        }
+    },
+    isNull(actual, message) {
+        if (actual !== null) {
+            this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} is not null`);
+        }
+    },
+    isString(actual, message) {
+        assert_utility_1.default.assertTypeof(actual, 'string', message);
+    },
+    isFunction(actual, message) {
+        assert_utility_1.default.assertTypeof(actual, 'function', message);
+    },
+    isTrue(actual, message) {
+        //@ts-ignore
+        this.isEqual(actual, true, message);
+    },
+    isFalse(actual, message) {
+        //@ts-ignore
+        this.isEqual(actual, false, message);
+    },
+    isObject(actual, message) {
+        if (!(0, isObjectLike_1.default)(actual)) {
+            throw this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} is not an object`);
+        }
+    },
+    isArray(actual, message) {
+        if (!Array.isArray(actual)) {
+            throw this.fail(message !== null && message !== void 0 ? message : `${stringify(actual)} is not an array`);
+        }
+    },
+    isLength(actual, expected, message) {
+        if (!actual) {
+            throw this.fail(message !== null && message !== void 0 ? message : `Expected array of length ${expected}, but got ${stringify(actual)}`);
+        }
+        //@ts-ignore
+        this.isEqual(actual.length, expected, message !== null && message !== void 0 ? message : `Expected length of ${stringify(expected)}, but got a length of ${stringify(actual.length)}`);
+    },
+    doesNotInclude(haystack, needle, message) {
+        let doesInclude = false;
+        try {
+            this.doesInclude(haystack, needle);
+            doesInclude = true;
+        }
+        catch (_a) {
+            doesInclude = false;
+        }
+        if (doesInclude) {
+            this.fail(message !== null && message !== void 0 ? message : `${stringify(haystack)} should not include ${stringify(needle)}, but it does`);
+        }
+    },
+    doesInclude(haystack, needle, message) {
+        let msg = message !== null && message !== void 0 ? message : `Could not find ${stringify(needle)} in ${stringify(haystack)}`;
+        const isNeedleString = typeof needle === 'string';
+        const isNeedleRegex = needle instanceof RegExp;
+        if (typeof haystack === 'string' &&
+            (isNeedleString || isNeedleRegex) &&
+            haystack.search(isNeedleString ? (0, escapeRegExp_1.default)(needle) : needle) > -1) {
+            return;
+        }
+        const isHaystackObject = (0, isObjectLike_1.default)(haystack);
+        const { needleHasArrayNotation, path, expected } = assert_utility_1.default.parseIncludeNeedle(needle);
+        if (Array.isArray(haystack)) {
+            let cleanedNeedle = needle;
+            if (path && path.substr(0, 3) === '[].') {
+                cleanedNeedle = { [path.substr(3)]: expected };
+            }
+            const found = assert_utility_1.default.doHaystacksPassCheck(haystack, cleanedNeedle, this.doesInclude.bind(this));
+            if (found) {
+                return;
+            }
+        }
+        if (isHaystackObject && (0, isObjectLike_1.default)(needle)) {
+            try {
+                //@ts-ignore
+                this.isEqualDeep(haystack, needle);
+                return;
+                // eslint-disable-next-line no-empty
+            }
+            catch (_a) { }
+        }
+        if (assert_utility_1.default.foundUsing3rdPartyIncludes(haystack, needle, isHaystackObject)) {
+            return;
+        }
+        if (!Array.isArray(haystack) &&
+            isHaystackObject &&
+            (0, isObjectLike_1.default)(needle) &&
+            Object.keys(needle).length === 1 &&
+            !needleHasArrayNotation &&
+            path) {
+            const actual = assert_utility_1.default.valueAtPath(haystack, path);
+            if (typeof actual === 'undefined') {
+                msg = `The path ${stringify(path)} was not found in ${stringify(haystack)}`;
+            }
+            else {
+                msg = `Expected ${chalk_1.default.green(stringify(needle[path]))} but found ${chalk_1.default.red(stringify(actual))} at ${stringify(path)} in ${stringify(haystack)}`;
+            }
+            if (typeof expected === 'string' &&
+                typeof actual === 'string' &&
+                actual.search(expected) > -1) {
+                return;
+            }
+            else if (expected instanceof RegExp && expected.exec(actual)) {
+                return;
+            }
+            else {
+                //@ts-ignore
+                this.isEqualDeep(expected, actual, msg, false);
+            }
+            return;
+        }
+        if (isHaystackObject && (0, isObjectLike_1.default)(needle) && path) {
+            const { actualBeforeArray, pathAfterFirstArray } = assert_utility_1.default.splitPathBasedOnArrayNotation(path, haystack);
+            if (!Array.isArray(actualBeforeArray)) {
+                this.fail(msg);
+            }
+            const found = assert_utility_1.default.doHaystacksPassCheck(actualBeforeArray, {
+                [pathAfterFirstArray]: expected,
+            }, this.doesInclude.bind(this));
+            if (found) {
+                return;
+            }
+            msg = `Could not find match ${stringify(expected)} at ${stringify(pathAfterFirstArray)} in ${stringify(actualBeforeArray)}.`;
+        }
+        this.fail(msg);
+    },
+    hasAllFunctions(obj, functionNames) {
+        functionNames.forEach((name) => {
+            if (typeof obj[name] !== 'function') {
+                this.fail(`A function named "${name}" does not exist on ${stringify(obj)}`);
+            }
+        });
+    },
+    doesThrow(cb, matcher, msg) {
+        try {
+            cb();
+        }
+        catch (err) {
+            assert_utility_1.default.checkDoesThrowError(matcher, err, msg);
+            return err;
+        }
+        this.fail('Expected a thrown error, but never got one!');
+    },
+    async doesThrowAsync(cb, matcher, msg) {
+        try {
+            await cb();
+        }
+        catch (err) {
+            assert_utility_1.default.checkDoesThrowError(matcher, err, msg);
+            return err;
+        }
+        this.fail('Expected a thrown error, but never got one!');
+    },
+    fail: assert_utility_1.default.fail,
+};
+exports.default = assert;

package/build/assert/assert.utility.d.ts

@@ -0,0 +1,28 @@
+import { ISpruceAssert } from './assert';
+export declare const UNDEFINED_PLACEHOLDER = "_____________undefined_____________";
+export declare const FUNCTION_PLACEHOLDER = "_____________function_____________";
+export declare const CIRCULAR_PLACEHOLDER = "_____________circular_____________";
+export declare const NULL_PLACEHOLDER = "_____________null_____________";
+declare const assertUtil: {
+    fail(message?: string, stack?: string): never;
+    stringify(object: any): string;
+    replacePlaceholders(str: string): string;
+    dropInPlaceholders(obj: Record<string, any>): Record<string, any>;
+    dropInPlaceholder(obj: Record<string, any>, checker: (obj: any, depth: number) => boolean, placeholder: string, depth?: number): Record<string, any>;
+    doHaystacksPassCheck(haystacks: any[], needle: any, check: ISpruceAssert['doesInclude']): boolean;
+    assertTypeof(actual: any, type: string, message: string | undefined): void;
+    checkDoesThrowError(matcher: string | RegExp | undefined, err: Error, msg?: string | undefined): void;
+    partialContains(object: any, subObject: any): boolean | undefined;
+    valueAtPath(object: Record<string, any>, path: string): any;
+    parseIncludeNeedle(needle: any): {
+        needleHasArrayNotation: boolean;
+        path?: string | undefined;
+        expected?: any;
+    };
+    splitPathBasedOnArrayNotation(path: string, haystack: any): {
+        actualBeforeArray: any;
+        pathAfterFirstArray: string;
+    };
+    foundUsing3rdPartyIncludes(haystack: any, needle: any, isHaystackObject: boolean): boolean;
+};
+export default assertUtil;

package/build/assert/assert.utility.js

@@ -0,0 +1,182 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NULL_PLACEHOLDER = exports.CIRCULAR_PLACEHOLDER = exports.FUNCTION_PLACEHOLDER = exports.UNDEFINED_PLACEHOLDER = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const get_1 = __importDefault(require("lodash/get"));
+const includes_1 = __importDefault(require("lodash/includes"));
+const isObject_1 = __importDefault(require("lodash/isObject"));
+const isObjectLike_1 = __importDefault(require("lodash/isObjectLike"));
+const AssertionError_1 = __importDefault(require("../AssertionError"));
+exports.UNDEFINED_PLACEHOLDER = '_____________undefined_____________';
+exports.FUNCTION_PLACEHOLDER = '_____________function_____________';
+exports.CIRCULAR_PLACEHOLDER = '_____________circular_____________';
+exports.NULL_PLACEHOLDER = '_____________null_____________';
+const assertUtil = {
+    fail(message, stack) {
+        throw new AssertionError_1.default(message !== null && message !== void 0 ? message : 'Fail!', stack);
+    },
+    stringify(object) {
+        var _a;
+        let stringified;
+        if (Array.isArray(object)) {
+            stringified = `[\n${object.map((o) => this.stringify(o).split('\n').join('\n\t'))}\n]`;
+        }
+        else if (typeof object === 'number') {
+            // this hack allows the Spruce Test Reporter to render number errors (they got eaten by terminal-kit's style regex)
+            stringified = chalk_1.default.bgBlack.white(` ${object} `);
+        }
+        else if (object instanceof Error) {
+            stringified = `${(_a = object.stack) !== null && _a !== void 0 ? _a : object.message}`;
+        }
+        else if (object instanceof RegExp) {
+            stringified = `${object.toString()}`;
+        }
+        else if (typeof object === 'undefined') {
+            stringified = 'undefined';
+        }
+        else if (typeof object === 'string') {
+            stringified = `"${object}"`;
+        }
+        else {
+            stringified = JSON.stringify(assertUtil.dropInPlaceholders(object), undefined, 2).replace(/\\/g, '');
+        }
+        if (stringified.length > 5000) {
+            stringified =
+                stringified.substr(0, 1000) +
+                    '\n\n... big object ...\n\n' +
+                    stringified.substr(stringified.length - 1000);
+        }
+        stringified = assertUtil.replacePlaceholders(stringified);
+        return `\n\n${chalk_1.default.bold(stringified)}\n\n`;
+    },
+    replacePlaceholders(str) {
+        return str
+            .replace(new RegExp(`"${exports.UNDEFINED_PLACEHOLDER}"`, 'g'), chalk_1.default.italic('undefined'))
+            .replace(new RegExp(`"${exports.FUNCTION_PLACEHOLDER}"`, 'g'), chalk_1.default.italic('Function'))
+            .replace(new RegExp(`"${exports.NULL_PLACEHOLDER}"`, 'g'), chalk_1.default.italic('NULL'));
+    },
+    dropInPlaceholders(obj) {
+        const checkedObjects = [{ obj, depth: 0 }];
+        let updated = this.dropInPlaceholder(obj, (obj, depth) => {
+            if ((0, isObject_1.default)(obj) &&
+                checkedObjects.some((checked) => {
+                    return checked.obj === obj && checked.depth < depth;
+                })) {
+                return true;
+            }
+            checkedObjects.push({ obj, depth });
+            return false;
+        }, exports.CIRCULAR_PLACEHOLDER);
+        updated = this.dropInPlaceholder(updated, (obj) => typeof obj === 'undefined', exports.UNDEFINED_PLACEHOLDER);
+        updated = this.dropInPlaceholder(updated, (obj) => typeof obj === 'function', exports.FUNCTION_PLACEHOLDER);
+        updated = this.dropInPlaceholder(updated, (obj) => obj === null, exports.NULL_PLACEHOLDER);
+        return updated;
+    },
+    dropInPlaceholder(obj, checker, placeholder, depth = 1) {
+        if (!(0, isObject_1.default)(obj)) {
+            return obj;
+        }
+        const updated = Array.isArray(obj) ? [] : {};
+        Object.keys(obj).forEach((key) => {
+            //@ts-ignore
+            updated[key] =
+                // @ts-ignore
+                checker(obj[key], depth) ? placeholder : obj[key];
+            //@ts-ignore
+            if (typeof updated[key] !== 'function' && (0, isObject_1.default)(updated[key])) {
+                //@ts-ignore
+                updated[key] = this.dropInPlaceholder(
+                //@ts-ignore
+                updated[key], checker, placeholder, depth + 1);
+            }
+        });
+        return updated;
+    },
+    doHaystacksPassCheck(haystacks, needle, check) {
+        return !!haystacks.find((haystack) => {
+            try {
+                check(haystack, needle);
+                return true;
+            }
+            catch (_a) {
+                return false;
+            }
+        });
+    },
+    assertTypeof(actual, type, message) {
+        if (typeof actual !== type) {
+            this.fail(message !== null && message !== void 0 ? message : `${JSON.stringify(actual)} is not a ${type}`);
+        }
+    },
+    checkDoesThrowError(matcher, err, msg) {
+        var _a, _b;
+        const message = (_b = (_a = err.stack) !== null && _a !== void 0 ? _a : err.message) !== null && _b !== void 0 ? _b : '**MISSING ERROR MESSAGE**';
+        if (typeof matcher === 'string' && message.search(matcher) === -1) {
+            this.fail(msg !== null && msg !== void 0 ? msg : `Expected thrown error whose message contains: \n\n${chalk_1.default.bold(matcher)}\n\nbut got back:\n\n\`${chalk_1.default.bold(message)}\`.`, '\n\nStack: ' + err.stack);
+        }
+        else if (matcher instanceof RegExp && message.search(matcher) === -1) {
+            this.fail(msg !== null && msg !== void 0 ? msg : `Expected thrown error whose message matches the regex: \n\n${chalk_1.default.bold(matcher)}\n\nbut got back:\n\n\`${chalk_1.default.bold(message)}\`.`, '\n\nStack: ' + err.stack);
+        }
+    },
+    partialContains(object, subObject) {
+        const objProps = object ? Object.getOwnPropertyNames(object) : [];
+        const subProps = subObject ? Object.getOwnPropertyNames(subObject) : [];
+        if (objProps.length == 0 || subProps.length === 0) {
+            return;
+        }
+        if (subProps.length > objProps.length) {
+            return false;
+        }
+        for (const subProp of subProps) {
+            if (!Object.prototype.hasOwnProperty.call(object, subProp)) {
+                return false;
+            }
+            if ((!(0, isObjectLike_1.default)(object[subProp]) || !(0, isObjectLike_1.default)(subObject[subProp])) &&
+                object[subProp] !== subObject[subProp]) {
+                return false;
+            }
+            if ((0, isObjectLike_1.default)(object[subProp]) &&
+                (0, isObjectLike_1.default)(subObject[subProp]) &&
+                !this.partialContains(object[subProp], subObject[subProp])) {
+                return false;
+            }
+        }
+        return true;
+    },
+    valueAtPath(object, path) {
+        return (0, get_1.default)(object, path);
+    },
+    parseIncludeNeedle(needle) {
+        const path = Object.keys(needle)[0];
+        const expected = path && needle[path];
+        const needleHasArrayNotation = !!(path && path.search(/\[\]\./) > -1);
+        return { needleHasArrayNotation, path, expected };
+    },
+    splitPathBasedOnArrayNotation(path, haystack) {
+        var _a;
+        const pathParts = path.split('[].');
+        const pathToFirstArray = (_a = pathParts.shift()) !== null && _a !== void 0 ? _a : '';
+        const pathAfterFirstArray = pathParts.join('[].');
+        const actualBeforeArray = this.valueAtPath(haystack, pathToFirstArray);
+        return { actualBeforeArray, pathAfterFirstArray };
+    },
+    foundUsing3rdPartyIncludes(haystack, needle, isHaystackObject) {
+        let passed = false;
+        if (typeof haystack === 'string' &&
+            typeof needle === 'string' &&
+            haystack.search(needle) > -1) {
+            passed = true;
+        }
+        if (isHaystackObject && (0, includes_1.default)(haystack, needle)) {
+            passed = true;
+        }
+        if (isHaystackObject && this.partialContains(haystack, needle)) {
+            passed = true;
+        }
+        return passed;
+    },
+};
+exports.default = assertUtil;

package/build/decorators.d.ts

@@ -0,0 +1,8 @@
+/** Test decorator */
+declare function test(description?: string, ...args: any[]): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+declare namespace test {
+    var only: (description?: string | undefined, ...args: any[]) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+    var todo: (description?: string | undefined, ..._args: any[]) => (target: any, propertyKey: string) => void;
+    var skip: (description?: string | undefined, ...args: any[]) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+}
+export default test;

package/build/decorators.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/** Hooks up before, after, etc. */
+function hookupTestClass(target) {
+    if (target.__isTestingHookedUp) {
+        return;
+    }
+    target.__isTestingHookedUp = true;
+    const hooks = ['beforeAll', 'beforeEach', 'afterAll', 'afterEach'];
+    hooks.forEach((hook) => {
+        // Have they defined a hook
+        if (!target[hook]) {
+            return;
+        }
+        // @ts-ignore
+        if (global[hook]) {
+            // @ts-ignore
+            global[hook](async () => {
+                return target[hook]();
+            });
+        }
+    });
+}
+/** Test decorator */
+function test(description, ...args) {
+    return function (target, propertyKey, descriptor) {
+        // Lets attach before/after
+        hookupTestClass(target);
+        const bound = descriptor.value.bind(target);
+        // Make sure each test gets the spruce
+        it(description !== null && description !== void 0 ? description : propertyKey, async () => {
+            //@ts-ignore
+            global.activeTest = {
+                file: target.name,
+                test: propertyKey,
+            };
+            return bound(...args);
+        });
+    };
+}
+exports.default = test;
+/** Only decorator */
+test.only = (description, ...args) => {
+    return function (target, propertyKey, descriptor) {
+        // Lets attach before/after
+        hookupTestClass(target);
+        const bound = descriptor.value.bind(target);
+        // Make sure each test gets the spruce
+        it.only(description !== null && description !== void 0 ? description : propertyKey, async () => {
+            return bound(...args);
+        });
+    };
+};
+/** Todo decorator */
+test.todo = (description, ..._args) => {
+    return function (target, propertyKey) {
+        // Lets attach before/after
+        hookupTestClass(target);
+        // Make sure each test gets the spruce
+        it.todo(description !== null && description !== void 0 ? description : propertyKey);
+    };
+};
+/** Skip decorator */
+test.skip = (description, ...args) => {
+    return function (target, propertyKey, descriptor) {
+        // Lets attach before/after
+        hookupTestClass(target);
+        const bound = descriptor.value.bind(target);
+        // Make sure each test gets the spruce
+        it.skip(description !== null && description !== void 0 ? description : propertyKey, async () => {
+            return bound(...args);
+        });
+    };
+};

package/build/esm/AbstractSpruceTest.d.ts

@@ -0,0 +1,10 @@
+export default class AbstractSpruceTest {
+    protected static cwd: string;
+    protected static beforeAll(): Promise<void>;
+    protected static afterAll(): Promise<void>;
+    protected static beforeEach(): Promise<void>;
+    protected static afterEach(): Promise<void>;
+    protected static resolvePath(...filePath: string[]): string;
+    protected static wait(ms?: number): Promise<unknown>;
+    protected static log(...args: any[]): void;
+}