chore: added some more tests for the TemplateGroups

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2022-02-27 17:21:53 +01:00
parent 4ef2db835a
commit 71543c9a91
2 changed files with 149 additions and 2 deletions
@@ -18,12 +18,17 @@ jest.mock('@backstage/plugin-catalog-react', () => ({
useEntityList: jest.fn(),
}));
jest.mock('./TemplateGroup', () => ({
TemplateGroup: jest.fn(() => null),
}));
import React from 'react';
import { render } from '@testing-library/react';
import { useEntityList } from '@backstage/plugin-catalog-react';
import { TemplateGroups } from './TemplateGroups';
import { TestApiProvider } from '@backstage/test-utils';
import { errorApiRef } from '@backstage/core-plugin-api';
import { TemplateGroup } from './TemplateGroup';
describe('TemplateGroups', () => {
it('should return progress if the hook is loading', async () => {
@@ -37,4 +42,131 @@ describe('TemplateGroups', () => {
expect(await findByTestId('progress')).toBeInTheDocument();
});
it('should use the error api if there is an error with the retrieval of entitylist', async () => {
const mockError = new Error('tings went poop');
(useEntityList as jest.Mock).mockReturnValue({
error: mockError,
});
const errorApi = {
post: jest.fn(),
};
render(
<TestApiProvider apis={[[errorApiRef, errorApi]]}>
<TemplateGroups groups={[]} />
</TestApiProvider>,
);
expect(errorApi.post).toHaveBeenCalledWith(mockError);
});
it('should return a no templates message if entities is unset', async () => {
(useEntityList as jest.Mock).mockReturnValue({
entities: null,
loading: false,
error: null,
});
const { findByText } = render(
<TestApiProvider apis={[[errorApiRef, {}]]}>
<TemplateGroups groups={[]} />
</TestApiProvider>,
);
expect(await findByText(/No templates found/)).toBeInTheDocument();
});
it('should return a no templates message if entities has no values in it', async () => {
(useEntityList as jest.Mock).mockReturnValue({
entities: [],
loading: false,
error: null,
});
const { findByText } = render(
<TestApiProvider apis={[[errorApiRef, {}]]}>
<TemplateGroups groups={[]} />
</TestApiProvider>,
);
expect(await findByText(/No templates found/)).toBeInTheDocument();
});
it('should call the template group with the components', async () => {
const mockEntities = [
{
apiVersion: 'scaffolder.backstage.io/v1beta3',
kind: 'Template',
metadata: {
name: 't1',
},
spec: {},
},
{
apiVersion: 'scaffolder.backstage.io/v1beta3',
kind: 'Template',
metadata: {
name: 't2',
},
spec: {},
},
];
(useEntityList as jest.Mock).mockReturnValue({
entities: mockEntities,
loading: false,
error: null,
});
render(
<TestApiProvider apis={[[errorApiRef, {}]]}>
<TemplateGroups groups={[{ title: 'all', filter: () => true }]} />
</TestApiProvider>,
);
expect(TemplateGroup).toHaveBeenCalledWith(
expect.objectContaining({ templates: mockEntities }),
{},
);
});
it('should apply the filter for each group', async () => {
const mockEntities = [
{
apiVersion: 'scaffolder.backstage.io/v1beta3',
kind: 'Template',
metadata: {
name: 't1',
},
spec: {},
},
{
apiVersion: 'scaffolder.backstage.io/v1beta3',
kind: 'Template',
metadata: {
name: 't2',
},
spec: {},
},
];
(useEntityList as jest.Mock).mockReturnValue({
entities: mockEntities,
loading: false,
error: null,
});
render(
<TestApiProvider apis={[[errorApiRef, {}]]}>
<TemplateGroups
groups={[{ title: 'all', filter: e => e.metadata.name === 't1' }]}
/>
</TestApiProvider>,
);
expect(TemplateGroup).toHaveBeenCalledWith(
expect.objectContaining({ templates: [mockEntities[0]] }),
{},
);
});
});
@@ -36,6 +36,7 @@ export interface TemplateGroupsProps {
export const TemplateGroups = (props: TemplateGroupsProps) => {
const { loading, error, entities } = useEntityList();
const { groups, TemplateCardComponent } = props;
const errorApi = useApi(errorApiRef);
if (loading) {
@@ -44,9 +45,10 @@ export const TemplateGroups = (props: TemplateGroupsProps) => {
if (error) {
errorApi.post(error);
return null;
}
if (!entities) {
if (!entities || !entities.length) {
return (
<Typography variant="body2">
No templates found that match your filter. Learn more about{' '}
@@ -58,5 +60,18 @@ export const TemplateGroups = (props: TemplateGroupsProps) => {
);
}
return null;
return (
<>
{groups.map(({ title, filter }, index) => (
<TemplateGroup
key={index}
templates={entities.filter((e): e is TemplateEntityV1beta3 =>
filter(e),
)}
title={title}
components={{ CardComponent: TemplateCardComponent }}
/>
))}
</>
);
};