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.

Sign up for GitHub

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

(test) Add renderWithRouter wrapper #1373

Merged
merged 2 commits into from
Nov 14, 2024
Merged

(test) Add renderWithRouter wrapper #1373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c382a3a
(test) Add renderWithRouter wrapper
denniskigen Nov 14, 2024
6e2116e
Merge branch 'main' into test/render-with-router-wrapper
denniskigen Nov 14, 2024
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
114 changes: 52 additions & 62 deletions ...stration-app/src/patient-registration/input/custom-input/autosuggest/autosuggest.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React from 'react';
import { BrowserRouter } from 'react-router-dom';
import { render, screen } from '@testing-library/react';
import { screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { renderWithRouter } from 'tools';
import { Autosuggest } from './autosuggest.component';

const mockPersons = [
Expand Down Expand Up @@ -33,18 +33,16 @@ const mockHandleSuggestionSelected = jest.fn((field, value) => [field, value]);

describe('Autosuggest', () => {
it('renders a search box', () => {
render(
<BrowserRouter>
<Autosuggest
getSearchResults={mockGetSearchResults}
getDisplayValue={(item) => item.display}
getFieldValue={(item) => item.uuid}
id="person"
labelText=""
onSuggestionSelected={mockHandleSuggestionSelected}
placeholder="Find Person"
/>
</BrowserRouter>,
renderWithRouter(
<Autosuggest
getSearchResults={mockGetSearchResults}
getDisplayValue={(item) => item.display}
getFieldValue={(item) => item.uuid}
id="person"
labelText=""
onSuggestionSelected={mockHandleSuggestionSelected}
placeholder="Find Person"
/>,
);

expect(screen.getByRole('searchbox')).toBeInTheDocument();
Expand All @@ -54,18 +52,16 @@ describe('Autosuggest', () => {
it('renders matching search results in a list when the user types a query', async () => {
const user = userEvent.setup();

render(
<BrowserRouter>
<Autosuggest
getSearchResults={mockGetSearchResults}
getDisplayValue={(item) => item.display}
getFieldValue={(item) => item.uuid}
id="person"
labelText=""
onSuggestionSelected={mockHandleSuggestionSelected}
placeholder="Find Person"
/>
</BrowserRouter>,
renderWithRouter(
<Autosuggest
getSearchResults={mockGetSearchResults}
getDisplayValue={(item) => item.display}
getFieldValue={(item) => item.uuid}
id="person"
labelText=""
onSuggestionSelected={mockHandleSuggestionSelected}
placeholder="Find Person"
/>,
);

const searchbox = screen.getByRole('searchbox');
Expand All @@ -82,18 +78,16 @@ describe('Autosuggest', () => {
it('clears the list of suggestions when a suggestion is selected', async () => {
const user = userEvent.setup();

render(
<BrowserRouter>
<Autosuggest
getSearchResults={mockGetSearchResults}
getDisplayValue={(item) => item.display}
getFieldValue={(item) => item.uuid}
id="person"
labelText=""
onSuggestionSelected={mockHandleSuggestionSelected}
placeholder="Find Person"
/>
</BrowserRouter>,
renderWithRouter(
<Autosuggest
getSearchResults={mockGetSearchResults}
getDisplayValue={(item) => item.display}
getFieldValue={(item) => item.uuid}
id="person"
labelText=""
onSuggestionSelected={mockHandleSuggestionSelected}
placeholder="Find Person"
/>,
);

let list = screen.queryByRole('list');
Expand All @@ -117,18 +111,16 @@ describe('Autosuggest', () => {
it('changes suggestions when a search input is changed', async () => {
const user = userEvent.setup();

render(
<BrowserRouter>
<Autosuggest
getSearchResults={mockGetSearchResults}
getDisplayValue={(item) => item.display}
getFieldValue={(item) => item.uuid}
id="person"
labelText=""
onSuggestionSelected={mockHandleSuggestionSelected}
placeholder="Find Person"
/>
</BrowserRouter>,
renderWithRouter(
<Autosuggest
getSearchResults={mockGetSearchResults}
getDisplayValue={(item) => item.display}
getFieldValue={(item) => item.uuid}
id="person"
labelText=""
onSuggestionSelected={mockHandleSuggestionSelected}
placeholder="Find Person"
/>,
);

let list = screen.queryByRole('list');
Expand All @@ -149,18 +141,16 @@ describe('Autosuggest', () => {
it('hides the list of suggestions when the user clicks outside of the component', async () => {
const user = userEvent.setup();

render(
<BrowserRouter>
<Autosuggest
getSearchResults={mockGetSearchResults}
getDisplayValue={(item) => item.display}
getFieldValue={(item) => item.uuid}
id="person"
labelText=""
onSuggestionSelected={mockHandleSuggestionSelected}
placeholder="Find Person"
/>
</BrowserRouter>,
renderWithRouter(
<Autosuggest
getSearchResults={mockGetSearchResults}
getDisplayValue={(item) => item.display}
getFieldValue={(item) => item.uuid}
id="person"
labelText=""
onSuggestionSelected={mockHandleSuggestionSelected}
placeholder="Find Person"
/>,
);

const input = screen.getByRole('searchbox');
Expand Down
1 change: 1 addition & 0 deletions tools/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ export {
mockPatientWithoutFormattedName,
patientChartBasePath,
renderWithSwr,
renderWithRouter,
waitForLoadingToFinish,
} from './test-utils';
16 changes: 14 additions & 2 deletions tools/test-utils.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { Route, Routes, MemoryRouter } from 'react-router-dom';
import React, { type ReactElement } from 'react';
import { SWRConfig } from 'swr';
import { type RenderOptions, render, screen, waitForElementToBeRemoved } from '@testing-library/react';
Expand All @@ -17,6 +18,16 @@ const swrWrapper = ({ children }) => {
const renderWithSwr = (ui: ReactElement, options?: Omit<RenderOptions, 'queries'>) =>
render(ui, { wrapper: swrWrapper, ...options });

const renderWithRouter = (component: React.ReactElement, initialRoute = '/') => {
return render(
<MemoryRouter initialEntries={[initialRoute]}>
<Routes>
<Route path="/" element={component} />
</Routes>
</MemoryRouter>,
);
};

function waitForLoadingToFinish() {
return waitForElementToBeRemoved(() => [...screen.queryAllByRole('progressbar')], {
timeout: 4000,
Expand Down Expand Up @@ -141,12 +152,13 @@ const mockPatientWithoutFormattedName = {
const patientChartBasePath = `/patient/${mockPatient.id}/chart`;

export {
renderWithSwr,
waitForLoadingToFinish,
getByTextWithMarkup,
mockPatient,
mockOpenMRSIdentificationNumberIdType,
mockPatientWithLongName,
mockPatientWithoutFormattedName,
patientChartBasePath,
renderWithSwr,
renderWithRouter,
waitForLoadingToFinish,
};
Loading