-
Notifications
You must be signed in to change notification settings - Fork 23
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
fix(global-header): added unit tests for searchBar #259
Merged
christoph-jerolimov
merged 1 commit into
redhat-developer:main
from
ciiay:rhidp-5365-add-searchbar-unit-tests
Jan 8, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
146 changes: 146 additions & 0 deletions
146
...ces/global-header/plugins/global-header/src/components/SearchComponent/SearchBar.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| /* | ||
| * Copyright Red Hat, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import React from 'react'; | ||
| import { render, screen, fireEvent, waitFor } from '@testing-library/react'; | ||
| import { SearchBar } from './SearchBar'; | ||
| import { | ||
| searchApiRef, | ||
| SearchContextProvider, | ||
| } from '@backstage/plugin-search-react'; | ||
| import { mockApis, TestApiProvider } from '@backstage/test-utils'; | ||
| import { MemoryRouter, useNavigate } from 'react-router-dom'; | ||
| import { configApiRef } from '@backstage/core-plugin-api'; | ||
|
|
||
| const createInitialState = ({ | ||
| term = '', | ||
| filters = {}, | ||
| types = ['*'], | ||
| pageCursor = '', | ||
| } = {}) => ({ | ||
| term, | ||
| filters, | ||
| types, | ||
| pageCursor, | ||
| }); | ||
|
|
||
| const mockSearchApi = { | ||
| query: jest.fn().mockResolvedValue({ | ||
| results: [ | ||
| { | ||
| type: 'software-catalog', | ||
| document: { | ||
| title: 'Example Result', | ||
| location: '/catalog/default/component/example', | ||
| }, | ||
| }, | ||
| ], | ||
| }), | ||
| }; | ||
|
|
||
| const mockConfig = mockApis.config({ | ||
| data: { | ||
| app: { | ||
| url: 'https://example.com', | ||
| }, | ||
| }, | ||
| }); | ||
|
|
||
| jest.mock('../../utils/stringUtils', () => ({ | ||
| ...jest.requireActual('../../utils/stringUtils'), | ||
| highlightMatch: jest.fn(text => text), | ||
| })); | ||
|
|
||
| jest.mock('react-router-dom', () => ({ | ||
| ...jest.requireActual('react-router-dom'), | ||
| useNavigate: jest.fn(), | ||
| })); | ||
|
|
||
| describe('SearchBar', () => { | ||
| const setup = (term = '') => { | ||
| const setSearchTerm = jest.fn(); | ||
| const navigate = jest.fn(); | ||
| jest.mocked(useNavigate).mockReturnValue(navigate); | ||
|
|
||
| render( | ||
| <MemoryRouter initialEntries={['/']}> | ||
| <TestApiProvider | ||
| apis={[ | ||
| [searchApiRef, mockSearchApi], | ||
| [configApiRef, mockConfig], | ||
| ]} | ||
| > | ||
| <SearchContextProvider initialState={createInitialState({ term })}> | ||
| <SearchBar query={{ term }} setSearchTerm={setSearchTerm} /> | ||
| </SearchContextProvider> | ||
| </TestApiProvider> | ||
| </MemoryRouter>, | ||
| ); | ||
| return { setSearchTerm, navigate }; | ||
| }; | ||
|
|
||
| it('renders the search input', () => { | ||
| setup(); | ||
| expect(screen.getByPlaceholderText('Search...')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('calls setSearchTerm on input change', () => { | ||
| const { setSearchTerm } = setup(); | ||
| fireEvent.change(screen.getByPlaceholderText('Search...'), { | ||
| target: { value: 'test' }, | ||
| }); | ||
| expect(setSearchTerm).toHaveBeenCalledWith('test'); | ||
| }); | ||
|
|
||
| it('displays "No results found" when there are no results', async () => { | ||
| mockSearchApi.query.mockResolvedValueOnce({ results: [] }); | ||
| setup('test'); | ||
| fireEvent.change(screen.getByPlaceholderText('Search...'), { | ||
| target: { value: 'test' }, | ||
| }); | ||
| await waitFor(() => { | ||
| expect(screen.getByText('No results found')).toBeInTheDocument(); | ||
| }); | ||
| }); | ||
|
|
||
| it('displays search results', async () => { | ||
| setup('example'); | ||
| fireEvent.change(screen.getByPlaceholderText('Search...'), { | ||
| target: { value: 'example' }, | ||
| }); | ||
| await waitFor(() => { | ||
| expect(screen.getByText('Example Result')).toBeInTheDocument(); | ||
| }); | ||
| }); | ||
|
|
||
| it('navigates to the search page on Enter key press', async () => { | ||
| const { navigate } = setup('example'); | ||
| fireEvent.change(screen.getByPlaceholderText('Search...'), { | ||
| target: { value: 'example' }, | ||
| }); | ||
| await waitFor(() => { | ||
| expect(screen.getByText('Example Result')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| fireEvent.keyDown(screen.getByPlaceholderText('Search...'), { | ||
| key: 'Enter', | ||
| code: 'Enter', | ||
| }); | ||
| await waitFor(() => { | ||
| expect(navigate).toHaveBeenCalledWith('/search?query=example'); | ||
| }); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
100 changes: 100 additions & 0 deletions
100
...obal-header/plugins/global-header/src/components/SearchComponent/SearchComponent.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| /* | ||
| * Copyright Red Hat, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import React from 'react'; | ||
| import { render, screen, fireEvent } from '@testing-library/react'; | ||
| import { SearchComponent } from './SearchComponent'; | ||
| import { | ||
| searchApiRef, | ||
| SearchContextProvider, | ||
| } from '@backstage/plugin-search-react'; | ||
| import { mockApis, TestApiProvider } from '@backstage/test-utils'; | ||
| import { configApiRef } from '@backstage/core-plugin-api'; | ||
|
|
||
| jest.mock('./SearchBar', () => ({ | ||
| SearchBar: ({ | ||
| query, | ||
| setSearchTerm, | ||
| }: { | ||
| query: { term: string }; | ||
| setSearchTerm: (term: string) => void; | ||
| }) => ( | ||
| <input | ||
| data-testid="search-bar" | ||
| value={query.term} | ||
| onChange={e => setSearchTerm(e.target.value)} | ||
| /> | ||
| ), | ||
| })); | ||
|
|
||
| const mockSearchApi = { | ||
| query: jest.fn().mockResolvedValue({ | ||
| results: [ | ||
| { | ||
| type: 'software-catalog', | ||
| document: { | ||
| title: 'Example Result', | ||
| location: '/catalog/default/component/example', | ||
| }, | ||
| }, | ||
| ], | ||
| }), | ||
| }; | ||
|
|
||
| const mockConfig = mockApis.config({ | ||
| data: { app: { baseUrl: 'https://example.com' } }, | ||
| }); | ||
|
|
||
| describe('SearchComponent', () => { | ||
| it('should render the SearchBar with initial state', () => { | ||
| render( | ||
| <TestApiProvider | ||
| apis={[ | ||
| [searchApiRef, mockSearchApi], | ||
| [configApiRef, mockConfig], | ||
| ]} | ||
| > | ||
| <SearchContextProvider> | ||
| <SearchComponent /> | ||
| </SearchContextProvider> | ||
| </TestApiProvider>, | ||
| ); | ||
|
|
||
| const searchBar = screen.getByTestId('search-bar'); | ||
| expect(searchBar).toBeInTheDocument(); | ||
| expect(searchBar).toHaveValue(''); | ||
| }); | ||
|
|
||
| it('should update the search term when typing in the SearchBar', () => { | ||
| render( | ||
| <TestApiProvider | ||
| apis={[ | ||
| [searchApiRef, mockSearchApi], | ||
| [configApiRef, mockConfig], | ||
| ]} | ||
| > | ||
| <SearchContextProvider> | ||
| <SearchComponent /> | ||
| </SearchContextProvider> | ||
| </TestApiProvider>, | ||
| ); | ||
|
|
||
| const searchBar = screen.getByTestId('search-bar'); | ||
| fireEvent.change(searchBar, { target: { value: 'example' } }); | ||
|
|
||
| expect(searchBar).toHaveValue('example'); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Not needed here because it's already a dependency above.
@ciiay can you please remove this in your next PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@christoph-jerolimov I actually added it because it failed on
yarn lintas following, removing it will block it from being pushed.