-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Test suite for useSessionSettingsManager, tests for voter session man…
…agement in app, and test for resetting voter settings on polls close
- Loading branch information
1 parent
911ba4b
commit f8c585d
Showing
3 changed files
with
243 additions
and
29 deletions.
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
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
147 changes: 147 additions & 0 deletions
147
apps/scan/frontend/src/utils/use_session_settings_manager.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,147 @@ | ||
| import { | ||
| AppBase, | ||
| LanguageControls, | ||
| useCurrentLanguage, | ||
| VoterSettingsManagerContext, | ||
| } from '@votingworks/ui'; | ||
| import { DefaultTheme, ThemeContext } from 'styled-components'; | ||
| import React from 'react'; | ||
| import { LanguageCode } from '@votingworks/types'; | ||
| import { mockOf } from '@votingworks/test-utils'; | ||
| import { useSessionSettingsManager } from './use_session_settings_manager'; | ||
| import { renderHook, act } from '../../test/react_testing_library'; | ||
| import { ApiMock, createApiMock } from '../../test/helpers/mock_api_client'; | ||
|
|
||
| let apiMock: ApiMock; | ||
| const mockLanguageControls: jest.Mocked<LanguageControls> = { | ||
| reset: jest.fn(), | ||
| setLanguage: jest.fn(), | ||
| }; | ||
| const mockUseCurrentLanguage = mockOf(useCurrentLanguage); | ||
|
|
||
| jest.mock('@votingworks/ui', (): typeof import('@votingworks/ui') => ({ | ||
| ...jest.requireActual('@votingworks/ui'), | ||
| useCurrentLanguage: jest.fn(), | ||
| useLanguageControls: () => mockLanguageControls, | ||
| })); | ||
|
|
||
| const DEFAULT_THEME = { | ||
| colorMode: 'contrastMedium', | ||
| sizeMode: 'touchMedium', | ||
| isVisualModeDisabled: false, | ||
| } as const satisfies Partial<DefaultTheme>; | ||
|
|
||
| function TestHookWrapper(props: { children: React.ReactNode }) { | ||
| return ( | ||
| <AppBase | ||
| {...props} | ||
| defaultColorMode={DEFAULT_THEME.colorMode} | ||
| defaultSizeMode={DEFAULT_THEME.sizeMode} | ||
| defaultIsVisualModeDisabled={DEFAULT_THEME.isVisualModeDisabled ?? false} | ||
| disableFontsForTests | ||
| /> | ||
| ); | ||
| } | ||
|
|
||
| function useTestHook() { | ||
| const theme = React.useContext(ThemeContext); | ||
| const voterSettingsManager = React.useContext(VoterSettingsManagerContext); | ||
| const [mockLanguage, setMockLanguage] = React.useState(LanguageCode.ENGLISH); | ||
| const voterSettingsControls = useSessionSettingsManager(); | ||
| mockUseCurrentLanguage.mockReturnValue(mockLanguage); | ||
|
|
||
| return { | ||
| theme, | ||
| setMockLanguage, | ||
| voterSettingsManager, | ||
| ...voterSettingsControls, | ||
| }; | ||
| } | ||
|
|
||
| beforeEach(() => { | ||
| jest.clearAllMocks(); | ||
| apiMock = createApiMock(); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| apiMock.mockApiClient.assertComplete(); | ||
| }); | ||
|
|
||
| it('Reset voter settings when resetVoterSettings is called', () => { | ||
| const { result } = renderHook(() => useTestHook(), { | ||
| wrapper: TestHookWrapper, | ||
| }); | ||
|
|
||
| expect(mockLanguageControls.reset).not.toHaveBeenCalled(); | ||
| expect(mockLanguageControls.setLanguage).not.toHaveBeenCalled(); | ||
|
|
||
| // Simulate changing session settings as voter: | ||
| act(() => { | ||
| result.current.voterSettingsManager.setColorMode('contrastLow'); | ||
| result.current.voterSettingsManager.setSizeMode('touchExtraLarge'); | ||
| }); | ||
| expect(result.current.theme).toEqual( | ||
| expect.objectContaining<Partial<DefaultTheme>>({ | ||
| colorMode: 'contrastLow', | ||
| sizeMode: 'touchExtraLarge', | ||
| }) | ||
| ); | ||
|
|
||
| // Reset voter settings | ||
| act(() => { | ||
| result.current.resetVoterSettings(); | ||
| }); | ||
|
|
||
| // Validate settings were reset | ||
| expect(mockLanguageControls.reset).toHaveBeenCalledTimes(1); | ||
| expect(mockLanguageControls.setLanguage).not.toHaveBeenCalled(); | ||
| expect(result.current.theme).toEqual( | ||
| expect.objectContaining<Partial<DefaultTheme>>(DEFAULT_THEME) | ||
| ); | ||
| }); | ||
|
|
||
| it('First cache/clear voter settings and then restore', () => { | ||
| const { result } = renderHook(() => useTestHook(), { | ||
| wrapper: TestHookWrapper, | ||
| }); | ||
|
|
||
| // Simulate changing session settings as voter: | ||
| act(() => { | ||
| result.current.voterSettingsManager.setColorMode('contrastLow'); | ||
| result.current.voterSettingsManager.setSizeMode('touchExtraLarge'); | ||
| result.current.setMockLanguage(LanguageCode.SPANISH); | ||
| }); | ||
|
|
||
| expect(result.current.theme).toEqual( | ||
| expect.objectContaining<Partial<DefaultTheme>>({ | ||
| colorMode: 'contrastLow', | ||
| sizeMode: 'touchExtraLarge', | ||
| }) | ||
| ); | ||
|
|
||
| // Cache and reset voter settings | ||
| act(() => { | ||
| result.current.cacheAndResetVoterSettings(); | ||
| }); | ||
|
|
||
| // Validate settings were reset | ||
| expect(mockLanguageControls.reset).toHaveBeenCalledTimes(1); | ||
| expect(mockLanguageControls.setLanguage).not.toHaveBeenCalled(); | ||
| expect(result.current.theme).toEqual( | ||
| expect.objectContaining<Partial<DefaultTheme>>(DEFAULT_THEME) | ||
| ); | ||
|
|
||
| // Restore voter settings | ||
| act(() => { | ||
| result.current.restoreVoterSessionsSettings(); | ||
| }); | ||
|
|
||
| // Validate settings were restored | ||
| expect(result.current.theme).toEqual( | ||
| expect.objectContaining<Partial<DefaultTheme>>({ | ||
| colorMode: 'contrastLow', | ||
| sizeMode: 'touchExtraLarge', | ||
| }) | ||
| ); | ||
| expect(mockLanguageControls.setLanguage).toHaveBeenCalledTimes(1); | ||
| }); |