refactor(controls): Migrate AdhocMetricOption.test to RTL (#29843)

This commit is contained in:
Ross Mabbett 2024-08-02 19:54:06 -04:00 committed by GitHub
parent 27c08d0e0e
commit 819597faf6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 65 additions and 43 deletions

View File

@ -16,13 +16,11 @@
* specific language governing permissions and limitations * specific language governing permissions and limitations
* under the License. * under the License.
*/ */
import sinon from 'sinon'; import { render, screen, fireEvent } from 'spec/helpers/testing-library';
import { shallow } from 'enzyme';
import { AGGREGATES } from 'src/explore/constants'; import { AGGREGATES } from 'src/explore/constants';
import AdhocMetricOption from 'src/explore/components/controls/MetricControl/AdhocMetricOption'; import AdhocMetricOption from 'src/explore/components/controls/MetricControl/AdhocMetricOption';
import AdhocMetric from 'src/explore/components/controls/MetricControl/AdhocMetric'; import AdhocMetric from 'src/explore/components/controls/MetricControl/AdhocMetric';
import ControlPopover from '../ControlPopover/ControlPopover'; import userEvent from '@testing-library/user-event';
const columns = [ const columns = [
{ type: 'VARCHAR(255)', column_name: 'source' }, { type: 'VARCHAR(255)', column_name: 'source' },
@ -35,49 +33,73 @@ const sumValueAdhocMetric = new AdhocMetric({
aggregate: AGGREGATES.SUM, aggregate: AGGREGATES.SUM,
}); });
const datasource = {
type: 'table',
id: 1,
uid: '1__table',
columnFormats: {},
verboseMap: {},
};
const defaultProps = {
adhocMetric: sumValueAdhocMetric,
savedMetric: {},
savedMetricsOptions: [],
onMetricEdit: jest.fn(),
columns,
datasource,
onMoveLabel: jest.fn(),
onDropLabel: jest.fn(),
index: 0,
};
function setup(overrides) { function setup(overrides) {
const onMetricEdit = sinon.spy();
const props = { const props = {
adhocMetric: sumValueAdhocMetric, ...defaultProps,
savedMetric: {},
savedMetrics: [],
onMetricEdit,
columns,
onMoveLabel: () => {},
onDropLabel: () => {},
index: 0,
...overrides, ...overrides,
}; };
const wrapper = shallow(<AdhocMetricOption {...props} />) return render(<AdhocMetricOption {...props} />, { useDnd: true });
.find('AdhocMetricPopoverTrigger')
.shallow();
return { wrapper, onMetricEdit };
} }
describe('AdhocMetricOption', () => { test('renders an overlay trigger wrapper for the label', () => {
it('renders an overlay trigger wrapper for the label', () => { setup();
const { wrapper } = setup(); expect(screen.getByText('SUM(value)')).toBeInTheDocument();
expect(wrapper.find(ControlPopover)).toExist(); });
expect(wrapper.find('OptionControlLabel')).toExist();
}); test('overwrites the adhocMetric in state with onLabelChange', async () => {
setup();
it('overwrites the adhocMetric in state with onLabelChange', () => { userEvent.click(screen.getByText('SUM(value)'));
const { wrapper } = setup(); userEvent.click(screen.getByTestId(/AdhocMetricEditTitle#trigger/i));
wrapper.instance().onLabelChange({ target: { value: 'new label' } }); const labelInput = await screen.findByTestId(/AdhocMetricEditTitle#input/i);
expect(wrapper.state('title').label).toBe('new label'); userEvent.clear(labelInput);
expect(wrapper.state('title').hasCustomLabel).toBe(true); userEvent.type(labelInput, 'new label');
}); expect(labelInput).toHaveValue('new label');
fireEvent.keyPress(labelInput, {
it('returns to default labels when the custom label is cleared', () => { key: 'Enter',
const { wrapper } = setup(); charCode: 13,
expect(wrapper.state('title').label).toBe('SUM(value)'); });
expect(screen.getByText(/new label/i)).toBeInTheDocument();
wrapper.instance().onLabelChange({ target: { value: 'new label' } }); });
expect(wrapper.state('title').label).toBe('new label');
test('returns to default labels when the custom label is cleared', async () => {
wrapper.instance().onLabelChange({ target: { value: '' } }); setup();
userEvent.click(screen.getByText('SUM(value)'));
expect(wrapper.state('title').label).toBe('SUM(value)'); userEvent.click(screen.getByTestId(/AdhocMetricEditTitle#trigger/i));
expect(wrapper.state('title').hasCustomLabel).toBe(false); const labelInput = await screen.findByTestId(/AdhocMetricEditTitle#input/i);
}); userEvent.clear(labelInput);
userEvent.type(labelInput, 'new label');
fireEvent.keyPress(labelInput, {
key: 'Enter',
charCode: 13,
});
expect(labelInput).not.toBeInTheDocument();
expect(screen.getByText(/new label/i)).toBeInTheDocument();
userEvent.click(screen.getByTestId(/AdhocMetricEditTitle#trigger/i));
expect(screen.getByPlaceholderText(/new label/i)).toBeInTheDocument();
userEvent.clear(labelInput);
fireEvent.keyPress(labelInput, {
key: 'Enter',
charCode: 13,
});
expect(screen.getByPlaceholderText('SUM(value)')).toBeInTheDocument();
}); });