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

Jump to bottom

Use @testing-library/user-event in TimePicker tests #41270

Merged
merged 3 commits into from
May 25, 2022
Merged

Use @testing-library/user-event in TimePicker tests #41270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5462f1b
Use @testing-library/user-event in TimePicker tests
noisysocks May 24, 2022
ca9a4df
Update changelog
noisysocks May 24, 2022
676abf8
Merge branch 'trunk' into update/use-user-event-in-TimePicker-tests
noisysocks May 24, 2022
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
1 change: 1 addition & 0 deletions packages/components/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
- `BorderControl` updated to satisfy `react/exhuastive-deps` eslint rule ([#41259](https://github.com/WordPress/gutenberg/pull/41259))
- `CheckboxControl`: Add unit tests ([#41165](https://github.com/WordPress/gutenberg/pull/41165)).
- `BorderBoxControl`: fix some layout misalignments, especially for RTL users ([#41254](https://github.com/WordPress/gutenberg/pull/41254)).
- `TimePicker`: Update unit tests to use `@testing-library/user-event` ([#41270](https://github.com/WordPress/gutenberg/pull/41270)).

### Experimental

Expand Down
117 changes: 82 additions & 35 deletions packages/components/src/date-time/test/time.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
/**
* External dependencies
*/
import { render, fireEvent, screen } from '@testing-library/react';
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';

/**
* Internal dependencies
*/
import TimePicker from '../time';

describe( 'TimePicker', () => {
it( 'should call onChange with updated date values', () => {
it( 'should call onChange with updated date values', async () => {
const user = userEvent.setup( {
advanceTimers: jest.advanceTimersByTime,
} );

const onChangeSpy = jest.fn();

render(
Expand All @@ -26,38 +31,46 @@ describe( 'TimePicker', () => {
const hoursInput = screen.getByLabelText( 'Hours' );
const minutesInput = screen.getByLabelText( 'Minutes' );

fireEvent.change( monthInput, { target: { value: '12' } } );
fireEvent.blur( monthInput );
await user.selectOptions( monthInput, '12' );
await user.keyboard( '{Tab}' );

expect( onChangeSpy ).toHaveBeenCalledWith( '1986-12-18T11:00:00' );
onChangeSpy.mockClear();

fireEvent.change( dayInput, { target: { value: '22' } } );
fireEvent.blur( dayInput );
await user.clear( dayInput );
await user.type( dayInput, '22' );
await user.keyboard( '{Tab}' );

expect( onChangeSpy ).toHaveBeenCalledWith( '1986-12-22T11:00:00' );
onChangeSpy.mockClear();

fireEvent.change( yearInput, { target: { value: '2018' } } );
fireEvent.blur( yearInput );
await user.clear( yearInput );
await user.type( yearInput, '2018' );
await user.keyboard( '{Tab}' );

expect( onChangeSpy ).toHaveBeenCalledWith( '2018-12-22T11:00:00' );
onChangeSpy.mockClear();

fireEvent.change( hoursInput, { target: { value: '12' } } );
fireEvent.blur( hoursInput );
await user.clear( hoursInput );
await user.type( hoursInput, '12' );
await user.keyboard( '{Tab}' );

expect( onChangeSpy ).toHaveBeenCalledWith( '2018-12-22T00:00:00' );
onChangeSpy.mockClear();

fireEvent.change( minutesInput, { target: { value: '35' } } );
fireEvent.blur( minutesInput );
await user.clear( minutesInput );
await user.type( minutesInput, '35' );
await user.keyboard( '{Tab}' );

expect( onChangeSpy ).toHaveBeenCalledWith( '2018-12-22T00:35:00' );
onChangeSpy.mockClear();
} );

it( 'should call onChange with an updated hour (12-hour clock)', () => {
it( 'should call onChange with an updated hour (12-hour clock)', async () => {
const user = userEvent.setup( {
advanceTimers: jest.advanceTimersByTime,
} );

const onChangeSpy = jest.fn();

render(
Expand All @@ -70,13 +83,18 @@ describe( 'TimePicker', () => {

const hoursInput = screen.getByLabelText( 'Hours' );

fireEvent.change( hoursInput, { target: { value: '10' } } );
fireEvent.blur( hoursInput );
await user.clear( hoursInput );
await user.type( hoursInput, '10' );
await user.keyboard( '{Tab}' );

expect( onChangeSpy ).toHaveBeenCalledWith( '1986-10-18T10:00:00' );
} );

it( 'should not call onChange with an updated hour (12-hour clock) if the hour is out of bounds', () => {
it( 'should not call onChange with an updated hour (12-hour clock) if the hour is out of bounds', async () => {
const user = userEvent.setup( {
advanceTimers: jest.advanceTimersByTime,
} );

const onChangeSpy = jest.fn();

render(
Expand All @@ -89,13 +107,18 @@ describe( 'TimePicker', () => {

const hoursInput = screen.getByLabelText( 'Hours' );

fireEvent.change( hoursInput, { target: { value: '22' } } );
fireEvent.blur( hoursInput );
await user.clear( hoursInput );
await user.type( hoursInput, '22' );
await user.keyboard( '{Tab}' );

expect( onChangeSpy ).not.toHaveBeenCalled();
} );

it( 'should call onChange with an updated hour (24-hour clock)', () => {
it( 'should call onChange with an updated hour (24-hour clock)', async () => {
const user = userEvent.setup( {
advanceTimers: jest.advanceTimersByTime,
} );

const onChangeSpy = jest.fn();

render(
Expand All @@ -108,13 +131,18 @@ describe( 'TimePicker', () => {

const hoursInput = screen.getByLabelText( 'Hours' );

fireEvent.change( hoursInput, { target: { value: '22' } } );
fireEvent.blur( hoursInput );
await user.clear( hoursInput );
await user.type( hoursInput, '22' );
await user.keyboard( '{Tab}' );

expect( onChangeSpy ).toHaveBeenCalledWith( '1986-10-18T22:00:00' );
} );

it( 'should not call onChange with an updated minute if out of bounds', () => {
it( 'should not call onChange with an updated minute if out of bounds', async () => {
const user = userEvent.setup( {
advanceTimers: jest.advanceTimersByTime,
} );

const onChangeSpy = jest.fn();

render(
Expand All @@ -127,13 +155,18 @@ describe( 'TimePicker', () => {

const minutesInput = screen.getByLabelText( 'Minutes' );

fireEvent.change( minutesInput, { target: { value: '99' } } );
fireEvent.blur( minutesInput );
await user.clear( minutesInput );
await user.type( minutesInput, '99' );
await user.keyboard( '{Tab}' );

expect( onChangeSpy ).not.toHaveBeenCalled();
} );

it( 'should switch to PM correctly', () => {
it( 'should switch to PM correctly', async () => {
const user = userEvent.setup( {
advanceTimers: jest.advanceTimersByTime,
} );

const onChangeSpy = jest.fn();

render(
Expand All @@ -146,12 +179,16 @@ describe( 'TimePicker', () => {

const pmButton = screen.getByText( 'PM' );

fireEvent.click( pmButton );
await user.click( pmButton );

expect( onChangeSpy ).toHaveBeenCalledWith( '1986-10-18T23:00:00' );
} );

it( 'should switch to AM correctly', () => {
it( 'should switch to AM correctly', async () => {
const user = userEvent.setup( {
advanceTimers: jest.advanceTimersByTime,
} );

const onChangeSpy = jest.fn();

render(
Expand All @@ -164,12 +201,16 @@ describe( 'TimePicker', () => {

const amButton = screen.getByText( 'AM' );

fireEvent.click( amButton );
await user.click( amButton );

expect( onChangeSpy ).toHaveBeenCalledWith( '1986-10-18T11:00:00' );
} );

it( 'should allow to set the time correctly when the PM period is selected', () => {
it( 'should allow to set the time correctly when the PM period is selected', async () => {
const user = userEvent.setup( {
advanceTimers: jest.advanceTimersByTime,
} );

const onChangeSpy = jest.fn();

render(
Expand All @@ -181,11 +222,12 @@ describe( 'TimePicker', () => {
);

const pmButton = screen.getByText( 'PM' );
fireEvent.click( pmButton );
await user.click( pmButton );

const hoursInput = screen.getByLabelText( 'Hours' );
fireEvent.change( hoursInput, { target: { value: '6' } } );
fireEvent.blur( hoursInput );
await user.clear( hoursInput );
await user.type( hoursInput, '6' );
await user.keyboard( '{Tab}' );

// When clicking on 'PM', we expect the time to be 11pm
expect( onChangeSpy ).toHaveBeenNthCalledWith(
Expand All @@ -199,7 +241,11 @@ describe( 'TimePicker', () => {
);
} );

it( 'should truncate at the minutes on change', () => {
it( 'should truncate at the minutes on change', async () => {
const user = userEvent.setup( {
advanceTimers: jest.advanceTimersByTime,
} );

const onChangeSpy = jest.fn();

render(
Expand All @@ -212,8 +258,9 @@ describe( 'TimePicker', () => {

const minutesInput = screen.getByLabelText( 'Minutes' );

fireEvent.change( minutesInput, { target: { value: '22' } } );
fireEvent.blur( minutesInput );
await user.clear( minutesInput );
await user.type( minutesInput, '22' );
await user.keyboard( '{Tab}' );

expect( onChangeSpy ).toHaveBeenCalledWith( '1986-10-18T23:22:00' );
} );
Expand Down