@everyonesoftware/common 2.0.0 → 4.0.0

package/tests/test.ts

@@ -1,228 +0,0 @@
-import { PromiseAsyncResult } from "../sources/promiseAsyncResult";
-import { PreCondition } from "../sources/preCondition";
-import { SyncResult } from "../sources/syncResult";
-import { isUndefinedOrNull, Type } from "../sources/types";
-
-/**
- * A type that can be used to make assertions during a test.
- */
-export abstract class Test
-{
-    /**
-     * Fail the current test with the provided message.
-     * @param message The message that explains why this test failed.
-     */
-    public abstract fail(message: string): never;
-
-    /**
-     * Assert that the provided value is undefined;
-     * @param value The value to check.
-     */
-    public assertUndefined(value: unknown): asserts value is undefined
-    {
-        Test.assertUndefined(this, value);
-    }
-
-    /**
-     * Assert that the provided value is undefined.
-     * @param test The current {@link Test}.
-     * @param value The value to check.
-     */
-    public static assertUndefined(test: Test, value: unknown): asserts value is undefined
-    {
-        test.assertSame(value, undefined);
-    }
-
-    /**
-     * Assert that the provided value is not undefined;
-     * @param value The value to check.
-     */
-    public assertNotUndefined<T>(value: T): asserts value is NonNullable<T>
-    {
-        Test.assertNotUndefined(this, value);
-    }
-
-    /**
-     * Assert that the provided value is not undefined.
-     * @param test The current {@link Test}.
-     * @param value The value to check.
-     */
-    public static assertNotUndefined<T>(test: Test, value: unknown): asserts value is NonNullable<T>
-    {
-        test.assertNotSame(value, undefined);
-    }
-
-    /**
-     * Assert that the provided value is null.
-     * @param value The value to check.
-     */
-    public assertNull(value: unknown): asserts value is null
-    {
-        Test.assertNull(this, value);
-    }
-
-    /**
-     * Assert that the provided value is null.
-     * @param value The value to check.
-     */
-    public static assertNull(test: Test, value: unknown): asserts value is null
-    {
-        test.assertSame(value, null);
-    }
-
-    /**
-     * Assert that the provided value is not null.
-     * @param value The value to check.
-     */
-    public assertNotNull<T>(value: T): asserts value is NonNullable<T>
-    {
-        Test.assertNull(this, value);
-    }
-
-    /**
-     * Assert that the provided value is not null.
-     * @param value The value to check.
-     */
-    public static assertNotNull<T>(test: Test, value: T): asserts value is NonNullable<T>
-    {
-        test.assertNotSame(value, null);
-    }
-
-    /**
-     * Assert that the provided value is not undefined and not null.
-     * @param value The value to check.
-     */
-    public assertNotUndefinedAndNotNull<T>(value: T): asserts value is NonNullable<T>
-    {
-        Test.assertNotUndefinedAndNotNull(this, value);
-    }
-
-    /**
-     * Assert that the provided value is not undefined and not null.
-     * @param value The value to check.
-     */
-    public static assertNotUndefinedAndNotNull<T>(test: Test, value: T): asserts value is NonNullable<T>
-    {
-        test.assertNotSame(value, null);
-        test.assertNotSame(value, undefined);
-    }
-
-    /**
-     * Assert that the provided values point to the same object.
-     * @param left The first value.
-     * @param right The second value.
-     */
-    public abstract assertSame<T>(left: T, right: T): void;
-
-    /**
-     * Assert that the provided values don't point to the same object.
-     * @param left The first value.
-     * @param right The second value.
-     */
-    public abstract assertNotSame<T>(left: T, right: T): void;
-
-    /**
-     * Assert that the provided values are equal.
-     * @param left The first value.
-     * @param right The second value.
-     * @param message A message that will be shown when the values are not equal.
-     */
-    public abstract assertEqual<T>(left: T, right: T, message?: string): void;
-
-    /**
-     * Assert that the provided values are not equal.
-     * @param left The first value.
-     * @param right The second value.
-     */
-    public abstract assertNotEqual<T>(left: T, right: T): void;
-
-    /**
-     * Assert that the provided value is false.
-     * @param value The value to check.
-     */
-    public assertFalse(value: boolean): asserts value is false
-    {
-        Test.assertFalse(this, value);
-    }
-
-    /**
-     * Assert that the provided value is false.
-     * @param value The value to check.
-     */
-    public static assertFalse(test: Test, value: boolean): asserts value is false
-    {
-        PreCondition.assertNotUndefinedAndNotNull(test, "test");
-
-        test.assertSame(value, false);
-    }
-
-    /**
-     * Assert that the provided value is true.
-     * @param value The value to check.
-     */
-    public assertTrue(value: boolean): asserts value is true
-    {
-        Test.assertTrue(this, value);
-    }
-
-    /**
-     * Assert that the provided value is true.
-     * @param value The value to check.
-     */
-    public static assertTrue(test: Test, value: boolean): asserts value is true
-    {
-        PreCondition.assertNotUndefinedAndNotNull(test, "test");
-
-        test.assertSame(value, true);
-    }
-
-    /**
-     * Assert that the provided action throws the provided {@link Error} when it is run.
-     * @param action The action to run.
-     * @param expectedError The optional expected {@link Error} to compare against the thrown
-     * {@link Error}. If the expected {@link Error} is not provided, then any {@link Error} will
-     * satisfy this assertion.
-     */
-    public abstract assertThrows(action: SyncResult<unknown> | (() => void), expectedError?: Error): void;
-
-    /**
-     * Assert that the provided action throws the provided {@link Error} when it is run.
-     * @param action The action to run.
-     * @param expectedError The expected {@link Error}.
-     */
-    public abstract assertThrowsAsync(action: PromiseLike<unknown> | (() => PromiseLike<unknown>), expectedError: Error): PromiseAsyncResult<void>;
-
-    /**
-     * Assert that the provided value is an instance of the provided {@link Type}.
-     * @param value The value to check.
-     * @param type The {@link Type} to check.
-     * @param expression The expression that produced the value.
-     * @param message An optional error message.
-     */
-    public assertInstanceOf<T>(value: unknown, type: Type<T>, typeCheck?: (value: unknown) => value is T): asserts value is T
-    {
-        return Test.assertInstanceOf(this, value, type, typeCheck);
-    }
-
-    /**
-     * Assert that the provided value is an instance of the provided {@link Type}.
-     * @param value The value to check.
-     * @param type The {@link Type} to check.
-     * @param expression The expression that produced the value.
-     * @param message An optional error message.
-     */
-    public static assertInstanceOf<T>(test: Test, value: unknown, type: Type<T>, typeCheck?: (value: unknown) => value is T): asserts value is T
-    {
-        PreCondition.assertNotUndefinedAndNotNull(type, "type");
-
-        if (isUndefinedOrNull(typeCheck))
-        {
-            typeCheck = ((value: unknown) => value instanceof type) as (value: unknown) => value is T;
-        }
-
-        if (!typeCheck(value))
-        {
-            test.fail(`Expected value to be of type ${type.name} but found ${value} instead.`);
-        }
-    }
-}

package/tests/testAction.ts

@@ -1,75 +0,0 @@
-import { JavascriptIterable } from "../sources/javascript";
-import { List } from "../sources/list";
-import { PreCondition } from "../sources/preCondition";
-import { join } from "../sources/strings";
-import { TestSkip } from "./testSkip";
-
-export class TestAction
-{
-    private readonly parent: TestAction | undefined;
-    private readonly name: string;
-    private readonly skip: TestSkip | undefined;
-    private readonly action: () => (void | Promise<void>);
-
-    private constructor(parent: TestAction | undefined, name: string, skip: TestSkip | undefined, action: () => (void | Promise<void>))
-    {
-        PreCondition.assertNotUndefinedAndNotNull(name, "name");
-        PreCondition.assertNotUndefinedAndNotNull(action, "action");
-
-        this.parent = parent;
-        this.name = name;
-        this.skip = skip;
-        this.action = action;
-    }
-
-    public static create(parent: TestAction | undefined, name: string, skip: TestSkip | undefined, action: () => (void | Promise<void>)): TestAction
-    {
-        return new TestAction(parent, name, skip, action);
-    }
-
-    public getParent(): TestAction | undefined
-    {
-        return this.parent;
-    }
-
-    public getName(): string
-    {
-        return this.name;
-    }
-
-    public getFullNameParts(): JavascriptIterable<string>
-    {
-        const result: List<string> = List.create();
-        if (this.parent)
-        {
-            result.addAll(this.parent.getFullNameParts());
-        }
-        result.add(this.getName());
-        return result;
-    }
-
-    public getFullName(): string
-    {
-        return join(" ", this.getFullNameParts());
-    }
-
-    public getSkip(): TestSkip | undefined
-    {
-        return this.skip || this.parent?.getSkip();
-    }
-
-    public shouldSkip(): boolean
-    {
-        return !!this.getSkip()?.getShouldSkip();
-    }
-
-    public getAction(): () => (void | Promise<void>)
-    {
-        return this.action;
-    }
-    
-    public runAsync(): void | Promise<void>
-    {
-        return this.action();
-    }
-}

package/tests/testActionTests.ts

@@ -1,93 +0,0 @@
-import { PreConditionError } from "../sources/preConditionError";
-import { join } from "../sources/strings";
-import { Test } from "./test";
-import { TestAction } from "./testAction";
-import { TestRunner } from "./testRunner";
-
-export function test(runner: TestRunner): void
-{
-    runner.testFile("testAction.ts", () =>
-    {
-        runner.testType("TestAction", () =>
-        {
-            runner.testFunction("create()", () =>
-            {
-                function createErrorTest(parent: TestAction | undefined, name: string, action: () => (void | Promise<void>), expected: Error): void
-                {
-                    runner.test(`with ${!parent ? runner.toString(parent) : "defined parent"}, ${runner.toString(name)}, and ${!action ? runner.toString(action) : "defined action"}`, (test: Test) =>
-                    {
-                        test.assertThrows(() => TestAction.create(parent, name, undefined, action), expected);
-                    });
-                }
-
-                createErrorTest(
-                    undefined,
-                    undefined!,
-                    () => {},
-                    new PreConditionError(join("\n", [
-                        "Expression: name",
-                        "Expected: not undefined and not null",
-                        "Actual: undefined",
-                    ])),
-                );
-                createErrorTest(
-                    undefined,
-                    null!,
-                    () => {},
-                    new PreConditionError(join("\n", [
-                        "Expression: name",
-                        "Expected: not undefined and not null",
-                        "Actual: null",
-                    ])),
-                );
-                createErrorTest(
-                    undefined,
-                    "a",
-                    undefined!,
-                    new PreConditionError(join("\n", [
-                        "Expression: action",
-                        "Expected: not undefined and not null",
-                        "Actual: undefined",
-                    ])),
-                );
-                createErrorTest(
-                    undefined,
-                    "a",
-                    null!,
-                    new PreConditionError(join("\n", [
-                        "Expression: action",
-                        "Expected: not undefined and not null",
-                        "Actual: null",
-                    ])),
-                );
-
-                function createTest(parent: TestAction | undefined, name: string, action: () => (void | Promise<void>)): void
-                {
-                    runner.test(`with ${!parent ? runner.toString(parent) : "defined parent"}, ${runner.toString(name)}, and ${!action ? runner.toString(action) : "defined action"}`, (test: Test) =>
-                    {
-                        const testAction: TestAction = TestAction.create(parent, name, undefined, action);
-                        test.assertNotUndefinedAndNotNull(testAction);
-                        test.assertSame(parent, testAction.getParent());
-                        test.assertSame(name, testAction.getName());
-                        test.assertSame(action, testAction.getAction());
-                    });
-                }
-
-                createTest(undefined, "b", () => {});
-            });
-
-            runner.testFunction("run()", (test: Test) =>
-            {
-                let counter: number = 0;
-                const action: TestAction = TestAction.create(undefined, "c", undefined, () => { counter++; });
-                test.assertEqual(0, counter);
-
-                for (let i = 1; i <= 3; i++)
-                {
-                    action.runAsync();
-                    test.assertEqual(i, counter);
-                }
-            });
-        });
-    });
-}

package/tests/testFailureTests.ts

@@ -1,12 +0,0 @@
-import { TestRunner } from "./testRunner";
-
-export function test(runner: TestRunner): void
-{
-    runner.testFile("testFailure.ts", () =>
-    {
-        runner.testType("TestFailure", () =>
-        {
-            
-        });
-    });
-}

package/tests/testRunner.ts

@@ -1,267 +0,0 @@
-import { andList } from "../sources/english";
-import { Iterable } from "../sources/iterable";
-import { PreCondition } from "../sources/preCondition";
-import { ToStringFunctions } from "../sources/toStringFunctions";
-import {
-    getName, getParameterCount, isBoolean, isFunction, isString, Type
-} from "../sources/types";
-import { Test } from "./test";
-import { TestSkip } from "./testSkip";
-
-/**
- * A type that can be used to run tests.
- */
-export abstract class TestRunner
-{
-    /**
-     * Get a {@link string} that concatenates the {@link string} representation of each
-     * of the provided values into an "and-list".
-     * @param values The values to concatenate.
-     */
-    public andList(values: unknown[] | Iterable<unknown>): string
-    {
-        return TestRunner.andList(this, values);
-    }
-
-    /**
-     * Get a {@link string} that concatenates the {@link string} representation of each
-     * of the provided values into an "and-list".
-     * @param values The values to concatenate.
-     */
-    public static andList(runner: TestRunner, values: unknown[] | Iterable<unknown>): string
-    {
-        PreCondition.assertNotUndefinedAndNotNull(runner, "runner");
-        PreCondition.assertNotUndefinedAndNotNull(values, "values");
-
-        return andList(values.map((value: unknown) => runner.toString(value)));
-    }
-
-    /**
-     * Get the {@link string} representation of the provided value.
-     * @param value The value to get the {@link string} representation of.
-     */
-    public toString(value: unknown): string
-    {
-        return TestRunner.toString(this, value);
-    }
-
-    /**
-     * Get the {@link string} representation of the provided value.
-     * @param value The value to get the {@link string} representation of.
-     */
-    public static toString(_runner: TestRunner, value: unknown): string
-    {
-        const toStringFunctions: ToStringFunctions = ToStringFunctions.create();
-        return toStringFunctions.toString(value);
-    }
-
-    public skip(message?: string): TestSkip;
-    /**
-     * Create a {@link TestSkip} object that will prevent tests from being run.
-     * @param shouldSkip Whether these tests should be skipped.
-     * @param message The message that explains why the tests are being skipped.
-     */
-    public skip(shouldSkip: boolean, message?: string): TestSkip;
-    skip(messageOrShouldSkip?: string | boolean | undefined, message?: string): TestSkip
-    {
-        let shouldSkip: boolean;
-        if (!isBoolean(messageOrShouldSkip))
-        {
-            shouldSkip = true;
-            message = messageOrShouldSkip;
-        }
-        else
-        {
-            shouldSkip = messageOrShouldSkip;
-        }
-        return TestRunner.skip(this, shouldSkip, message);
-    }
-
-    /**
-     * Create a {@link TestSkip} object that will prevent tests from being run.
-     * @param shouldSkip Whether these tests should be skipped.
-     * @param message The message that explains why the tests are being skipped.
-     */
-    public static skip(_runner: TestRunner, shouldSkip?: boolean, message?: string): TestSkip
-    {
-        return TestSkip.create(shouldSkip, message);
-    }
-
-    public static runTestAction(runner: TestRunner, name: string, skip: TestSkip | undefined, testAction: (() => void) | ((test: Test) => void)): void
-    {
-        if (getParameterCount(testAction) === 0)
-        {
-            runner.testGroup(name, skip, <() => void>testAction);
-        }
-        else
-        {
-            runner.test(name, skip, <(test: Test) => void>testAction);
-        }
-    }
-
-    /**
-     * Create a test group that will test the provided file.
-     * @param fileName The name of the file that is being tested.
-     * @param testAction The action that will run the tests.
-     */
-    public testFile(fileName: string, testAction: (() => void) | ((test: Test) => void)): void;
-    /**
-     * Create a test group that will test the provided file.
-     * @param fileName The name of the file that is being tested.
-     * @param skip A value that indicates whether these tests should be skipped.
-     * @param testAction The action that will run the tests.
-     */
-    public testFile(fileName: string, skip: TestSkip | undefined, testAction: (() => void) | ((test: Test) => void)): void;
-    testFile(fileName: string, skipOrTestAction: TestSkip | ((() => void) | ((test: Test) => void)) | undefined, testAction?: (() => void) | ((test: Test) => void)): void
-    {
-        TestRunner.testFile(this, fileName, skipOrTestAction, testAction);
-    }
-
-    /**
-     * Create a test group that will test the provided file.
-     * @param runner The {@link TestRunner} that will run the tests.
-     * @param fileName The name of the file that is being tested.
-     * @param testAction The action that will run the tests.
-     */
-    public static testFile(runner: TestRunner, fileName: string, skipOrTestAction: TestSkip | ((() => void) | ((test: Test) => void)) | undefined, testAction?: (() => void) | ((test: Test) => void)): void
-    {
-        PreCondition.assertNotUndefinedAndNotNull(runner, "runner");
-        PreCondition.assertNotUndefinedAndNotNull(fileName, "fileName");
-        PreCondition.assertNotEmpty(fileName, "fileName");
-        let skip: TestSkip | undefined;
-        if (isFunction(skipOrTestAction))
-        {
-            PreCondition.assertUndefined(testAction, "testAction");
-
-            skip = undefined;
-            testAction = skipOrTestAction;
-        }
-        else
-        {
-            skip = skipOrTestAction;
-        }
-        PreCondition.assertNotUndefinedAndNotNull(testAction, "testAction");
-
-        TestRunner.runTestAction(runner, fileName, skip, testAction);
-    }
-
-    /**
-     * Create a test group that will test the provided type.
-     * @param type The {@link Type} or name of the type that is being tested.
-     * @param testAction The action that will run the tests.
-     */
-    public testType(typeNameOrType: string | Type<unknown>, testAction: (() => void) | ((test: Test) => void)): void;
-    /**
-     * Create a test group that will test the provided type.
-     * @param type The {@link Type} or name of the type that is being tested.
-     * @param skip A value that indicates whether these tests should be skipped.
-     * @param testAction The action that will run the tests.
-     */
-    public testType(typeNameOrType: string | Type<unknown>, skip: TestSkip | undefined, testAction: (() => void) | ((test: Test) => void)): void;
-    testType(typeNameOrType: string | Type<unknown>, skipOrTestAction: TestSkip | undefined | ((() => void) | ((test: Test) => void)), testAction?: (() => void) | ((test: Test) => void)): void
-    {
-        TestRunner.testType(this, typeNameOrType, skipOrTestAction, testAction);
-    }
-
-    /**
-     * Create a test group that will test the provided type.
-     * @param runner The {@link TestRunner} that will run the tests.
-     * @param type The {@link Type} or name of the type that is being tested.
-     * @param testAction The action that will run the tests.
-     */
-    public static testType(runner: TestRunner, typeNameOrType: string | Type<unknown>, skipOrTestAction: TestSkip | undefined | ((() => void) | ((test: Test) => void)), testAction: ((() => void) | ((test: Test) => void)) | undefined): void
-    {
-        PreCondition.assertNotUndefinedAndNotNull(runner, "runner");
-        PreCondition.assertNotUndefinedAndNotNull(typeNameOrType, "typeNameOrType");
-        let typeName: string;
-        if (isString(typeNameOrType))
-        {
-            typeName = typeNameOrType;
-        }
-        else
-        {
-            typeName = getName(typeNameOrType);
-        }
-        PreCondition.assertNotEmpty(typeName, "typeName");
-        let skip: TestSkip | undefined;
-        if (isFunction(skipOrTestAction))
-        {
-            PreCondition.assertUndefined(testAction, "testAction");
-
-            skip = undefined;
-            testAction = skipOrTestAction;
-        }
-        else
-        {
-            skip = skipOrTestAction;
-        }
-        PreCondition.assertNotUndefinedAndNotNull(testAction, "testAction");
-
-        TestRunner.runTestAction(runner, typeName, skip, testAction);
-    }
-
-    /**
-     * Create a test group that will test the provided function.
-     * @param functionSignature The signature of the function that is being tested.
-     * @param testAction The action that will run the tests.
-     */
-    public testFunction(functionSignature: string, testAction: (() => void) | ((test: Test) => void)): void;
-    public testFunction(functionSignature: string, skip: TestSkip | undefined, testAction: (() => void) | ((test: Test) => void)): void;
-    testFunction(functionSignature: string, skipOrTestAction: TestSkip | undefined | ((() => void) | ((test: Test) => void)), testAction?: (() => void) | ((test: Test) => void)): void
-    {
-        TestRunner.testFunction(this, functionSignature, skipOrTestAction, testAction);
-    }
-
-    /**
-     * Create a test group that will test the provided function.
-     * @param runner The {@link TestRunner} that will run the tests.
-     * @param functionSignature The signature of the function that is being tested.
-     * @param testAction The action that will run the tests.
-     */
-    public static testFunction(runner: TestRunner, functionSignature: string, skipOrTestAction: TestSkip | undefined | ((() => void) | ((test: Test) => void)), testAction: ((() => void) | ((test: Test) => void)) | undefined): void
-    {
-        PreCondition.assertNotUndefinedAndNotNull(runner, "runner");
-        PreCondition.assertNotEmpty(functionSignature, "functionSignature");
-        let skip: TestSkip | undefined;
-        if (isFunction(skipOrTestAction))
-        {
-            PreCondition.assertUndefined(testAction, "testAction");
-
-            skip = undefined;
-            testAction = skipOrTestAction;
-        }
-        else
-        {
-            skip = skipOrTestAction;
-        }
-        PreCondition.assertNotUndefinedAndNotNull(testAction, "testAction");
-
-        TestRunner.runTestAction(runner, functionSignature, skip, testAction);
-    }
-
-    /**
-     * Create and run a test group with the provided name.
-     * @param testGroupName The name of the test group to run.
-     * @param testAction The action that runs the test group.
-     */
-    public abstract testGroup(testGroupName: string, testAction: () => void): void;
-    /**
-     * Create and run a test group with the provided name.
-     * @param testGroupName The name of the test group to run.
-     * @param testAction The action that runs the test group.
-     */
-    public abstract testGroup(testGroupName: string, skip: TestSkip | undefined, testAction: () => void): void;
-
-    /**
-     * Create and run a test with the provided name.
-     * @param testName The name of the test to run.
-     * @param testAction The action that runs the test.
-     */
-    public abstract test(testName: string, testAction: (test: Test) => void): void;
-    /**
-     * Create and run a test with the provided name.
-     * @param testName The name of the test to run.
-     * @param testAction The action that runs the test.
-     */
-    public abstract test(testName: string, skip: TestSkip | undefined, testAction: (test: Test) => void): void;
-}