Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add further data grid coverage testing #1758

Merged
merged 1 commit into from
May 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"@mdx-js/react": "^2.3.0",
"@mui/lab": "^5.0.0-alpha.97",
"@mui/material": "^5.13.0",
"@mui/x-data-grid": "^6.3.1",
"@mui/x-data-grid": "^6.1.0",
"@mui/x-date-pickers": "^6.3.1",
"@popperjs/core": "^2.11.7",
"@react-icons/all-files": "^4.1.0",
Expand Down
4 changes: 3 additions & 1 deletion src/__fixtures__/hooks.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,9 @@ export const createMockReleaseNotesAPI = (number): ReleaseNoteAPIResponse => ({
id: i.toString(),
link: new URL('https://link_mock'),
title: 'title_mock',
priority: '1'
priority: '1',
type: 'Bug',
component: 'component_mock',
}))
});

Expand Down
1 change: 1 addition & 0 deletions src/__fixtures__/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export const createMDXData = (): {
allMdx: MDXPage;
} => ({
allMdx: {
totalCount: 1,
edges: [
{
node: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,52 @@ import { describe, expect, it, vi } from 'vitest'
import ReleaseNotesRender, { fetchTitle } from '../index';
import { fetchReleaseNotesForVersion } from '../../../hooks/fetchReleaseNotes';
import { createMockReleaseNotesAPI } from '../../../__fixtures__/hooks';
import { DataGridProps } from "@mui/x-data-grid"
import queryString from 'query-string';

vi.mock('query-string');
vi.mock('../../../hooks/fetchReleaseNotes');

// Disable Virtualization so vitest can render all the columns
// https://github.com/mui/mui-x/issues/1151#issuecomment-1108349639
vi.mock('@mui/x-data-grid', async () => {
const datagrid: any = await vi.importActual('@mui/x-data-grid')
const { DataGrid } = datagrid
return {
...datagrid,
DataGrid: (props: DataGridProps) => {
return <DataGrid {...props} disableVirtualization />
},
}
});

afterEach(() => {
vi.clearAllMocks();
});

describe('ReleaseNotesRender component', () => {
it('should render correctly', () => {
queryString.parse = vi.fn().mockReturnValue({'version': 'jdk-17.0.1+12'});

// @ts-ignore
fetchReleaseNotesForVersion.mockReturnValue(createMockReleaseNotesAPI(2));

const { container } = render(
<ReleaseNotesRender />
);

expect(fetchReleaseNotesForVersion).toHaveBeenCalledTimes(1);

// check if 2 rows are rendered
expect(container.querySelectorAll('.MuiDataGrid-row')).toHaveLength(2);

expect(container).toMatchSnapshot();
});


it('should render correctly - version not defined', () => {
queryString.parse = vi.fn().mockReturnValue({});

const { container } = render(
<ReleaseNotesRender />
);
Expand All @@ -29,33 +66,50 @@ describe('ReleaseNotesRender component', () => {
expect(fetchTitle(null)).toBeUndefined();
expect(fetchTitle('123')).toBeUndefined();
});

it('should render correctly', () => {
// mock query string version
vi.mock('query-string', () => ({
default: {
parse: () => ({
version: 'version',
}),
}
}));
fetchReleaseNotesForVersion.mockReturnValue(createMockReleaseNotesAPI(1));

// Set type to 'Enhancement' by default if version matches jdk-xx+xx
it('should render correctly - type set to Enhancement', async () => {
queryString.parse = vi.fn().mockReturnValue({'version': 'jdk-20+36'});

function mockReleaseNotes(num: number) {
let mockReleaseNotesAPI = createMockReleaseNotesAPI(num);
mockReleaseNotesAPI.release_notes[0].type = 'Enhancement';
return mockReleaseNotesAPI;
}

// @ts-ignore
fetchReleaseNotesForVersion.mockReturnValue(mockReleaseNotes(2));
const { container } = render(
<ReleaseNotesRender />
);
expect(fetchReleaseNotesForVersion).toHaveBeenCalledTimes(1);
expect(container).toMatchSnapshot();

// check if 1 row is rendered and 1 is filtered out
expect(container.querySelectorAll('.MuiDataGrid-row')).toHaveLength(1);
});

// sets priority as p? when priority is not defined
it('should render correctly - priority not defined', () => {
queryString.parse = vi.fn().mockReturnValue({'version': 'version'});
function mockReleaseNotes() {
let mockReleaseNotesAPI = createMockReleaseNotesAPI(1);
mockReleaseNotesAPI.release_notes[0].priority = undefined;
return mockReleaseNotesAPI;
}

// @ts-ignore
fetchReleaseNotesForVersion.mockReturnValue(mockReleaseNotes());
const { container } = render(
<ReleaseNotesRender />
);

const priorityColumn = container.querySelectorAll('.MuiDataGrid-cell')[0];
expect(priorityColumn.textContent).toContain('P?');
});

it('should render correctly - no release notes', () => {
// mock query string version
vi.mock('query-string', () => ({
default: {
parse: () => ({
version: 'version',
}),
}
}));
queryString.parse = vi.fn().mockReturnValue({'version': 'version'});

// @ts-ignore
fetchReleaseNotesForVersion.mockReturnValue({ release_notes: null});
const { container } = render(
<ReleaseNotesRender />
Expand Down
Loading