Skip to content

Commit 61a03c9

Browse files
authored
test: simplify date-picker unit tests and helpers (#4811)
1 parent 5509c62 commit 61a03c9

11 files changed

Lines changed: 132 additions & 178 deletions

‎integration/tests/dialog-date-picker.test.js‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import sinon from 'sinon';
55
import './not-animated-styles.js';
66
import '@vaadin/date-picker';
77
import '@vaadin/dialog';
8-
import { getOverlayContent, open, waitForScrollToFinish } from '@vaadin/date-picker/test/common.js';
8+
import { open, waitForScrollToFinish } from '@vaadin/date-picker/test/common.js';
99

1010
describe('date-picker in dialog', () => {
1111
let dialog, datepicker;
@@ -27,23 +27,26 @@ describe('date-picker in dialog', () => {
2727
});
2828

2929
describe('modal', () => {
30+
let overlayContent;
31+
3032
beforeEach(async () => {
3133
datepicker.inputElement.focus();
3234
await open(datepicker);
3335
await nextRender();
36+
overlayContent = datepicker._overlayContent;
3437
});
3538

3639
it('should focus the Today button on second Tab when inside a dialog', async () => {
3740
// Focus the month calendar
3841
await sendKeys({ press: 'Tab' });
3942

4043
await nextRender();
41-
await waitForScrollToFinish(getOverlayContent(datepicker));
44+
await waitForScrollToFinish(overlayContent);
4245

4346
// Focus the Today button
4447
await sendKeys({ press: 'Tab' });
4548

46-
expect(getOverlayContent(datepicker)._todayButton.hasAttribute('focused')).to.be.true;
49+
expect(overlayContent._todayButton.hasAttribute('focused')).to.be.true;
4750
});
4851

4952
it('should focus the Cancel button on Shift + Tab when inside a dialog', async () => {
@@ -52,15 +55,15 @@ describe('date-picker in dialog', () => {
5255
await sendKeys({ press: 'Tab' });
5356
await sendKeys({ up: 'Shift' });
5457

55-
expect(getOverlayContent(datepicker)._cancelButton.hasAttribute('focused')).to.be.true;
58+
expect(overlayContent._cancelButton.hasAttribute('focused')).to.be.true;
5659
});
5760

5861
it('should focus the input on calendar date Shift Tab when inside a dialog', async () => {
5962
// Move focus to the calendar
6063
await sendKeys({ press: 'Tab' });
6164

6265
await nextRender();
63-
await waitForScrollToFinish(getOverlayContent(datepicker));
66+
await waitForScrollToFinish(overlayContent);
6467

6568
const spy = sinon.spy(datepicker.inputElement, 'focus');
6669

‎packages/date-picker/test/basic.test.js‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { click, fixtureSync, keyboardEventFor, oneEvent, tap } from '@vaadin/tes
33
import { sendKeys } from '@web/test-runner-commands';
44
import sinon from 'sinon';
55
import '../src/vaadin-date-picker.js';
6-
import { close, getOverlayContent, open, touchTap, waitForOverlayRender } from './common.js';
6+
import { close, open, touchTap, waitForOverlayRender } from './common.js';
77

88
describe('basic features', () => {
99
let datepicker, input;
@@ -187,20 +187,22 @@ describe('basic features', () => {
187187
let overlayContent;
188188

189189
beforeEach(async () => {
190-
datepicker.set('i18n.weekdays', 'sunnuntai_maanantai_tiistai_keskiviikko_torstai_perjantai_lauantai'.split('_'));
191-
datepicker.set('i18n.weekdaysShort', 'su_ma_ti_ke_to_pe_la'.split('_'));
192-
datepicker.set('i18n.firstDayOfWeek', 1);
193-
datepicker.set('i18n.formatDate', (d) => {
194-
if (d) {
195-
return [d.day, d.month + 1, d.year].join('.');
196-
}
197-
});
198-
datepicker.set('i18n.clear', 'Tyhjennä');
199-
datepicker.set('i18n.today', 'Tänään');
200-
datepicker.set('i18n.cancel', 'Peruuta');
190+
datepicker.i18n = {
191+
...datepicker.i18n,
192+
weekdays: ['sunnuntai', 'maanantai', 'tiistai', 'keskiviikko', 'torstai', 'perjantai', 'lauantai'],
193+
weekdaysShort: ['su', 'ma', 'ti', 'ke', 'to', 'pe', 'la'],
194+
firstDayOfWeek: 1,
195+
today: 'Tänään',
196+
cancel: 'Peruuta',
197+
formatDate: (d) => {
198+
if (d) {
199+
return [d.day, d.month + 1, d.year].join('.');
200+
}
201+
},
202+
};
201203

202204
await open(datepicker);
203-
overlayContent = getOverlayContent(datepicker);
205+
overlayContent = datepicker._overlayContent;
204206
});
205207

206208
it('should notify i18n mutation to children', () => {

‎packages/date-picker/test/common.js‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -119,18 +119,6 @@ export function getFirstVisibleItem(scroller, bufferOffset) {
119119
});
120120
}
121121

122-
export function isFullscreen(datepicker) {
123-
return datepicker.$.overlay.getAttribute('fullscreen') !== null;
124-
}
125-
126-
export function getOverlayContent(datepicker) {
127-
// Ensure overlay content is rendered
128-
if (!datepicker._overlayContent) {
129-
datepicker.$.overlay.requestContentUpdate();
130-
}
131-
return datepicker._overlayContent;
132-
}
133-
134122
export function getFocusedMonth(overlayContent) {
135123
const months = Array.from(overlayContent.querySelectorAll('vaadin-month-calendar'));
136124
return months.find((month) => {

‎packages/date-picker/test/custom-input.test.js‎

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ import { fire, fixtureSync, tap } from '@vaadin/testing-helpers';
33
import sinon from 'sinon';
44
import './not-animated-styles.js';
55
import '../vaadin-date-picker-light.js';
6-
import { getOverlayContent, open, waitForScrollToFinish } from './common.js';
6+
import { open, setInputValue, waitForScrollToFinish } from './common.js';
77

88
describe('custom input', () => {
9-
let datepicker, input, overlay;
9+
let datepicker, overlay;
1010

1111
beforeEach(() => {
1212
datepicker = fixtureSync(`
@@ -15,7 +15,6 @@ describe('custom input', () => {
1515
</vaadin-date-picker-light>
1616
`);
1717
overlay = datepicker.$.overlay;
18-
input = datepicker.inputElement;
1918
});
2019

2120
it('should open calendar on tap', () => {
@@ -24,31 +23,27 @@ describe('custom input', () => {
2423
});
2524

2625
it('should open calendar on input', () => {
27-
input.value = '1';
28-
fire(input, 'input');
26+
setInputValue(datepicker, '1');
2927
expect(overlay.opened).to.be.true;
3028
});
3129

3230
it('should not open calendar on input when autoOpenDisabled is true', () => {
3331
datepicker.autoOpenDisabled = true;
34-
input.value = '1';
35-
fire(input, 'input');
32+
setInputValue(datepicker, '1');
3633
expect(overlay.opened).not.to.be.true;
3734
});
3835

3936
it('should close on overlay date tap', async () => {
4037
await open(datepicker);
4138
const spy = sinon.spy(datepicker, 'close');
42-
const evt = new CustomEvent('date-tap', { detail: { date: new Date() }, bubbles: true, composed: true });
43-
getOverlayContent(datepicker).dispatchEvent(evt);
39+
fire(datepicker._overlayContent, 'date-tap', { date: new Date() });
4440
expect(spy.called).to.be.true;
4541
});
4642

4743
it('should show week numbers', async () => {
4844
datepicker.showWeekNumbers = true;
4945
await open(datepicker);
50-
const overlayContent = getOverlayContent(datepicker);
51-
expect(overlayContent.showWeekNumbers).to.be.true;
46+
expect(datepicker._overlayContent.showWeekNumbers).to.be.true;
5247
});
5348

5449
describe('theme attribute', () => {
@@ -62,8 +57,7 @@ describe('custom input', () => {
6257

6358
it('should propagate theme attribute to overlay content', async () => {
6459
await open(datepicker);
65-
const overlayContent = getOverlayContent(datepicker);
66-
expect(overlayContent.getAttribute('theme')).to.equal('foo');
60+
expect(datepicker._overlayContent.getAttribute('theme')).to.equal('foo');
6761
});
6862

6963
describe('in content', () => {
@@ -72,7 +66,7 @@ describe('custom input', () => {
7266
});
7367

7468
it('should propagate theme attribute to month calendar', async () => {
75-
const overlayContent = getOverlayContent(datepicker);
69+
const overlayContent = datepicker._overlayContent;
7670
await waitForScrollToFinish(overlayContent);
7771
const monthCalendar = overlayContent.querySelector('vaadin-month-calendar');
7872
expect(monthCalendar.getAttribute('theme')).to.equal('foo');

‎packages/date-picker/test/dropdown.test.js‎

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import { expect } from '@esm-bundle/chai';
2-
import { aTimeout, fixtureSync, mousedown, nextRender, oneEvent, touchstart } from '@vaadin/testing-helpers';
2+
import { aTimeout, fire, fixtureSync, mousedown, nextRender, oneEvent, touchstart } from '@vaadin/testing-helpers';
33
import { sendKeys } from '@web/test-runner-commands';
44
import sinon from 'sinon';
55
import '../src/vaadin-date-picker.js';
6-
import { getFocusedCell, getOverlayContent, monthsEqual, open, outsideClick, waitForOverlayRender } from './common.js';
6+
import { getFocusedCell, monthsEqual, open, outsideClick, waitForOverlayRender } from './common.js';
77

88
describe('dropdown', () => {
99
let datepicker, input, overlay;
@@ -49,18 +49,15 @@ describe('dropdown', () => {
4949
});
5050

5151
it('should prevent default for the toggle button mousedown', () => {
52-
const e = new CustomEvent('mousedown', { bubbles: true });
53-
const spy = sinon.spy(e, 'preventDefault');
54-
toggleButton.dispatchEvent(e);
55-
expect(spy.calledOnce).to.be.true;
52+
const event = fire(toggleButton, 'mousedown');
53+
expect(event.defaultPrevented).to.be.true;
5654
});
5755
});
5856

5957
describe('scroll to date', () => {
6058
it('should scroll to today by default', async () => {
6159
datepicker.open();
62-
const overlayContent = getOverlayContent(datepicker);
63-
const spy = sinon.spy(overlayContent, 'scrollToDate');
60+
const spy = sinon.spy(datepicker._overlayContent, 'scrollToDate');
6461
await oneEvent(overlay, 'vaadin-overlay-open');
6562
await waitForOverlayRender();
6663

@@ -72,8 +69,7 @@ describe('dropdown', () => {
7269
datepicker.initialPosition = '2016-01-01';
7370

7471
datepicker.open();
75-
const overlayContent = getOverlayContent(datepicker);
76-
const spy = sinon.spy(overlayContent, 'scrollToDate');
72+
const spy = sinon.spy(datepicker._overlayContent, 'scrollToDate');
7773
await oneEvent(overlay, 'vaadin-overlay-open');
7874
await waitForOverlayRender();
7975

@@ -85,8 +81,7 @@ describe('dropdown', () => {
8581
datepicker.value = '2000-02-01';
8682

8783
datepicker.open();
88-
const overlayContent = getOverlayContent(datepicker);
89-
const spy = sinon.spy(overlayContent, 'scrollToDate');
84+
const spy = sinon.spy(datepicker._overlayContent, 'scrollToDate');
9085
await oneEvent(overlay, 'vaadin-overlay-open');
9186
await waitForOverlayRender();
9287

@@ -96,7 +91,7 @@ describe('dropdown', () => {
9691

9792
it('should remember the initial position on reopen', async () => {
9893
await open(datepicker);
99-
const overlayContent = getOverlayContent(datepicker);
94+
const overlayContent = datepicker._overlayContent;
10095
const initialPosition = overlayContent.initialPosition;
10196

10297
datepicker.close();
@@ -108,11 +103,10 @@ describe('dropdown', () => {
108103

109104
it('should scroll to date on reopen', async () => {
110105
datepicker.open();
111-
const overlayContent = getOverlayContent(datepicker);
112106

113107
// We must scroll to initial position on reopen because
114108
// scrollTop can be reset while the dropdown is closed.
115-
const spy = sinon.spy(overlayContent, 'scrollToDate');
109+
const spy = sinon.spy(datepicker._overlayContent, 'scrollToDate');
116110
await oneEvent(overlay, 'vaadin-overlay-open');
117111
await waitForOverlayRender();
118112
expect(spy.called).to.be.true;
@@ -129,8 +123,7 @@ describe('dropdown', () => {
129123
datepicker.min = '2100-01-01';
130124

131125
datepicker.open();
132-
const overlayContent = getOverlayContent(datepicker);
133-
const spy = sinon.spy(overlayContent, 'scrollToDate');
126+
const spy = sinon.spy(datepicker._overlayContent, 'scrollToDate');
134127
await oneEvent(overlay, 'vaadin-overlay-open');
135128
await waitForOverlayRender();
136129

@@ -142,8 +135,7 @@ describe('dropdown', () => {
142135
datepicker.max = '2000-01-01';
143136

144137
datepicker.open();
145-
const overlayContent = getOverlayContent(datepicker);
146-
const spy = sinon.spy(overlayContent, 'scrollToDate');
138+
const spy = sinon.spy(datepicker._overlayContent, 'scrollToDate');
147139
await oneEvent(overlay, 'vaadin-overlay-open');
148140
await waitForOverlayRender();
149141

@@ -158,8 +150,7 @@ describe('dropdown', () => {
158150
datepicker.initialPosition = '2015-01-01';
159151

160152
datepicker.open();
161-
const overlayContent = getOverlayContent(datepicker);
162-
const spy = sinon.spy(overlayContent, 'scrollToDate');
153+
const spy = sinon.spy(datepicker._overlayContent, 'scrollToDate');
163154
await oneEvent(overlay, 'vaadin-overlay-open');
164155
await waitForOverlayRender();
165156

@@ -214,8 +205,7 @@ describe('dropdown', () => {
214205

215206
describe('date tap', () => {
216207
function dateTap() {
217-
const content = getOverlayContent(datepicker);
218-
const date = getFocusedCell(content);
208+
const date = getFocusedCell(datepicker._overlayContent);
219209
mousedown(date);
220210
date.focus();
221211
date.click();

‎packages/date-picker/test/fullscreen.test.js‎

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { fixtureSync, tap } from '@vaadin/testing-helpers';
33
import { sendKeys, setViewport } from '@web/test-runner-commands';
44
import sinon from 'sinon';
55
import '../src/vaadin-date-picker.js';
6-
import { getFocusedCell, getOverlayContent, open, touchTap, waitForOverlayRender } from './common.js';
6+
import { getFocusedCell, open, touchTap, waitForOverlayRender } from './common.js';
77

88
describe('fullscreen mode', () => {
99
let datepicker, input, overlay, width, height;
@@ -66,8 +66,7 @@ describe('fullscreen mode', () => {
6666

6767
it('should focus date element when opening overlay', async () => {
6868
await open(datepicker);
69-
const content = getOverlayContent(datepicker);
70-
const cell = getFocusedCell(content);
69+
const cell = getFocusedCell(datepicker._overlayContent);
7170
expect(cell).to.be.instanceOf(HTMLTableCellElement);
7271
expect(cell.hasAttribute('today')).to.be.true;
7372
});
@@ -124,22 +123,49 @@ describe('fullscreen mode', () => {
124123
});
125124

126125
describe('buttons', () => {
126+
let overlayContent;
127+
127128
beforeEach(async () => {
128129
await open(datepicker);
130+
overlayContent = datepicker._overlayContent;
129131
});
130132

131133
it('should close the dropdown on Today button Esc', async () => {
132-
getOverlayContent(datepicker)._todayButton.focus();
134+
overlayContent._todayButton.focus();
133135
await sendKeys({ press: 'Escape' });
134136

135137
expect(datepicker.opened).to.be.false;
136138
});
137139

138140
it('should close the dropdown on Cancel button Esc', async () => {
139-
getOverlayContent(datepicker).focusCancel();
141+
overlayContent.focusCancel();
140142
await sendKeys({ press: 'Escape' });
141143

142144
expect(datepicker.opened).to.be.false;
143145
});
146+
147+
it('should move focus to Cancel button on date cell Shift Tab', async () => {
148+
const spy = sinon.spy(overlayContent._cancelButton, 'focus');
149+
150+
await sendKeys({ down: 'Shift' });
151+
await sendKeys({ press: 'Tab' });
152+
await sendKeys({ up: 'Shift' });
153+
154+
expect(spy.calledOnce).to.be.true;
155+
});
156+
157+
it('should move focus to date cell button on Cancel button Tab', async () => {
158+
const cell = getFocusedCell(overlayContent);
159+
const spy = sinon.spy(cell, 'focus');
160+
161+
// Move focus to Cancel button
162+
await sendKeys({ down: 'Shift' });
163+
await sendKeys({ press: 'Tab' });
164+
await sendKeys({ up: 'Shift' });
165+
166+
await sendKeys({ press: 'Tab' });
167+
168+
expect(spy.calledOnce).to.be.true;
169+
});
144170
});
145171
});

0 commit comments

Comments
 (0)