Skip to content

Commit

Permalink
add tests
Browse files Browse the repository at this point in the history
  • Loading branch information
yannbf committed Jun 30, 2023
1 parent 78ecb85 commit 4cefbb8
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 1 deletion.
55 changes: 55 additions & 0 deletions code/lib/telemetry/src/get-framework-info.test.ts
@@ -0,0 +1,55 @@
import type { StorybookConfig } from '@storybook/types';
import { getFrameworkInfo } from './get-framework-info';
import { getActualPackageJson } from './package-json';

jest.mock('./package-json', () => ({
getActualPackageJson: jest.fn(),
}));

describe('getFrameworkInfo', () => {
it('should return an empty object if mainConfig.framework is undefined', async () => {
const result = await getFrameworkInfo({} as StorybookConfig);
expect(result).toEqual({});
});

it('should return an empty object if mainConfig.framework name is undefined', async () => {
const result = await getFrameworkInfo({ framework: {} } as StorybookConfig);
expect(result).toEqual({});
});

it('should call getActualPackageJson with the correct package name', async () => {
const packageName = '@storybook/react';
const framework = { name: packageName };
await getFrameworkInfo({ framework } as StorybookConfig);
expect(getActualPackageJson).toHaveBeenCalledWith(packageName);
});

it('should resolve the framework package json correctly and strip project paths in the metadata', async () => {
const packageName = '/path/to/project/@storybook/react';
const framework = { name: packageName };
const frameworkPackageJson = {
name: packageName,
dependencies: {
'@storybook/react': '7.0.0',
'@storybook/builder-vite': '7.0.0',
},
};

jest.spyOn(process, 'cwd').mockReturnValue('/path/to/project');

(getActualPackageJson as jest.Mock).mockResolvedValueOnce(frameworkPackageJson);

const result = await getFrameworkInfo({ framework } as StorybookConfig);

expect(getActualPackageJson).toHaveBeenCalledWith(packageName);

expect(result).toEqual({
framework: {
name: '$SNIP/@storybook/react',
options: undefined,
},
builder: '@storybook/builder-vite',
renderer: '@storybook/react',
});
});
});
5 changes: 4 additions & 1 deletion code/lib/telemetry/src/get-framework-info.ts
Expand Up @@ -54,12 +54,15 @@ export async function getFrameworkInfo(mainConfig: StorybookConfig) {

const frameworkPackageJson = await getActualPackageJson(rawName);

if (!frameworkPackageJson) {
return {};
}

const builder = findMatchingPackage(frameworkPackageJson, knownBuilders);
const renderer = findMatchingPackage(frameworkPackageJson, knownRenderers);

// parse framework name and strip off pnp paths etc.
const sanitizedFrameworkName = getFrameworkPackageName(rawName);

const frameworkOptions =
typeof mainConfig.framework === 'object' ? mainConfig.framework.options : {};

Expand Down

0 comments on commit 4cefbb8

Please sign in to comment.