From 6c068665839de0f836df6de5d3ad239766379e53 Mon Sep 17 00:00:00 2001 From: Geido <60598000+geido@users.noreply.github.com> Date: Wed, 7 Apr 2021 23:34:19 +0300 Subject: [PATCH] test: Tests and Storybook entry for the IndeterminateCheckbox Component (#13502) * Add tests for IndeterminateCheckbox * Add storybook entry * Fix linting issue * Remove mocked icon * Add jest.fn to mockedProps --- .../IndeterminateCheckbox.stories.tsx | 45 ++++++++++ .../IndeterminateCheckbox.test.tsx | 82 +++++++++++++++++++ .../index.tsx} | 2 +- 3 files changed, 128 insertions(+), 1 deletion(-) create mode 100644 superset-frontend/src/components/IndeterminateCheckbox/IndeterminateCheckbox.stories.tsx create mode 100644 superset-frontend/src/components/IndeterminateCheckbox/IndeterminateCheckbox.test.tsx rename superset-frontend/src/components/{IndeterminateCheckbox.tsx => IndeterminateCheckbox/index.tsx} (98%) diff --git a/superset-frontend/src/components/IndeterminateCheckbox/IndeterminateCheckbox.stories.tsx b/superset-frontend/src/components/IndeterminateCheckbox/IndeterminateCheckbox.stories.tsx new file mode 100644 index 0000000000000..71cbcf5e541dd --- /dev/null +++ b/superset-frontend/src/components/IndeterminateCheckbox/IndeterminateCheckbox.stories.tsx @@ -0,0 +1,45 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import React from 'react'; +import IndeterminateCheckbox, { IndeterminateCheckboxProps } from '.'; + +export default { + title: 'IndeterminateCheckbox', + component: IndeterminateCheckbox, +}; + +export const InteractiveIndeterminateCheckbox = ( + args: IndeterminateCheckboxProps, +) => ; + +InteractiveIndeterminateCheckbox.args = { + checked: false, + id: 'checkbox-id', + indeterminate: false, + title: 'Checkbox title', + onChange: () => null, +}; + +InteractiveIndeterminateCheckbox.story = { + parameters: { + knobs: { + disable: true, + }, + }, +}; diff --git a/superset-frontend/src/components/IndeterminateCheckbox/IndeterminateCheckbox.test.tsx b/superset-frontend/src/components/IndeterminateCheckbox/IndeterminateCheckbox.test.tsx new file mode 100644 index 0000000000000..7bced98f8eb81 --- /dev/null +++ b/superset-frontend/src/components/IndeterminateCheckbox/IndeterminateCheckbox.test.tsx @@ -0,0 +1,82 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import React from 'react'; +import { render, screen } from 'spec/helpers/testing-library'; +import userEvent from '@testing-library/user-event'; +import IndeterminateCheckbox from '.'; + +const mockedProps = { + checked: false, + id: 'checkbox-id', + indeterminate: false, + title: 'Checkbox title', + onChange: jest.fn(), +}; + +test('should render', () => { + const { container } = render(); + expect(container).toBeInTheDocument(); +}); + +test('should render the label', () => { + render(); + expect(screen.getByTitle('Checkbox title')).toBeInTheDocument(); +}); + +test('should render the checkbox', () => { + render(); + expect(screen.getByRole('checkbox')).toBeInTheDocument(); +}); + +test('should render the checkbox-half icon', () => { + const indeterminateProps = { + ...mockedProps, + indeterminate: true, + }; + render(); + expect(screen.getByRole('img')).toBeInTheDocument(); + expect(screen.getByRole('img')).toHaveAttribute( + 'aria-label', + 'checkbox-half', + ); +}); + +test('should render the checkbox-off icon', () => { + render(); + expect(screen.getByRole('img')).toBeInTheDocument(); + expect(screen.getByRole('img')).toHaveAttribute('aria-label', 'checkbox-off'); +}); + +test('should render the checkbox-on icon', () => { + const checkboxOnProps = { + ...mockedProps, + checked: true, + }; + render(); + expect(screen.getByRole('img')).toBeInTheDocument(); + expect(screen.getByRole('img')).toHaveAttribute('aria-label', 'checkbox-on'); +}); + +test('should call the onChange', () => { + render(); + const label = screen.getByTitle('Checkbox title'); + userEvent.click(label); + expect(mockedProps.onChange).toHaveBeenCalledTimes(1); +}); diff --git a/superset-frontend/src/components/IndeterminateCheckbox.tsx b/superset-frontend/src/components/IndeterminateCheckbox/index.tsx similarity index 98% rename from superset-frontend/src/components/IndeterminateCheckbox.tsx rename to superset-frontend/src/components/IndeterminateCheckbox/index.tsx index aa706fa7c151f..4056cac14b678 100644 --- a/superset-frontend/src/components/IndeterminateCheckbox.tsx +++ b/superset-frontend/src/components/IndeterminateCheckbox/index.tsx @@ -20,7 +20,7 @@ import React from 'react'; import { styled } from '@superset-ui/core'; import Icon from 'src/components/Icon'; -interface IndeterminateCheckboxProps { +export interface IndeterminateCheckboxProps { indeterminate: boolean; id: string; checked: boolean;