@khanacademy/wonder-blocks-testing 6.1.0 → 7.0.2

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

@@ -1,223 +0,0 @@
-// @flow
-import {AdapterGroup} from "../adapter-group.js";
-
-describe("AdapterGroup", () => {
-    describe("#constructor", () => {
-        it("should throw if closeGroupFn is not valid", () => {
-            // Arrange
-            const badCloseGroupFn: any = null;
-
-            // Act
-            const act = () =>
-                new AdapterGroup(badCloseGroupFn, {
-                    title: "TITLE",
-                    description: null,
-                    getDefaultTitle: () => {
-                        throw new Error("NOT IMPLEMENTED");
-                    },
-                });
-
-            expect(act).toThrowErrorMatchingInlineSnapshot(
-                `"closeGroupFn must be a function"`,
-            );
-        });
-
-        it.each([null, "a string"])(
-            "should throw if options are not valid (%s)",
-            (badOptions) => {
-                // Arrange
-
-                // Act
-                const act = () => new AdapterGroup(() => {}, badOptions);
-
-                // Assert
-                expect(act).toThrowErrorMatchingSnapshot();
-            },
-        );
-    });
-
-    describe("#closeGroup", () => {
-        it("should call closeGroupFn with group options and empty fixtures if there are none", () => {
-            // Arrange
-            const closeGroupFn = jest.fn();
-            const groupOptions = {
-                title: "TITLE",
-                description: null,
-                getDefaultTitle: () => {
-                    throw new Error("NOT IMPLEMENTED");
-                },
-            };
-            const adapterGroup = new AdapterGroup(closeGroupFn, groupOptions);
-
-            // Act
-            adapterGroup.closeGroup();
-
-            // Assert
-            expect(closeGroupFn).toHaveBeenCalledWith(groupOptions, null, []);
-        });
-
-        it("should call closeGroupFn with group options, adapter options,  and empty fixtures if there are none", () => {
-            // Arrange
-            const closeGroupFn = jest.fn();
-            const groupOptions = {
-                title: "TITLE",
-                description: null,
-                getDefaultTitle: () => {
-                    throw new Error("NOT IMPLEMENTED");
-                },
-            };
-            const adapterSpecificOptions = {
-                adapterSpecificOption: "adapterSpecificOption",
-            };
-            const adapterGroup = new AdapterGroup(closeGroupFn, groupOptions);
-
-            // Act
-            adapterGroup.closeGroup(adapterSpecificOptions);
-
-            // Assert
-            expect(closeGroupFn).toHaveBeenCalledWith(
-                groupOptions,
-                adapterSpecificOptions,
-                [],
-            );
-        });
-
-        it("should call closeGroupFn with fixtures if some were declared", () => {
-            // Arrange
-            const closeGroupFn = jest.fn();
-            const groupOptions = {
-                title: "TITLE",
-                description: "DESCRIPTION",
-                getDefaultTitle: () => {
-                    throw new Error("NOT IMPLEMENTED");
-                },
-            };
-            const adapterGroup = new AdapterGroup(closeGroupFn, groupOptions);
-            const fixture = {
-                component: () => null,
-                description: "FIXTURE_DESCRIPTION",
-                getProps: jest.fn(),
-            };
-
-            // Act
-            adapterGroup.declareFixture(fixture);
-            adapterGroup.closeGroup();
-
-            // Assert
-            expect(closeGroupFn).toHaveBeenCalledWith(groupOptions, null, [
-                fixture,
-            ]);
-        });
-
-        it("should throw if called when group has already closed", () => {
-            // Arrange
-            const closeGroupFn = jest.fn();
-            const groupOptions = {
-                title: "TITLE",
-                description: null,
-                getDefaultTitle: () => {
-                    throw new Error("NOT IMPLEMENTED");
-                },
-            };
-            const adapterGroup = new AdapterGroup(closeGroupFn, groupOptions);
-            adapterGroup.closeGroup();
-
-            // Act
-            const act = () => adapterGroup.closeGroup();
-
-            // Assert
-            expect(act).toThrowErrorMatchingInlineSnapshot(
-                `"Group already closed"`,
-            );
-        });
-    });
-
-    describe("#declareFixture", () => {
-        it.each([null, "a string"])(
-            "should throw if options are not valid (%s)",
-            (badFixtureOptions) => {
-                // Arrange
-                const closeGroupFn = jest.fn();
-                const groupOptions = {
-                    title: "TITLE",
-                    description: null,
-                    getDefaultTitle: () => {
-                        throw new Error("NOT IMPLEMENTED");
-                    },
-                };
-                const adapterGroup = new AdapterGroup(
-                    closeGroupFn,
-                    groupOptions,
-                );
-
-                // Act
-                const act = () =>
-                    adapterGroup.declareFixture(badFixtureOptions);
-
-                // Assert
-                expect(act).toThrowErrorMatchingSnapshot();
-            },
-        );
-
-        it("should add fixtures for inclusion in the closeGroup call", () => {
-            // Arrange
-            const closeGroupFn = jest.fn();
-            const groupOptions = {
-                title: "TITLE",
-                description: "DESCRIPTION",
-                getDefaultTitle: () => {
-                    throw new Error("NOT IMPLEMENTED");
-                },
-            };
-            const adapterGroup = new AdapterGroup(closeGroupFn, groupOptions);
-            const fixture1 = {
-                component: () => null,
-                description: "FIXTURE_DESCRIPTION1",
-                getProps: jest.fn(),
-            };
-            const fixture2 = {
-                component: () => null,
-                description: "FIXTURE_DESCRIPTION2",
-                getProps: jest.fn(),
-            };
-
-            // Act
-            adapterGroup.declareFixture(fixture1);
-            adapterGroup.declareFixture(fixture2);
-            adapterGroup.closeGroup();
-
-            // Assert
-            expect(closeGroupFn).toHaveBeenCalledWith(groupOptions, null, [
-                fixture1,
-                fixture2,
-            ]);
-        });
-
-        it("should throw if called when group has already closed", () => {
-            // Arrange
-            const closeGroupFn = jest.fn();
-            const groupOptions = {
-                title: "TITLE",
-                description: null,
-                getDefaultTitle: () => {
-                    throw new Error("NOT IMPLEMENTED");
-                },
-            };
-            const adapterGroup = new AdapterGroup(closeGroupFn, groupOptions);
-            adapterGroup.closeGroup();
-
-            // Act
-            const act = () =>
-                adapterGroup.declareFixture({
-                    component: () => null,
-                    description: "FIXTURE_DESCRIPTION",
-                    getProps: jest.fn(),
-                });
-
-            // Assert
-            expect(act).toThrowErrorMatchingInlineSnapshot(
-                `"Cannot declare fixtures after closing the group"`,
-            );
-        });
-    });
-});

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

@@ -1,97 +0,0 @@
-// @flow
-import {Adapter} from "../adapter.js";
-
-import * as AdapterGroupModule from "../adapter-group.js";
-
-jest.mock("../adapter-group.js");
-
-describe("Adapter", () => {
-    describe("#constructor", () => {
-        it.each([null, 8, "", "     "])(
-            "should throw if the name is invalid (%s)",
-            (invalidName) => {
-                // Arrange
-
-                // Act
-                const act = () => new Adapter(invalidName, () => {});
-
-                // Assert
-                expect(act).toThrowErrorMatchingSnapshot();
-            },
-        );
-
-        it.each([null, 5])(
-            "should throw if closeGroupFn is invalid",
-            (invalidCloseGroupFn) => {
-                // Arrange
-
-                // Act
-                const act = () => new Adapter("name", invalidCloseGroupFn);
-
-                // Assert
-                expect(act).toThrowErrorMatchingSnapshot();
-            },
-        );
-    });
-
-    describe("@name", () => {
-        it("should match the value passed during construction", () => {
-            // Arrange
-            const name = "adapter_name";
-            const adapter = new Adapter(name, () => {});
-
-            // Act
-            const result = adapter.name;
-
-            // Assert
-            expect(result).toBe(name);
-        });
-    });
-
-    describe("#declareGroup", () => {
-        it("should pass the closeGroupFn and options to the adapter group", () => {
-            // Arrange
-            const closeGroupFn = jest.fn();
-            const adapter = new Adapter("adapter_name", closeGroupFn);
-            const options = {
-                title: "group_title",
-                description: "group_description",
-                getDefaultTitle: () => {
-                    throw new Error("NOT IMPLEMENTED");
-                },
-            };
-            const adapterGroupSpy = jest
-                .spyOn(AdapterGroupModule, "AdapterGroup")
-                .mockImplementation(() => {});
-
-            // Act
-            adapter.declareGroup(options);
-
-            // Assert
-            expect(adapterGroupSpy).toHaveBeenCalledWith(closeGroupFn, options);
-        });
-
-        it("should return the created AdapterGroup", () => {
-            // Arrange
-            const adapter = new Adapter("adapter_name", () => {});
-            const adapterGroup: any = {
-                whatAmI: "ADAPTER_GROUP",
-            };
-            jest.spyOn(AdapterGroupModule, "AdapterGroup").mockImplementation(
-                () => adapterGroup,
-            );
-
-            // Act
-            const result = adapter.declareGroup({
-                title: "group_title",
-                description: "group_description",
-                getDefaultTitle: () => {
-                    throw new Error("NOT IMPLEMENTED");
-                },
-            });
-
-            // Assert
-            expect(result).toBe(adapterGroup);
-        });
-    });
-});

package/src/fixtures/adapters/__tests__/storybook.test.js

@@ -1,369 +0,0 @@
-// @flow
-import * as React from "react";
-import {render, screen} from "@testing-library/react";
-import * as AddonActionsModule from "@storybook/addon-actions";
-import {getAdapter} from "../storybook.js";
-
-import * as AdapterModule from "../adapter.js";
-
-jest.mock("../adapter.js");
-jest.mock("@storybook/addon-actions");
-
-describe("Storybook Adapter", () => {
-    beforeEach(() => {
-        jest.resetAllMocks();
-    });
-
-    describe("#getAdapter", () => {
-        it("should create an Adapter instance", () => {
-            // Arrange
-            const adapterSpy = jest
-                .spyOn(AdapterModule, "Adapter")
-                .mockImplementation(() => {});
-
-            // Act
-            getAdapter();
-
-            // Assert
-            expect(adapterSpy).toHaveBeenCalledWith(
-                "storybook",
-                expect.any(Function),
-            );
-        });
-
-        it("should return the created Adapter instance", () => {
-            // Arrangejest
-            const fakeAdapter = {
-                iAmA: "FAKE_ADAPTER",
-            };
-            jest.spyOn(AdapterModule, "Adapter").mockImplementation(
-                () => fakeAdapter,
-            );
-
-            // Act
-            const result = getAdapter();
-
-            // Assert
-            expect(result).toBe(fakeAdapter);
-        });
-
-        describe("closeGroupFn", () => {
-            it("should return the storybook exports", () => {
-                // Arrange
-                const adapterSpy = jest
-                    .spyOn(AdapterModule, "Adapter")
-                    .mockImplementation(() => {});
-                getAdapter();
-                const closeGroupFn = adapterSpy.mock.calls[0][1];
-
-                // Act
-                const result = closeGroupFn(
-                    {
-                        title: "TITLE",
-                        description: "DESCRIPTION",
-                    },
-                    {
-                        adapterOption1: "adapterOption1",
-                        adapterOption2: "adapterOption2",
-                    },
-                    [
-                        {
-                            description:
-                                "🎉 This is a story with legal and illegal characters",
-                            component: () => "I AM A COMPONENT",
-                            getProps: () => ({
-                                these: "areProps",
-                            }),
-                        },
-                    ],
-                );
-
-                // Assert
-                expect(result).toStrictEqual({
-                    default: {
-                        title: "TITLE",
-                        adapterOption1: "adapterOption1",
-                        adapterOption2: "adapterOption2",
-                    },
-                    "1ThisIsAStoryWithLegalAndIllegalCharacters":
-                        expect.any(Function),
-                });
-            });
-        });
-
-        describe("exported story", () => {
-            it("should inject API into getProps generator", () => {
-                // Arrange
-                const adapterSpy = jest
-                    .spyOn(AdapterModule, "Adapter")
-                    .mockImplementation(() => {});
-                getAdapter();
-                const closeGroupFn = adapterSpy.mock.calls[0][1];
-                const getPropsStub = jest.fn();
-
-                // Act
-                closeGroupFn(
-                    {
-                        title: "TITLE",
-                        description: "DESCRIPTION",
-                    },
-                    null,
-                    [
-                        {
-                            description:
-                                "🎉 This is a story with legal and illegal characters",
-                            component: () => "I AM A COMPONENT",
-                            getProps: getPropsStub,
-                        },
-                    ],
-                );
-
-                // Assert
-                expect(getPropsStub).toHaveBeenCalledWith({
-                    log: expect.any(Function),
-                    logHandler: expect.any(Function),
-                });
-            });
-
-            it("should inject log function that logs to storybook actions", () => {
-                // Arrange
-                const adapterSpy = jest
-                    .spyOn(AdapterModule, "Adapter")
-                    .mockImplementation(() => {});
-                getAdapter();
-                const actionReturnFn = jest.fn();
-                const actionSpy = jest
-                    .spyOn(AddonActionsModule, "action")
-                    .mockReturnValue(actionReturnFn);
-                const closeGroupFn = adapterSpy.mock.calls[0][1];
-                const getPropsStub = jest.fn();
-                closeGroupFn(
-                    {
-                        title: "TITLE",
-                        description: "DESCRIPTION",
-                    },
-                    null,
-                    [
-                        {
-                            description:
-                                "🎉 This is a story with legal and illegal characters",
-                            component: () => "I AM A COMPONENT",
-                            getProps: getPropsStub,
-                        },
-                    ],
-                );
-                const {log: logFn} = getPropsStub.mock.calls[0][0];
-
-                // Act
-                logFn("MESSAGE", "ARG1", "ARG2");
-
-                // Assert
-                expect(actionSpy).toHaveBeenCalledWith("MESSAGE");
-                expect(actionReturnFn).toHaveBeenCalledWith("ARG1", "ARG2");
-            });
-
-            it("should inject logHandler function that logs to storybook actions", () => {
-                // Arrange
-                const adapterSpy = jest
-                    .spyOn(AdapterModule, "Adapter")
-                    .mockImplementation(() => {});
-                getAdapter();
-                const actionReturnFn = jest.fn();
-                const actionSpy = jest
-                    .spyOn(AddonActionsModule, "action")
-                    .mockReturnValue(actionReturnFn);
-                const closeGroupFn = adapterSpy.mock.calls[0][1];
-                const getPropsStub = jest.fn();
-                closeGroupFn(
-                    {
-                        title: "TITLE",
-                        description: "DESCRIPTION",
-                    },
-                    null,
-                    [
-                        {
-                            description:
-                                "🎉 This is a story with legal and illegal characters",
-                            component: () => "I AM A COMPONENT",
-                            getProps: getPropsStub,
-                        },
-                    ],
-                );
-                const {logHandler: logHandlerFn} =
-                    getPropsStub.mock.calls[0][0];
-
-                // Act
-                const logFn = logHandlerFn("MESSAGE");
-                logFn("ARG1", "ARG2");
-
-                // Assert
-                expect(actionSpy).toHaveBeenCalledWith("MESSAGE");
-                expect(actionReturnFn).toHaveBeenCalledWith("ARG1", "ARG2");
-            });
-
-            it("should have args attached", () => {
-                // Arrange
-                const adapterSpy = jest
-                    .spyOn(AdapterModule, "Adapter")
-                    .mockImplementation(() => {});
-                getAdapter();
-                const closeGroupFn = adapterSpy.mock.calls[0][1];
-                const props = {
-                    this: "isAProp",
-                    andSo: "isThis",
-                };
-
-                // Act
-                const {"1ASimpleStory": result} = closeGroupFn(
-                    {
-                        title: "TITLE",
-                        description: "DESCRIPTION",
-                    },
-                    null,
-                    [
-                        {
-                            description: "A simple story",
-                            component: () => "I AM A COMPONENT",
-                            getProps: () => props,
-                        },
-                    ],
-                );
-
-                // Assert
-                expect(result).toHaveProperty("args", props);
-            });
-
-            it("should have story name attached", () => {
-                // Arrange
-                const adapterSpy = jest
-                    .spyOn(AdapterModule, "Adapter")
-                    .mockImplementation(() => {});
-                getAdapter();
-                const closeGroupFn = adapterSpy.mock.calls[0][1];
-
-                // Act
-                const {"1ASimpleStory": result} = closeGroupFn(
-                    {
-                        title: "TITLE",
-                        description: "DESCRIPTION",
-                    },
-                    null,
-                    [
-                        {
-                            description: "A simple story",
-                            component: () => "I AM A COMPONENT",
-                            getProps: () => ({}),
-                        },
-                    ],
-                );
-
-                // Assert
-                expect(result).toHaveProperty("storyName", "1 A simple story");
-            });
-
-            it("should render the component", () => {
-                // Arrange
-                const adapterSpy = jest
-                    .spyOn(AdapterModule, "Adapter")
-                    .mockImplementation(() => {});
-                getAdapter();
-                const closeGroupFn = adapterSpy.mock.calls[0][1];
-                const {"1ASimpleStory": Fixture} = closeGroupFn(
-                    {
-                        title: "TITLE",
-                        description: "DESCRIPTION",
-                    },
-                    null,
-                    [
-                        {
-                            description: "A simple story",
-                            component: (props) =>
-                                `I rendered ${JSON.stringify(props)}`,
-                            getProps: () => ({}),
-                        },
-                    ],
-                );
-
-                // Act
-                render(<Fixture aProp="aValue" />);
-
-                // Assert
-                expect(
-                    screen.getByText('I rendered {"aProp":"aValue"}'),
-                ).toBeInTheDocument();
-            });
-
-            it("should render the MountingComponent when provided", () => {
-                // Arrange
-                const adapterSpy = jest
-                    .spyOn(AdapterModule, "Adapter")
-                    .mockImplementation(() => {});
-                const MountingComponent = (props) =>
-                    "I AM A MOUNTING COMPONENT";
-                getAdapter(MountingComponent);
-                const closeGroupFn = adapterSpy.mock.calls[0][1];
-                const {"1ASimpleStory": Fixture} = closeGroupFn(
-                    {
-                        title: "TITLE",
-                        description: "DESCRIPTION",
-                    },
-                    null,
-                    [
-                        {
-                            description: "A simple story",
-                            component: (props) =>
-                                `I rendered ${JSON.stringify(props)}`,
-                            getProps: () => ({}),
-                        },
-                    ],
-                );
-
-                // Act
-                render(<Fixture aProp="aValue" />);
-
-                // Assert
-                expect(
-                    screen.getByText("I AM A MOUNTING COMPONENT"),
-                ).toBeInTheDocument();
-            });
-
-            it("should render the mounting component with the expected API", () => {
-                // Arrange
-                // Have to use the real Adapter here or the closure around
-                // the MountingComponent doesn't work for this test.
-                const adapterSpy = jest.spyOn(AdapterModule, "Adapter");
-                const mountingComponentStub = jest.fn().mockReturnValue(null);
-                const MountingComponent = (props) =>
-                    mountingComponentStub(props);
-                getAdapter(MountingComponent);
-                const closeGroupFn = adapterSpy.mock.calls[0][1];
-                const Component = (props) =>
-                    `I rendered ${JSON.stringify(props)}`;
-                const {"1ASimpleStory": Fixture} = closeGroupFn(
-                    {
-                        title: "TITLE",
-                        description: "DESCRIPTION",
-                    },
-                    null,
-                    [
-                        {
-                            description: "A simple story",
-                            component: Component,
-                            getProps: () => ({}),
-                        },
-                    ],
-                );
-
-                // Act
-                render(<Fixture aProp="aValue" />);
-
-                // Assert
-                expect(mountingComponentStub).toHaveBeenCalledWith({
-                    component: Component,
-                    props: {aProp: "aValue"},
-                    log: expect.any(Function),
-                });
-            });
-        });
-    });
-});