paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 19 Packages Projects Releases Wiki Activity

Limit the use of the same shortcut name and url when adding a shortcut with test cases

Browse Source 
Signed-off-by: AmbrishRamachandiran <ambrish.r@infosys.com>
This commit is contained in:
AmbrishRamachandiran
2023-07-30 20:26:28 +05:30
parent caaa5c8a55
commit fab2acc5c3
4 changed files with 167 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/shortcuts/src/AddShortcut.test.tsx
+56 -10
View File
@@ -17,7 +17,7 @@
import React from 'react';
import { screen, fireEvent, waitFor } from '@testing-library/react';
import { AddShortcut } from './AddShortcut';
import { DefaultShortcutsApi } from './api';
import { DefaultShortcutsApi, shortcutsApiRef } from './api';
import {
MockAnalyticsApi,
MockStorageApi,
@@ -42,13 +42,29 @@ describe('AddShortcut', () => {
});
it('displays the title', async () => {
await renderInTestApp(<AddShortcut {...props} />);
await renderInTestApp(
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<AddShortcut {...props} />
</TestApiProvider>,
);
expect(screen.getByText('Add Shortcut')).toBeInTheDocument();
});
it('closes the popup', async () => {
await renderInTestApp(<AddShortcut {...props} />);
await renderInTestApp(
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<AddShortcut {...props} />
</TestApiProvider>,
);
fireEvent.click(screen.getByText('Cancel'));
expect(props.onClose).toHaveBeenCalledTimes(1);
@@ -57,7 +73,17 @@ describe('AddShortcut', () => {
it('saves the input', async () => {
const spy = jest.spyOn(api, 'add');
await renderInTestApp(<AddShortcut {...props} />);
await renderInTestApp(
await renderInTestApp(
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<AddShortcut {...props} />
</TestApiProvider>,
),
);
const urlInput = screen.getByPlaceholderText('Enter a URL');
const titleInput = screen.getByPlaceholderText('Enter a display name');
@@ -78,7 +104,12 @@ describe('AddShortcut', () => {
const spy = jest.spyOn(api, 'add');
await renderInTestApp(
<TestApiProvider apis={[[analyticsApiRef, analyticsSpy]]}>
<TestApiProvider
apis={[
[analyticsApiRef, analyticsSpy],
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<AddShortcut {...props} />
</TestApiProvider>,
);
@@ -106,9 +137,18 @@ describe('AddShortcut', () => {
it('pastes the values', async () => {
const spy = jest.spyOn(api, 'add');
await renderInTestApp(<AddShortcut {...props} />, {
routeEntries: ['/some-initial-url'],
});
await renderInTestApp(
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<AddShortcut {...props} />,
</TestApiProvider>,
{
routeEntries: ['/some-initial-url'],
},
);
fireEvent.click(screen.getByText('Use current page'));
fireEvent.click(screen.getByText('Save'));
@@ -125,8 +165,14 @@ describe('AddShortcut', () => {
await renderInTestApp(
<>
<AlertDisplay />
<AddShortcut {...props} />
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<AlertDisplay />
<AddShortcut {...props} />
</TestApiProvider>
</>,
);
plugins/shortcuts/src/EditShortcut.test.tsx
+51 -8
View File
@@ -18,7 +18,7 @@ import React from 'react';
import { screen, fireEvent, waitFor } from '@testing-library/react';
import { EditShortcut } from './EditShortcut';
import { Shortcut } from './types';
import { DefaultShortcutsApi } from './api';
import { DefaultShortcutsApi, shortcutsApiRef } from './api';
import {
MockAnalyticsApi,
MockStorageApi,
@@ -48,13 +48,29 @@ describe('EditShortcut', () => {
});
it('displays the title', async () => {
await renderInTestApp(<EditShortcut {...props} />);
await renderInTestApp(
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<EditShortcut {...props} />
</TestApiProvider>,
);
expect(screen.getByText('Edit Shortcut')).toBeInTheDocument();
});
it('closes the popup', async () => {
await renderInTestApp(<EditShortcut {...props} />);
await renderInTestApp(
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<EditShortcut {...props} />
</TestApiProvider>,
);
fireEvent.click(screen.getByText('Cancel'));
expect(props.onClose).toHaveBeenCalledTimes(1);
@@ -63,7 +79,15 @@ describe('EditShortcut', () => {
it('updates the shortcut', async () => {
const spy = jest.spyOn(api, 'update');
await renderInTestApp(<EditShortcut {...props} />);
await renderInTestApp(
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<EditShortcut {...props} />
</TestApiProvider>,
);
const urlInput = screen.getByPlaceholderText('Enter a URL');
const titleInput = screen.getByPlaceholderText('Enter a display name');
@@ -86,7 +110,12 @@ describe('EditShortcut', () => {
const spy = jest.spyOn(api, 'update');
await renderInTestApp(
<TestApiProvider apis={[[analyticsApiRef, analyticsSpy]]}>
<TestApiProvider
apis={[
[analyticsApiRef, analyticsSpy],
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<EditShortcut {...props} />
</TestApiProvider>,
);
@@ -115,7 +144,15 @@ describe('EditShortcut', () => {
it('removes the shortcut', async () => {
const spy = jest.spyOn(api, 'remove');
await renderInTestApp(<EditShortcut {...props} />);
await renderInTestApp(
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<EditShortcut {...props} />
</TestApiProvider>,
);
fireEvent.click(screen.getByText('Remove'));
expect(spy).toHaveBeenCalledWith('id');
@@ -132,8 +169,14 @@ describe('EditShortcut', () => {
await renderInTestApp(
<>
<AlertDisplay />
<EditShortcut {...props} />
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<AlertDisplay />
<EditShortcut {...props} />
</TestApiProvider>
</>,
);
plugins/shortcuts/src/ShortcutForm.test.tsx
+53 -9
View File
@@ -16,7 +16,12 @@
import React from 'react';
import { screen, fireEvent, waitFor } from '@testing-library/react';
import { ShortcutForm } from './ShortcutForm';
import { renderInTestApp } from '@backstage/test-utils';
import { DefaultShortcutsApi, shortcutsApiRef } from './api';
import {
renderInTestApp,
TestApiProvider,
MockStorageApi,
} from '@backstage/test-utils';
describe('ShortcutForm', () => {
const props = {
@@ -25,7 +30,15 @@ describe('ShortcutForm', () => {
};
it('displays validation messages', async () => {
await renderInTestApp(<ShortcutForm {...props} />);
await renderInTestApp(
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<ShortcutForm {...props} />
</TestApiProvider>,
);
const urlInput = screen.getByPlaceholderText('Enter a URL');
const titleInput = screen.getByPlaceholderText('Enter a display name');
@@ -47,7 +60,15 @@ describe('ShortcutForm', () => {
});
it('allows external links', async () => {
await renderInTestApp(<ShortcutForm allowExternalLinks {...props} />);
await renderInTestApp(
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<ShortcutForm allowExternalLinks {...props} />
</TestApiProvider>,
);
const urlInput = screen.getByPlaceholderText('Enter a URL');
const titleInput = screen.getByPlaceholderText('Enter a display name');
@@ -69,7 +90,15 @@ describe('ShortcutForm', () => {
});
it('allows relative links when external links are enabled', async () => {
await renderInTestApp(<ShortcutForm allowExternalLinks {...props} />);
await renderInTestApp(
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<ShortcutForm allowExternalLinks {...props} />
</TestApiProvider>,
);
const urlInput = screen.getByPlaceholderText('Enter a URL');
const titleInput = screen.getByPlaceholderText('Enter a display name');
@@ -92,10 +121,17 @@ describe('ShortcutForm', () => {
it('calls the save handler', async () => {
await renderInTestApp(
<ShortcutForm
{...props}
formValues={{ url: '/some-url', title: 'some title' }}
/>,
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<ShortcutForm
{...props}
formValues={{ url: '/some-url', title: 'some title' }}
/>
,
</TestApiProvider>,
);
fireEvent.click(screen.getByText('Save'));
@@ -108,7 +144,15 @@ describe('ShortcutForm', () => {
});
it('calls the close handler', async () => {
await renderInTestApp(<ShortcutForm {...props} />);
await renderInTestApp(
<TestApiProvider
apis={[
[shortcutsApiRef, new DefaultShortcutsApi(MockStorageApi.create())],
]}
>
<ShortcutForm {...props} />
</TestApiProvider>,
);
fireEvent.click(screen.getByText('Cancel'));
await waitFor(() => {
plugins/shortcuts/src/ShortcutForm.tsx
+7
View File
@@ -73,6 +73,12 @@ export const ShortcutForm = ({
return true;
};
const urlIsUnique = async (url: string) => {
if (shortcutApi.get().some(shortcutUrl => shortcutUrl.url === url))
return 'A shortcut with this url already exists';
return true;
};
useEffect(() => {
reset(formValues);
}, [reset, formValues]);
@@ -85,6 +91,7 @@ export const ShortcutForm = ({
control={control}
rules={{
required: true,
validate: urlIsUnique,
...(allowExternalLinks
? {
pattern: {