-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5b2f558
commit 19be0cd
Showing
1 changed file
with
121 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,102 +1,134 @@ | ||
| import { execaCommand } from "execa" | ||
| import { writeFile } from "jsonfile"; | ||
| import { afterEach, describe, expect, it, vi } from "vitest"; | ||
| import { execaCommand } from 'execa'; | ||
| import { writeFile } from 'jsonfile'; | ||
| import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; | ||
|
|
||
| import { addChromaticScriptToPackageJson, createChromaticConfigFile, installArchiveDependencies } from "./init"; | ||
| import { beforeEach } from "node:test"; | ||
| import { | ||
| addChromaticScriptToPackageJson, | ||
| createChromaticConfigFile, | ||
| installArchiveDependencies, | ||
| } from './init'; | ||
|
|
||
| vi.mock('jsonfile', async (importOriginal) => { | ||
| return { | ||
| // @ts-expect-error TS does not think actual is an object, but it's fine. | ||
| ...await importOriginal(), | ||
| writeFile: vi.fn(() => Promise.resolve()), | ||
| }; | ||
| return { | ||
| // @ts-expect-error TS does not think actual is an object, but it's fine. | ||
| ...(await importOriginal()), | ||
| writeFile: vi.fn(() => Promise.resolve()), | ||
| }; | ||
| }); | ||
|
|
||
| vi.mock('execa'); | ||
|
|
||
| describe('addChromaticScriptToPackageJson', () => { | ||
| afterEach(() => { | ||
| vi.restoreAllMocks() | ||
| }) | ||
| it('outputs updated package.json with only chromatic script if Framework is Storybook', async () => { | ||
| await addChromaticScriptToPackageJson({ | ||
| packageJson: {}, | ||
| packagePath: './package.json' | ||
| }) | ||
| expect(writeFile).toHaveBeenCalledOnce() | ||
| expect(writeFile).toHaveBeenCalledWith('./package.json', { | ||
| scripts: { | ||
| chromatic: `chromatic` | ||
| } | ||
| }, { spaces: 2 }) | ||
| }) | ||
| afterEach(() => { | ||
| vi.restoreAllMocks(); | ||
| }); | ||
| it('outputs updated package.json with only chromatic script if Framework is Storybook', async () => { | ||
| await addChromaticScriptToPackageJson({ | ||
| packageJson: {}, | ||
| packagePath: './package.json', | ||
| }); | ||
| expect(writeFile).toHaveBeenCalledOnce(); | ||
| expect(writeFile).toHaveBeenCalledWith( | ||
| './package.json', | ||
| { | ||
| scripts: { | ||
| chromatic: `chromatic`, | ||
| }, | ||
| }, | ||
| { spaces: 2 } | ||
| ); | ||
| }); | ||
|
|
||
| it('outputs updated package.json with e2e script if Framework is not Storybook', async () => { | ||
| await addChromaticScriptToPackageJson({ | ||
| packageJson: {}, | ||
| packagePath: './package.json' | ||
| }) | ||
| expect(writeFile).toHaveBeenCalledOnce() | ||
| expect(writeFile).toHaveBeenCalledWith('./package.json', { | ||
| scripts: { | ||
| chromatic: `chromatic` | ||
| } | ||
| }, { spaces: 2 }) | ||
| }) | ||
| }) | ||
| it('outputs updated package.json with e2e script if Framework is not Storybook', async () => { | ||
| await addChromaticScriptToPackageJson({ | ||
| packageJson: {}, | ||
| packagePath: './package.json', | ||
| }); | ||
| expect(writeFile).toHaveBeenCalledOnce(); | ||
| expect(writeFile).toHaveBeenCalledWith( | ||
| './package.json', | ||
| { | ||
| scripts: { | ||
| chromatic: `chromatic`, | ||
| }, | ||
| }, | ||
| { spaces: 2 } | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe('createChromaticConfigFile', () => { | ||
| it('outputs file without buildScriptName when not passed one', async () => { | ||
| await createChromaticConfigFile({configFile: 'chromatic.config.json'}) | ||
| expect(writeFile).toHaveBeenCalledOnce() | ||
| expect(writeFile).toHaveBeenCalledWith('chromatic.config.json', {}) | ||
| }) | ||
| }) | ||
| it('outputs file without buildScriptName when not passed one', async () => { | ||
| await createChromaticConfigFile({ configFile: 'chromatic.config.json' }); | ||
| expect(writeFile).toHaveBeenCalledOnce(); | ||
| expect(writeFile).toHaveBeenCalledWith('chromatic.config.json', {}); | ||
| }); | ||
| }); | ||
|
|
||
| describe('installArchiveDependencies', () => { | ||
| beforeEach(() => { | ||
| vi.doMock('find-up', async () => { | ||
| return { | ||
| findUp: vi.fn(() => Promise.resolve(undefined)), | ||
| }; | ||
| }); | ||
| }) | ||
| afterEach(() => { | ||
| vi.clearAllMocks() | ||
| vi.resetModules() | ||
| }) | ||
| it('successfully installs list of dependencies for Playwright if SB package is not found and Essentials is not found', async () => { | ||
| await installArchiveDependencies({}, 'playwright') | ||
| expect(execaCommand).toHaveBeenCalledOnce() | ||
| expect(execaCommand).toHaveBeenCalledWith('yarn add -D chromatic @chromatic-com/playwright storybook@latest @storybook/addon-essentials@latest @storybook/server-webpack5@latest') | ||
| }) | ||
| it('successfully installs list of dependencies for Cypress if SB package is not found and Essentials is not found', async () => { | ||
| await installArchiveDependencies({}, 'cypress') | ||
| expect(execaCommand).toHaveBeenCalledOnce() | ||
| expect(execaCommand).toHaveBeenCalledWith('yarn add -D chromatic @chromatic-com/cypress storybook@latest @storybook/addon-essentials@latest @storybook/server-webpack5@latest') | ||
| }) | ||
| it('successfully installs list of dependencies if SB package is found and Essentials is not found', async () => { | ||
| await installArchiveDependencies({devDependencies: {'storybook': '7.6.5'}}, 'playwright') | ||
| expect(execaCommand).toHaveBeenCalledOnce() | ||
| expect(execaCommand).toHaveBeenCalledWith('yarn add -D chromatic @chromatic-com/playwright @storybook/addon-essentials@7.6.5 @storybook/server-webpack5@7.6.5') | ||
| }) | ||
| it('successfully installs list of dependencies if SB package is found and Essentials is found in devDependencies', async () => { | ||
| await installArchiveDependencies({devDependencies: {storybook: '7.6.5', '@storybook/addon-essentials': '7.6.5'}}, 'playwright') | ||
| expect(execaCommand).toHaveBeenCalledOnce() | ||
| expect(execaCommand).toHaveBeenCalledWith('yarn add -D chromatic @chromatic-com/playwright @storybook/server-webpack5@7.6.5') | ||
| vi.clearAllMocks() | ||
| }) | ||
| it('successfully installs list of dependencies if SB package is found and Essentials is found in dependencies', async () => { | ||
| await installArchiveDependencies({dependencies: {storybook: '7.6.5', '@storybook/addon-essentials': '7.6.5'}}, 'playwright') | ||
| expect(execaCommand).toHaveBeenCalledOnce() | ||
| expect(execaCommand).toHaveBeenCalledWith('yarn add -D chromatic @chromatic-com/playwright @storybook/server-webpack5@7.6.5') | ||
| vi.clearAllMocks() | ||
| }) | ||
| it('successfully installs list of dependencies if SB package is not found and Essentials is found in dependencies', async () => { | ||
| await installArchiveDependencies({dependencies: {'@storybook/addon-essentials': '7.6.5'}}, 'playwright') | ||
| expect(execaCommand).toHaveBeenCalledOnce() | ||
| expect(execaCommand).toHaveBeenCalledWith('yarn add -D chromatic @chromatic-com/playwright storybook@7.6.5 @storybook/server-webpack5@7.6.5') | ||
| vi.clearAllMocks() | ||
| }) | ||
| }) | ||
| beforeEach(() => { | ||
| vi.doMock('find-up', async () => { | ||
| return { | ||
| findUp: vi.fn(() => Promise.resolve(undefined)), | ||
| }; | ||
| }); | ||
| }); | ||
| afterEach(() => { | ||
| vi.clearAllMocks(); | ||
| vi.resetModules(); | ||
| }); | ||
| it('successfully installs list of dependencies for Playwright if SB package is not found and Essentials is not found', async () => { | ||
| await installArchiveDependencies({}, 'playwright'); | ||
| expect(execaCommand).toHaveBeenCalledOnce(); | ||
| expect(execaCommand).toHaveBeenCalledWith( | ||
| 'yarn add -D chromatic @chromatic-com/playwright storybook@latest @storybook/addon-essentials@latest @storybook/server-webpack5@latest' | ||
| ); | ||
| }); | ||
| it('successfully installs list of dependencies for Cypress if SB package is not found and Essentials is not found', async () => { | ||
| await installArchiveDependencies({}, 'cypress'); | ||
| expect(execaCommand).toHaveBeenCalledOnce(); | ||
| expect(execaCommand).toHaveBeenCalledWith( | ||
| 'yarn add -D chromatic @chromatic-com/cypress storybook@latest @storybook/addon-essentials@latest @storybook/server-webpack5@latest' | ||
| ); | ||
| }); | ||
| it('successfully installs list of dependencies if SB package is found and Essentials is not found', async () => { | ||
| await installArchiveDependencies({ devDependencies: { storybook: '7.6.5' } }, 'playwright'); | ||
| expect(execaCommand).toHaveBeenCalledOnce(); | ||
| expect(execaCommand).toHaveBeenCalledWith( | ||
| 'yarn add -D chromatic @chromatic-com/playwright @storybook/addon-essentials@7.6.5 @storybook/server-webpack5@7.6.5' | ||
| ); | ||
| }); | ||
| it('successfully installs list of dependencies if SB package is found and Essentials is found in devDependencies', async () => { | ||
| await installArchiveDependencies( | ||
| { devDependencies: { storybook: '7.6.5', '@storybook/addon-essentials': '7.6.5' } }, | ||
| 'playwright' | ||
| ); | ||
| expect(execaCommand).toHaveBeenCalledOnce(); | ||
| expect(execaCommand).toHaveBeenCalledWith( | ||
| 'yarn add -D chromatic @chromatic-com/playwright @storybook/server-webpack5@7.6.5' | ||
| ); | ||
| vi.clearAllMocks(); | ||
| }); | ||
| it('successfully installs list of dependencies if SB package is found and Essentials is found in dependencies', async () => { | ||
| await installArchiveDependencies( | ||
| { dependencies: { storybook: '7.6.5', '@storybook/addon-essentials': '7.6.5' } }, | ||
| 'playwright' | ||
| ); | ||
| expect(execaCommand).toHaveBeenCalledOnce(); | ||
| expect(execaCommand).toHaveBeenCalledWith( | ||
| 'yarn add -D chromatic @chromatic-com/playwright @storybook/server-webpack5@7.6.5' | ||
| ); | ||
| vi.clearAllMocks(); | ||
| }); | ||
| it('successfully installs list of dependencies if SB package is not found and Essentials is found in dependencies', async () => { | ||
| await installArchiveDependencies( | ||
| { dependencies: { '@storybook/addon-essentials': '7.6.5' } }, | ||
| 'playwright' | ||
| ); | ||
| expect(execaCommand).toHaveBeenCalledOnce(); | ||
| expect(execaCommand).toHaveBeenCalledWith( | ||
| 'yarn add -D chromatic @chromatic-com/playwright storybook@7.6.5 @storybook/server-webpack5@7.6.5' | ||
| ); | ||
| vi.clearAllMocks(); | ||
| }); | ||
| }); |