@khanacademy/wonder-blocks-testing 6.1.0 → 7.0.2

package/src/__docs__/types.custom-mount-props.stories.mdx

@@ -1,35 +0,0 @@
-import {Meta} from "@storybook/addon-docs";
-
-<Meta
-    title="Testing / Fixtures / Types / CustomMountProps<>"
-    parameters={{
-        chromatic: {
-            disableSnapshot: true,
-        },
-    }}
-/>
-
-# CustomMountProps&lt;&gt;
-
-```ts
-type CustomMountProps<TProps: {...}> = {|
-    /**
-     * The fixture props for the component to be rendered.
-     */
-    props: TProps,
-
-    /**
-     * The component to render.
-     */
-    component: React.ComponentType<TProps>,
-
-    /**
-     * The log callback for logging information.
-     */
-    log: (message: string, ...args: Array<any>) => mixed,
-|};
-```
-
-When creating a new adapter instance, the [`FixtureAdapterFactory`](/docs/testing-fixtures-types-fixtureadapterfactory--page) can take an optional component to be used as the root component for each fixture, also know as the mounting component.
-
-The `CustomMountProps<>` type defines the props that will be applied to that mounting component. It includes the `component` to be rendered as the fixture, the `props` to pass to that component, and the `log` callback, which the mounting component can use for any logging it may require.

package/src/__docs__/types.fixtures-adapter-factory.stories.mdx

@@ -1,23 +0,0 @@
-import {Meta} from "@storybook/addon-docs";
-
-<Meta
-    title="Testing / Fixtures / Types / FixturesAdapterFactory<>"
-    parameters={{
-        chromatic: {
-            disableSnapshot: true,
-        },
-    }}
-/>
-
-# FixturesAdapterFactory&lt;&gt;
-
-```ts
-type FixturesAdapterFactory<
-    TAdapterOptions: {...},
-    TAdapterExports: {...},
-> = (
-    MountingComponent: ?React.ComponentType<CustomWrapperProps<any>>,
-) => FixturesAdapter<TAdapterOptions, TAdapterExports>;
-```
-
-When implementing a custom [`FixturesAdapter<>`](/docs/testing-fixtures-types-fixturesadapter--page), you should provide a factory function for producing instances of the adapter. This type describes the signature of the factory function.

package/src/__docs__/types.fixtures-adapter-fixture-options.stories.mdx

@@ -1,35 +0,0 @@
-import {Meta} from "@storybook/addon-docs";
-
-<Meta
-    title="Testing / Fixtures / Types / FixturesAdapterFixtureOptions<>"
-    parameters={{
-        chromatic: {
-            disableSnapshot: true,
-        },
-    }}
-/>
-
-# FixturesAdapterFixtureOptions&lt;&gt;
-
-```ts
-type FixturesAdapterFixtureOptions<TProps: {...}> = {|
-    /**
-     * Description of the fixture.
-     */
-    +description: string,
-
-    /**
-     * Method to obtain props for the fixture.
-     */
-    +getProps: (options: $ReadOnly<GetPropsOptions>) => $ReadOnly<TProps>,
-
-    /**
-     * The component to render for this fixture.
-     */
-    +component: React.ComponentType<TProps>,
-|};
-```
-
-These options are passed to the `declareFixture()` function of a [`FixturesAdapterGroup<>`](/docs/testing-fixtures-types-fixturesadaptergroup--page).
-
-The `description` property is used to describe the fixture, the `component` is the component that renders the fixture, and the `getProps` method is used to obtain the props for that component.

package/src/__docs__/types.fixtures-adapter-group-options.stories.mdx

@@ -1,37 +0,0 @@
-import {Meta} from "@storybook/addon-docs";
-
-<Meta
-    title="Testing / Fixtures / Types / FixturesAdapterGroupOptions"
-    parameters={{
-        chromatic: {
-            disableSnapshot: true,
-        },
-    }}
-/>
-
-# FixturesAdapterGroupOptions
-
-```ts
-type FixturesAdapterGroupOptions = {|
-    /**
-     * The title of the group.
-     *
-     * If omitted, the adapter is free to generate a default or ask for one
-     * using the passed getDefaultTitle() function.
-     */
-    +title: ?string,
-
-    /**
-     * Description of the group.
-     */
-    +description: ?string,
-
-    /**
-     * Function that will generate a default title if an adapter cannot
-     * generate its own.
-     */
-    +getDefaultTitle: () => string,
-|};
-```
-
-These are options that the fixtures framework provides when `declareGroup()` is called on the configured adapter to create a new [`FixturesAdapterGroup<>`](/docs/testing-fixtures-types-fixturesadaptergroup--page).

package/src/__docs__/types.fixtures-adapter-group.stories.mdx

@@ -1,43 +0,0 @@
-import {Meta} from "@storybook/addon-docs";
-
-<Meta
-    title="Testing / Fixtures / Types / FixturesAdapterGroup<>"
-    parameters={{
-        chromatic: {
-            disableSnapshot: true,
-        },
-    }}
-/>
-
-# FixturesAdapterGroup&lt;&gt;
-
-```ts
-interface FixturesAdapterGroup<
-    TProps: {...},
-    TAdapterOptions: {...},
-    TAdapterExports: {...},
-> {
-    /**
-     * Declare a fixture.
-     */
-    declareFixture(
-        options: $ReadOnly<FixturesAdapterFixtureOptions<TProps>>,
-    ): void;
-
-    /**
-     * Close the group and obtain the exports, if the adapter requires any.
-     *
-     * @param {Options} adapterOptions Some options to pass to the adapter.
-     * Allows callers to tailor things to a specific adapter. How these options
-     * are used is adapter-specific.
-     *
-     * @returns {?Exports} The exports that the adapter requires fixture files
-     * to export.
-     */
-    closeGroup(
-        adapterOptions: $ReadOnly<Partial<TAdapterOptions>>,
-    ): ?$ReadOnly<TAdapterExports>;
-}
-```
-
-Each call to the [`fixtures()`](/docs/testing-fixtures-exports-fixtures--page) function invokes the `declareGroup()` method on the [`FixturesAdapter<>`](/docs/testing-fixtures-types-fixturesadapter--page) instance that has been configured using [`setupFixtures()`](/docs/testing-fixtures-exports-setupfixtures--page). The group that is returned by `declareGroup()` must match this interface.

package/src/__docs__/types.fixtures-adapter-options.stories.mdx

@@ -1,21 +0,0 @@
-import {Meta} from "@storybook/addon-docs";
-
-<Meta
-    title="Testing / Fixtures / Types / FixturesAdapterOptions"
-    parameters={{
-        chromatic: {
-            disableSnapshot: true,
-        },
-    }}
-/>
-
-# FixturesAdapterOptions
-
-```ts
-type FixturesAdapterOptions = {|
-    storybook?: StorybookOptions,
-    [adapterName: string]: {...},
-|};
-```
-
-Defines adapter-specific options. These are used with fixtures when needing to configure them for specific adapters.

package/src/__docs__/types.fixtures-adapter.stories.mdx

@@ -1,35 +0,0 @@
-import {Meta} from "@storybook/addon-docs";
-
-<Meta
-    title="Testing / Fixtures / Types / FixturesAdapter<>"
-    parameters={{
-        chromatic: {
-            disableSnapshot: true,
-        },
-    }}
-/>
-
-# FixturesAdapter&lt;&gt;
-
-```ts
-interface FixturesAdapter<TAdapterOptions: {...}, TAdapterExports: {...}> {
-    /**
-     * The name of the adapter.
-     */
-    get name(): string;
-
-    /**
-     * Declare a fixture group.
-     *
-     * @returns {FixturesAdapterGroup<TProps, TAdapterOptions, TAdapterExports>} The
-     * declared group.
-     */
-    declareGroup<TProps: {...}>(
-        options: $ReadOnly<AdapterGroupOptions>,
-    ): FixturesAdapterGroup<TProps, TAdapterOptions, TAdapterExports>;
-}
-```
-
-This type describes an adapter for use with our fixtures framework.
-
-

package/src/__docs__/types.fixtures-configuration.stories.mdx

@@ -1,35 +0,0 @@
-import {Meta} from "@storybook/addon-docs";
-
-<Meta
-    title="Testing / Fixtures / Types / FixturesConfiguration<>"
-    parameters={{
-        chromatic: {
-            disableSnapshot: true,
-        },
-    }}
-/>
-
-# FixturesConfiguration&lt;&gt;
-
-```ts
-type FixturesConfiguration<
-    TAdapterOptions: {...},
-    TAdapterExports: {...},
-> = {|
-    /**
-     * The adapter to use for declaring fixtures.
-     */
-    +adapter: FixturesAdapter<TAdapterOptions, TAdapterExports>,
-
-    /**
-     * Default options to apply to every fixture group.
-     *
-     * Each top-level option in this object will be merged with the equivalent
-     * top-level option that a specific fixture requests. Where collisions
-     * occur, the fixture options win.
-     */
-    +defaultAdapterOptions?: $ReadOnly<Partial<TAdapterOptions>>,
-|};
-```
-
-The configuration type passed to [`setupFixtures()`](/docs/testing-fixtures-exports-setupfixtures--page).

package/src/__docs__/types.fixtures-options.stories.mdx

@@ -1,51 +0,0 @@
-import {Meta} from "@storybook/addon-docs";
-
-<Meta
-    title="Testing / Fixtures / Types / FixturesOptions<>"
-    parameters={{
-        chromatic: {
-            disableSnapshot: true,
-        },
-    }}
-/>
-
-# FixturesOptions
-
-```ts
-type FixturesOptions<TProps: {...}> = {|
-    /**
-     * The component being tested by the fixtures.
-     */
-    component: React.ComponentType<TProps>,
-
-    /**
-     * Optional title of the fixture collection.
-     *
-     * Adapters may enforce a title, otherwise the component name is used.
-     */
-    title?: string,
-
-    /**
-     * Optional description of the fixture collection.
-     */
-    description?: string,
-
-    /**
-     * Optional default wrapper to apply around the component under test.
-     */
-    defaultWrapper?: React.ComponentType<TProps>,
-
-    /**
-     * Additional options to apply to specific adapters.
-     */
-    additionalAdapterOptions?: FixturesAdapterOptions,
-|};
-```
-
-This type is used to pass options to the [`fixtures()`](/docs/testing-fixtures-types-fixturesoptions--page) method when describing fixtures for a specific component.
-
-It specifies the `component` being rendered and tested by each fixtures. Optionally, it can also specify a `title` and `description` for the fixtures, as well as a `defaultWrapper` component to use by default to wrap the component under test for each fixture, and an `additionalAdapterOptions` object that allows each adapter type to be individually configured for the fixtures.
-
-If the `title` is omitted, the adapter can either request a default title, which will be based off the name of the `component` React component, or it can provide its own title based as necessary. For example, Storybook has a default title based off the file location of the component when the `title` is omitted.
-
-Some adapters may ignore the `description` field.

package/src/fixtures/__tests__/combine-options.test.js

@@ -1,65 +0,0 @@
-// @flow
-import * as CombineTopLevelModule from "../combine-top-level.js";
-
-import {combineOptions} from "../combine-options.js";
-
-jest.mock("../combine-top-level.js");
-
-describe("#combineOptions", () => {
-    beforeEach(() => {
-        jest.clearAllMocks();
-    });
-
-    it("should call combine once per property per object", () => {
-        // Arrange
-        const toBeCombined = [
-            {a: "test1", b: "test1"},
-            {b: "test2"},
-            {a: "test3", c: "test3"},
-        ];
-        const combineSpy = jest.spyOn(CombineTopLevelModule, "combineTopLevel");
-
-        // Act
-        combineOptions(...toBeCombined);
-
-        // Assert
-        expect(combineSpy).toHaveBeenCalledTimes(5);
-    });
-
-    it("should ignore falsy args", () => {
-        // Arrange
-        const toBeCombined = [null, {a: "test"}, {b: "test"}, 0, undefined];
-        const combineSpy = jest.spyOn(CombineTopLevelModule, "combineTopLevel");
-
-        // Act
-        combineOptions(...toBeCombined);
-
-        // Assert
-        expect(combineSpy).toHaveBeenCalledTimes(2);
-    });
-
-    it("should return the combined object", () => {
-        // Arrange
-        const toBeCombined = [
-            {a: "test1", b: "test1"},
-            {b: "test2"},
-            {a: "test3", c: "test3"},
-        ];
-        jest.spyOn(CombineTopLevelModule, "combineTopLevel").mockImplementation(
-            // Just for testing, we know the values are strings, so let's
-            // combine them with concatenation so we see the order of
-            // combination in the result.
-            (v1, v2) => `${v1 === undefined ? "" : v1}${v2}`,
-        );
-
-        // Act
-        const result = combineOptions(...toBeCombined);
-
-        // Assert
-        expect(result).toEqual({
-            a: "test1test3",
-            b: "test1test2",
-            c: "test3",
-        });
-    });
-});

package/src/fixtures/__tests__/combine-top-level.test.js

@@ -1,100 +0,0 @@
-// @flow
-import * as WonderStuffCoreModule from "@khanacademy/wonder-stuff-core";
-
-import {combineTopLevel} from "../combine-top-level.js";
-
-jest.mock("@khanacademy/wonder-stuff-core");
-
-describe("#combine", () => {
-    beforeEach(() => {
-        jest.resetAllMocks();
-    });
-
-    it.each([undefined, null, 42, "test", true])(
-        "should return a clone of val2 if val1 is %s",
-        (val1) => {
-            // Arrange
-            jest.spyOn(WonderStuffCoreModule, "clone").mockImplementation(
-                (v) => `CLONED: ${v}`,
-            );
-            const val2 = "VALUE2";
-
-            // Act
-            const result = combineTopLevel(val1, val2);
-
-            // Assert
-            expect(result).toEqual(`CLONED: VALUE2`);
-        },
-    );
-
-    it("should return a deduplicated array including values from val1 and val2, with val2 values first if both are arrays", () => {
-        // Arrange
-        jest.spyOn(WonderStuffCoreModule, "clone").mockImplementation((v) => v);
-        const val1 = ["VALUE1", "VALUE2", "VALUE2"];
-        const val2 = ["VALUE2", "VALUE3", "VALUE3"];
-
-        // Act
-        const result = combineTopLevel(val1, val2);
-
-        // Assert
-        expect(result).toEqual(["VALUE1", "VALUE2", "VALUE3"]);
-    });
-
-    it("should return a clone of val2 if val2 is an array but val1 is not", () => {
-        // Arrange
-        jest.spyOn(WonderStuffCoreModule, "clone").mockImplementation(
-            (v) => `CLONED: ${v}`,
-        );
-        const val1 = "VALUE1";
-        const val2 = ["VALUE1", "VALUE2", "VALUE3"];
-
-        // Act
-        const result = combineTopLevel(val1, val2);
-
-        // Assert
-        expect(result).toEqual("CLONED: VALUE1,VALUE2,VALUE3");
-    });
-
-    it("should return a clone of val2 if val2 is not an array but val1 is", () => {
-        // Arrange
-        jest.spyOn(WonderStuffCoreModule, "clone").mockImplementation(
-            (v) => `CLONED: ${JSON.stringify(v)}`,
-        );
-        const val1 = ["VALUE1", "VALUE2", "VALUE3"];
-        const val2 = {
-            key1: "VALUE1",
-        };
-
-        // Act
-        const result = combineTopLevel(val1, val2);
-
-        // Assert
-        expect(result).toEqual('CLONED: {"key1":"VALUE1"}');
-    });
-
-    it("should return a combination of val1 and val2 (cloned) properties with val2 overriding val1 when both are non-array objects", () => {
-        // Arrange
-        jest.spyOn(WonderStuffCoreModule, "clone").mockImplementation((v) => v);
-        const val1 = {
-            a: "val1_VALUE1",
-            b: "val1_VALUE2",
-            c: "val1_VALUE3",
-        };
-        const val2 = {
-            b: "val2_VALUE2",
-            c: "val2_VALUE3",
-            d: "val2_VALUE4",
-        };
-
-        // Act
-        const result = combineTopLevel(val1, val2);
-
-        // Assert
-        expect(result).toEqual({
-            a: "val1_VALUE1",
-            b: "val2_VALUE2",
-            c: "val2_VALUE3",
-            d: "val2_VALUE4",
-        });
-    });
-});

package/src/fixtures/__tests__/setup.test.js

@@ -1,71 +0,0 @@
-// @flow
-import {jest as wst} from "@khanacademy/wonder-stuff-testing";
-
-describe("#getConfiguration", () => {
-    it("should return the configuration passed during setup", () => {
-        // Arrange
-        const {setup, getConfiguration} = wst.isolateModules(() =>
-            require("../setup.js"),
-        );
-        const configuration = {
-            adapter: {
-                name: "mytestadapter",
-                declareGroup: jest.fn(),
-            },
-            defaultAdapterOptions: {},
-        };
-        setup(configuration);
-
-        // Act
-        const result = getConfiguration();
-
-        // Assert
-        expect(result).toBe(configuration);
-    });
-
-    it("should throw if setup has not been performed", () => {
-        // Arrange
-        const {getConfiguration} = wst.isolateModules(() =>
-            require("../setup.js"),
-        );
-
-        // Act
-        const underTest = () => getConfiguration();
-
-        // Assert
-        expect(underTest).toThrowErrorMatchingInlineSnapshot(
-            `"Not configured"`,
-        );
-    });
-});
-
-describe("#setup", () => {
-    it("should set the configuration returned by getConfiguration", () => {
-        // Arrange
-        const {setup, getConfiguration} = wst.isolateModules(() =>
-            require("../setup.js"),
-        );
-        const configuration1 = {
-            adapter: {
-                name: "mytestadapter1",
-                declareGroup: jest.fn(),
-            },
-            defaultAdapterOptions: {},
-        };
-        const configuration2 = {
-            adapter: {
-                name: "mytestadapter2",
-                declareGroup: jest.fn(),
-            },
-            defaultAdapterOptions: {},
-        };
-
-        // Act
-        setup(configuration1);
-        setup(configuration2);
-        const result = getConfiguration();
-
-        // Assert
-        expect(result).toBe(configuration2);
-    });
-});

package/src/fixtures/adapters/__tests__/__snapshots__/adapter-group.test.js.snap

@@ -1,9 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`AdapterGroup #constructor should throw if options are not valid (a string) 1`] = `"options must be an object"`;
-
-exports[`AdapterGroup #constructor should throw if options are not valid (null) 1`] = `"options must be an object"`;
-
-exports[`AdapterGroup #declareFixture should throw if options are not valid (a string) 1`] = `"options must be an object"`;
-
-exports[`AdapterGroup #declareFixture should throw if options are not valid (null) 1`] = `"options must be an object"`;

package/src/fixtures/adapters/__tests__/__snapshots__/adapter.test.js.snap

@@ -1,13 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`Adapter #constructor should throw if closeGroupFn is invalid 1`] = `"closeGroupFn must be a function"`;
-
-exports[`Adapter #constructor should throw if closeGroupFn is invalid 2`] = `"closeGroupFn must be a function"`;
-
-exports[`Adapter #constructor should throw if the name is invalid (     ) 1`] = `"name must be a non-empty string"`;
-
-exports[`Adapter #constructor should throw if the name is invalid () 1`] = `"name must be a non-empty string"`;
-
-exports[`Adapter #constructor should throw if the name is invalid (8) 1`] = `"name must be a string"`;
-
-exports[`Adapter #constructor should throw if the name is invalid (null) 1`] = `"name must be a string"`;