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

[Lens] test suite - replace React specific props events with html events #113156

Merged
merged 1 commit into from
Sep 28, 2021
Merged

[Lens] test suite - replace React specific props events with html events #113156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 6 additions & 8 deletions x-pack/plugins/lens/public/datatable_visualization/components/dimension_editor.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,14 +205,12 @@ describe('data table dimension editor', () => {
state.columns[0].colorMode = 'cell';
const instance = mountWithIntl(<TableDimensionEditor {...props} />);

act(() =>
(
instance
.find('[data-test-subj="lnsDatatable_dynamicColoring_trigger"]')
.first()
.prop('onClick') as () => void
)?.()
);
act(() => {
instance
.find('[data-test-subj="lnsDatatable_dynamicColoring_trigger"]')
.first()
.simulate('click');
});

expect(instance.find(PalettePanelContainer).exists()).toBe(true);
});
Expand Down
71 changes: 41 additions & 30 deletions x-pack/plugins/lens/public/indexpattern_datasource/datapanel.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
* 2.0.
*/

import React, { ChangeEvent, ReactElement } from 'react';
import React from 'react';
import { waitFor } from '@testing-library/react';
import ReactDOM from 'react-dom';
import { createMockedDragDropContext } from './mocks';
import { dataPluginMock } from '../../../../../src/plugins/data/public/mocks';
import { InnerIndexPatternDataPanel, IndexPatternDataPanel, MemoizedDataPanel } from './datapanel';
Expand Down Expand Up @@ -240,6 +242,9 @@ const initialState: IndexPatternPrivateState = {

const dslQuery = { bool: { must: [], filter: [], should: [], must_not: [] } };

// @ts-expect-error Portal mocks are notoriously difficult to type
ReactDOM.createPortal = jest.fn((element) => element);

describe('IndexPattern Data Panel', () => {
let defaultProps: Parameters<typeof InnerIndexPatternDataPanel>[0] & {
showNoDataPopover: () => void;
Expand Down Expand Up @@ -752,14 +757,13 @@ describe('IndexPattern Data Panel', () => {
it('should filter down by name', () => {
const wrapper = mountWithIntl(<InnerIndexPatternDataPanel {...props} />);
act(() => {
wrapper.find('[data-test-subj="lnsIndexPatternFieldSearch"]').prop('onChange')!({
wrapper.find('[data-test-subj="lnsIndexPatternFieldSearch"]').simulate('change', {
target: { value: 'me' },
} as ChangeEvent<HTMLInputElement>);
});
});

wrapper
.find('[data-test-subj="lnsIndexPatternEmptyFields"]')
.find('button')
.find('[data-test-subj="lnsIndexPatternEmptyFields"] button')
.first()
.simulate('click');

Expand All @@ -772,9 +776,9 @@ describe('IndexPattern Data Panel', () => {
it('should announce filter in live region', () => {
const wrapper = mountWithIntl(<InnerIndexPatternDataPanel {...props} />);
act(() => {
wrapper.find('[data-test-subj="lnsIndexPatternFieldSearch"]').prop('onChange')!({
wrapper.find('[data-test-subj="lnsIndexPatternFieldSearch"]').simulate('change', {
target: { value: 'me' },
} as ChangeEvent<HTMLInputElement>);
});
});

wrapper
Expand Down Expand Up @@ -832,9 +836,9 @@ describe('IndexPattern Data Panel', () => {
it('should filter down by type and by name', () => {
const wrapper = mountWithIntl(<InnerIndexPatternDataPanel {...props} />);
act(() => {
wrapper.find('[data-test-subj="lnsIndexPatternFieldSearch"]').prop('onChange')!({
wrapper.find('[data-test-subj="lnsIndexPatternFieldSearch"]').simulate('change', {
target: { value: 'me' },
} as ChangeEvent<HTMLInputElement>);
});
});

wrapper.find('[data-test-subj="lnsIndexPatternFiltersToggle"]').first().simulate('click');
Expand All @@ -856,24 +860,26 @@ describe('IndexPattern Data Panel', () => {
);
const wrapper = mountWithIntl(<InnerIndexPatternDataPanel {...props} />);
act(() => {
(
wrapper
.find('[data-test-subj="lnsIndexPatternActions-popover"]')
.first()
.prop('children') as ReactElement
).props.items[0].props.onClick();
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks to mocking the portal: ReactDOM.createPortal = jest.fn((element) => element) we can just assume that the content of the popover will be placed directly inside the popover. And thanks to that we can avoid the ugly lines above.

const popoverTrigger = wrapper.find(
'[data-test-subj="lnsIndexPatternActions-popover"] button'
);
popoverTrigger.simulate('click');
});

wrapper.update();
act(() => {
wrapper.find('[data-test-subj="indexPattern-add-field"]').first().simulate('click');
});
// wait for indx pattern to be loaded
await act(async () => await new Promise((r) => setTimeout(r, 0)));
Copy link
Contributor Author

@mbondyra mbondyra Sep 28, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am a bit on the edge of replacing this with waitFor - I think it's more readable, but it comes from react/testing-library and we use in 99% enzyme. There are one more place where we use react-testing-library in lens (testing debouncing hook) and some other teams use it extensively in Kibana, so I am not sure. Thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The behaviour is different between the 2 things.
I think waitFor is more reliable than a manual arbitrary waiting. So 👍


expect(props.indexPatternFieldEditor.openEditor).toHaveBeenCalledWith(
expect.objectContaining({
ctx: expect.objectContaining({
indexPattern: mockIndexPattern,
}),
})
);
await waitFor(() => {
expect(props.indexPatternFieldEditor.openEditor).toHaveBeenCalledWith(
expect.objectContaining({
ctx: expect.objectContaining({
indexPattern: mockIndexPattern,
}),
})
);
});
});

it('should reload index pattern if callback gets called', async () => {
Expand All @@ -891,14 +897,19 @@ describe('IndexPattern Data Panel', () => {
Promise.resolve(mockIndexPattern)
);
const wrapper = mountWithIntl(<InnerIndexPatternDataPanel {...props} />);

act(() => {
(
wrapper
.find('[data-test-subj="lnsIndexPatternActions-popover"]')
.first()
.prop('children') as ReactElement
).props.items[0].props.onClick();
const popoverTrigger = wrapper.find(
'[data-test-subj="lnsIndexPatternActions-popover"] button'
);
popoverTrigger.simulate('click');
});

wrapper.update();
act(() => {
wrapper.find('[data-test-subj="indexPattern-add-field"]').first().simulate('click');
});

// wait for indx pattern to be loaded
await act(async () => await new Promise((r) => setTimeout(r, 0)));

Expand Down
30 changes: 14 additions & 16 deletions ...lugins/lens/public/indexpattern_datasource/dimension_panel/bucket_nesting_editor.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,10 @@ describe('BucketNestingEditor', () => {
/>
);

const nestingSwitch = component.find('[data-test-subj="indexPattern-nesting-switch"]').first();
(nestingSwitch.prop('onChange') as () => {})();
component
.find('[data-test-subj="indexPattern-nesting-switch"] button')
.first()
.simulate('click');

expect(setColumns).toHaveBeenCalledTimes(1);
expect(setColumns).toHaveBeenCalledWith(['a', 'b', 'c']);
Expand All @@ -117,12 +119,10 @@ describe('BucketNestingEditor', () => {
},
});

(
component
.find('[data-test-subj="indexPattern-nesting-switch"]')
.first()
.prop('onChange') as () => {}
)();
component
.find('[data-test-subj="indexPattern-nesting-switch"] button')
.first()
.simulate('click');

expect(setColumns).toHaveBeenCalledTimes(2);
expect(setColumns).toHaveBeenLastCalledWith(['b', 'a', 'c']);
Expand Down Expand Up @@ -212,8 +212,8 @@ describe('BucketNestingEditor', () => {
/>
);

const control = component.find('[data-test-subj="indexPattern-nesting-select"]').first();
(control.prop('onChange') as (e: unknown) => {})({
const control = component.find('[data-test-subj="indexPattern-nesting-select"] select').first();
control.simulate('change', {
target: { value: 'b' },
});

Expand All @@ -239,10 +239,8 @@ describe('BucketNestingEditor', () => {
/>
);

const control = component.find('[data-test-subj="indexPattern-nesting-select"]').first();
(control.prop('onChange') as (e: unknown) => {})({
target: { value: '' },
});
const control = component.find('[data-test-subj="indexPattern-nesting-select"] select').first();
control.simulate('change', { target: { value: '' } });

expect(setColumns).toHaveBeenCalledWith(['a', 'c', 'b']);
});
Expand All @@ -266,8 +264,8 @@ describe('BucketNestingEditor', () => {
/>
);

const control = component.find('[data-test-subj="indexPattern-nesting-select"]').first();
(control.prop('onChange') as (e: unknown) => {})({
const control = component.find('[data-test-subj="indexPattern-nesting-select"] select').first();
control.simulate('change', {
target: { value: '' },
});

Expand Down
49 changes: 17 additions & 32 deletions x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_panel.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import { ReactWrapper, ShallowWrapper } from 'enzyme';
import 'jest-canvas-mock';
import React, { ChangeEvent, MouseEvent } from 'react';
import React from 'react';
import { act } from 'react-dom/test-utils';
import {
EuiComboBox,
Expand Down Expand Up @@ -1213,15 +1213,14 @@ describe('IndexPatternDimensionEditorPanel', () => {
const props = getProps({ timeScale: 's', label: 'Count of records per second' });
wrapper = mount(<IndexPatternDimensionEditorComponent {...props} />);
wrapper
.find('[data-test-subj="indexPattern-advanced-popover"]')
.find('button[data-test-subj="indexPattern-advanced-popover"]')
.hostNodes()
.simulate('click');
wrapper
.find('[data-test-subj="indexPattern-time-scaling-unit"]')
.find(EuiSelect)
.prop('onChange')!({

wrapper.find('[data-test-subj="indexPattern-time-scaling-unit"] select').simulate('change', {
target: { value: 'h' },
} as unknown as ChangeEvent<HTMLSelectElement>);
});

expect(setState.mock.calls[0]).toEqual([expect.any(Function), { isDimensionComplete: true }]);
expect(setState.mock.calls[0][0](props.state)).toEqual({
...props.state,
Expand All @@ -1243,12 +1242,9 @@ describe('IndexPatternDimensionEditorPanel', () => {
it('should not adjust label if it is custom', () => {
const props = getProps({ timeScale: 's', customLabel: true, label: 'My label' });
wrapper = mount(<IndexPatternDimensionEditorComponent {...props} />);
wrapper
.find('[data-test-subj="indexPattern-time-scaling-unit"]')
.find(EuiSelect)
.prop('onChange')!({
wrapper.find('[data-test-subj="indexPattern-time-scaling-unit"] select').simulate('change', {
target: { value: 'h' },
} as unknown as ChangeEvent<HTMLSelectElement>);
});
expect(setState.mock.calls[0]).toEqual([expect.any(Function), { isDimensionComplete: true }]);
expect(setState.mock.calls[0][0](props.state)).toEqual({
...props.state,
Expand All @@ -1270,13 +1266,7 @@ describe('IndexPatternDimensionEditorPanel', () => {
it('should allow to remove time scaling', () => {
const props = getProps({ timeScale: 's', label: 'Count of records per second' });
wrapper = mount(<IndexPatternDimensionEditorComponent {...props} />);
wrapper
.find('[data-test-subj="indexPattern-time-scaling-remove"]')
.find(EuiButtonIcon)
.prop('onClick')!(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
{} as any
);
wrapper.find('[data-test-subj="indexPattern-time-scaling-remove"] button').simulate('click');
expect(setState.mock.calls[0]).toEqual([expect.any(Function), { isDimensionComplete: true }]);
expect(setState.mock.calls[0][0](props.state)).toEqual({
...props.state,
Expand Down Expand Up @@ -1391,7 +1381,7 @@ describe('IndexPatternDimensionEditorPanel', () => {
.find(AdvancedOptions)
.dive()
.find('[data-test-subj="indexPattern-time-shift-enable"]')
.prop('onClick')!({} as MouseEvent);
.simulate('click');
expect((props.setState as jest.Mock).mock.calls[0][0](props.state)).toEqual({
...props.state,
layers: {
Expand Down Expand Up @@ -1465,10 +1455,7 @@ describe('IndexPatternDimensionEditorPanel', () => {
wrapper
.find('[data-test-subj="indexPattern-time-shift-remove"]')
.find(EuiButtonIcon)
.prop('onClick')!(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
{} as any
);
.simulate('click');
expect((props.setState as jest.Mock).mock.calls[0][0](props.state)).toEqual({
...props.state,
layers: {
Expand Down Expand Up @@ -1657,10 +1644,8 @@ describe('IndexPatternDimensionEditorPanel', () => {
wrapper
.find('[data-test-subj="indexPattern-filter-by-remove"]')
.find(EuiButtonIcon)
.prop('onClick')!(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
{} as any
);
.simulate('click');

expect(setState.mock.calls[0]).toEqual([expect.any(Function), { isDimensionComplete: true }]);
expect(setState.mock.calls[0][0](props.state)).toEqual({
...props.state,
Expand Down Expand Up @@ -1963,11 +1948,11 @@ describe('IndexPatternDimensionEditorPanel', () => {
wrapper = mount(
<IndexPatternDimensionEditorComponent {...defaultProps} state={initialState} />
);

act(() => {
wrapper.find('[data-test-subj="lns-indexPatternDimension-min"]').first().prop('onClick')!(
{} as MouseEvent
);
wrapper
.find('button[data-test-subj="lns-indexPatternDimension-min"]')
.first()
.simulate('click');
});

expect(replaceColumn).toHaveBeenCalledWith(
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/lens/public/indexpattern_datasource/field_item.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* 2.0.
*/

import React, { MouseEvent, ReactElement } from 'react';
import React, { ReactElement } from 'react';
import { ReactWrapper } from 'enzyme';
import { act } from 'react-dom/test-utils';
import { EuiLoadingSpinner, EuiPopover } from '@elastic/eui';
Expand Down Expand Up @@ -139,7 +139,7 @@ describe('IndexPattern Field Item', () => {
mountWithIntl(popoverContent as ReactElement)
.find('[data-test-subj="lnsFieldListPanelEdit"]')
.first()
.prop('onClick')!({} as MouseEvent);
.simulate('click');
});
expect(editFieldSpy).toHaveBeenCalledWith('bytes');
});
Expand Down
Loading