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

test(react): update toggle tests to use react testing library #10452

Merged
merged 5 commits into from
Jan 18, 2022
Merged

test(react): update toggle tests to use react testing library #10452

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8693951
chore: check in progress
abbeyhrt Jan 14, 2022
d116b43
test(react): update Toggle tests to rtl
abbeyhrt Jan 14, 2022
0f7223e
Merge branch 'main' into test/toggle
abbeyhrt Jan 14, 2022
ab32c83
Merge branch 'main' into test/toggle
abbeyhrt Jan 18, 2022
a9c567b
Merge branch 'main' into test/toggle
kodiakhq[bot] Jan 18, 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
165 changes: 60 additions & 105 deletions packages/react/src/components/Toggle/Toggle-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,131 +7,86 @@

import React from 'react';
import Toggle from '../Toggle';
import { mount } from 'enzyme';
import { settings } from 'carbon-components';

const { prefix } = settings;
describe('Toggle', () => {
const commonProps = {
'aria-label': 'Toggle label',
labelA: 'Off',
labelB: 'On',
labelText: 'Toggle label',
};

describe('Renders as expected', () => {
const wrapper = mount(<Toggle {...commonProps} id="toggle-1" />);

const input = wrapper.find('input');

it('Switch and label Ids should match', () => {
const toggleLabel = wrapper.find(`.${prefix}--toggle__label`);
expect(input.id).toEqual(toggleLabel.htmlFor);
});

it('should set defaultChecked as expected', () => {
expect(input.props().defaultChecked).toEqual(false);
wrapper.setProps({ defaultToggled: true });
expect(wrapper.find('input').props().defaultChecked).toEqual(true);
});

it('Can set defaultToggled state', () => {
wrapper.setProps({ defaultToggled: true });
expect(
wrapper.find(`.${prefix}--toggle-input`).props().defaultChecked
).toEqual(true);
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import '../../../../components/scss/components/toggle/_toggle.scss';

describe('Toggle RTL', () => {
describe('Behaviors', () => {
it('toggles on click', () => {
render(<Toggle id="test-id" />);
expect(screen.getByText('Off')).toBeVisible();
expect(screen.getByText('On')).not.toBeVisible();
userEvent.click(screen.getByRole('checkbox'));
expect(screen.getByText('On')).toBeVisible();
expect(screen.getByText('Off')).not.toBeVisible();
});

it('Should add extra classes that are passed via className', () => {
wrapper.setProps({ className: 'extra-class' });
expect(wrapper.find('div').hasClass('extra-class')).toEqual(true);
it('toggles on keydown - enter', () => {
render(<Toggle id="test-id" />);
expect(screen.getByText('Off')).toBeVisible();
expect(screen.getByText('On')).not.toBeVisible();
userEvent.type(screen.getByRole('checkbox'), 'enter');
expect(screen.getByText('On')).toBeVisible();
expect(screen.getByText('Off')).not.toBeVisible();
});

it('Can be disabled', () => {
wrapper.setProps({ disabled: true });
expect(wrapper.find(`.${prefix}--toggle-input`).props().disabled).toEqual(
true
);
it('toggles on keydown - space', () => {
render(<Toggle id="test-id" />);
expect(screen.getByText('Off')).toBeVisible();
expect(screen.getByText('On')).not.toBeVisible();
userEvent.type(screen.getByRole('checkbox'), 'space');
expect(screen.getByText('On')).toBeVisible();
expect(screen.getByText('Off')).not.toBeVisible();
});
});

it('Can have a labelA', () => {
wrapper.setProps({ labelA: 'labelA-test' });
expect(wrapper.find(`.${prefix}--toggle__text--off`).text()).toEqual(
'labelA-test'
describe('Props', () => {
it('add custom class name to wrapper div', () => {
const { container } = render(
<Toggle id="test-id" className="custom-class" />
);
expect(container.firstChild).toHaveClass('custom-class');
});

it('Can have a labelB', () => {
wrapper.setProps({ labelB: 'labelB-test' });
expect(wrapper.find(`.${prefix}--toggle__text--on`).text()).toEqual(
'labelB-test'
);
it('sets toggled based on defaultToggled on render', () => {
render(<Toggle id="test-id" defaultToggled={true} />);
expect(screen.getByText('On')).toBeVisible();
});
});

it('toggled prop sets checked prop on input', () => {
const wrapper = mount(<Toggle {...commonProps} id="test" toggled />);

const input = () => wrapper.find('input');
expect(input().props().checked).toEqual(true);

wrapper.setProps({ toggled: false });
expect(input().props().checked).toEqual(false);
});

describe('events', () => {
it('passes along onChange to <input>', () => {
it('calls onChange when the control is changed', () => {
const onChange = jest.fn();
const id = 'test-input';
const wrapper = mount(
<Toggle {...commonProps} id={id} onChange={onChange} />
);

const input = wrapper.find('input');
const inputElement = input.instance();

inputElement.checked = true;
wrapper.find('input').simulate('change');

expect(
onChange.mock.calls.map((call) =>
call.map((arg, i) => (i > 0 ? arg : arg.target))
)
).toEqual([[inputElement]]);
render(<Toggle id="test-id" onChange={onChange} />);
userEvent.click(screen.getByRole('checkbox'));
expect(onChange).toHaveBeenCalled();
});

it('should invoke onToggle with expected arguments', () => {
it('calls onToggle when toggled', () => {
const onToggle = jest.fn();
const id = 'test-input';
const wrapper = mount(
<Toggle {...commonProps} id={id} onToggle={onToggle} />
);

const input = wrapper.find('input');
const inputElement = input.instance();

inputElement.checked = true;
wrapper.find('input').simulate('change');

const call = onToggle.mock.calls[0];

expect(call[0]).toEqual(true);
expect(call[1]).toEqual(id);
expect(call[2].target).toBe(inputElement);
render(<Toggle id="test-id" onToggle={onToggle} />);
userEvent.click(screen.getByRole('checkbox'));
expect(onToggle).toHaveBeenCalled();
});
});

describe('ToggleSmall', () => {
const wrapper = mount(<Toggle {...commonProps} id="toggle-1" size="sm" />);
it('takes in custom labels for toggled and untoggled states', () => {
render(<Toggle id="test-id" labelA="test On" labelB="test Off" />);
expect(screen.getByText('test On')).toBeInTheDocument();
expect(screen.getByText('test Off')).toBeInTheDocument();
});

it('Sets the `ToggleSmall` className', () => {
const input = wrapper.find('input');
expect(input.hasClass(`${prefix}--toggle-input--small`)).toEqual(true);
it('sets toggled based on toggled prop', () => {
const { rerender } = render(<Toggle id="test-id" toggled={false} />);
expect(screen.getByText('Off')).toBeVisible();
rerender(<Toggle id="test-id" toggled={true} />);
expect(screen.getByText('On')).toBeVisible();
});

it('Renders a checkmark SVG', () => {
const svg = wrapper.find(`.${prefix}--toggle__check`);
expect(svg.length).toBe(1);
it('passes extra props to input', () => {
render(<Toggle id="test-id" aria-disabled={true} />);
expect(screen.getByRole('checkbox')).toHaveAttribute(
'aria-disabled',
'true'
);
});
});
});