mirror of
https://github.com/callstack/react-native-testing-library.git
synced 2026-09-18 23:09:04 +08:00
fead652013
* feat: add getAllByTestId and queryAllByTestId queries * Add test for getAllByTestId and queryAllByTestId - Filter out intermediate components in getAllByTestId. testIDs may be passed down to child components and appearing multiple times in the render tree. Some React Native components render multiple anyways. <Text> is an example. * Update TypeScript typings * Fix flow types * Update TS typings test
209 lines
7.0 KiB
TypeScript
209 lines
7.0 KiB
TypeScript
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
import * as React from 'react';
|
|
import { ReactTestInstance } from 'react-test-renderer';
|
|
import {
|
|
render,
|
|
fireEvent,
|
|
shallow,
|
|
flushMicrotasksQueue,
|
|
debug,
|
|
waitForElement,
|
|
act,
|
|
} from '../..';
|
|
|
|
interface HasRequiredProp {
|
|
requiredProp: string;
|
|
}
|
|
|
|
const View = props => props.children;
|
|
const Text = props => props.children;
|
|
const TextInput = props => props.children;
|
|
const ElementWithRequiredProps = (props: HasRequiredProp) => (
|
|
<Text>{props.requiredProp}</Text>
|
|
);
|
|
|
|
const TestComponent = () => (
|
|
<View>
|
|
<Text>Test component</Text>
|
|
<TextInput placeholder="my placeholder" />
|
|
</View>
|
|
);
|
|
|
|
const tree = render(<TestComponent />);
|
|
|
|
// getByAPI tests
|
|
const getByNameString: ReactTestInstance = tree.getByName('View');
|
|
const getByNameContructor: ReactTestInstance = tree.getByName(View);
|
|
const getByType: ReactTestInstance = tree.getByType(View);
|
|
const getByTypeWithRequiredProps: ReactTestInstance = tree.getByType(
|
|
ElementWithRequiredProps
|
|
);
|
|
const getByTextString: ReactTestInstance = tree.getByText('<View />');
|
|
const getByTextRegExp: ReactTestInstance = tree.getByText(/View/g);
|
|
const getByPlaceholderString: ReactTestInstance = tree.getByPlaceholder(
|
|
'my placeholder'
|
|
);
|
|
const getByPlaceholderRegExp: ReactTestInstance = tree.getByPlaceholder(
|
|
/placeholder/g
|
|
);
|
|
const getByDisplayValueString: ReactTestInstance = tree.getByDisplayValue(
|
|
'my value'
|
|
);
|
|
const getByDisplayValueRegExp: ReactTestInstance = tree.getByDisplayValue(
|
|
/value/g
|
|
);
|
|
const getByProps: ReactTestInstance = tree.getByProps({ value: 2 });
|
|
const getByTestId: ReactTestInstance = tree.getByTestId('test-id');
|
|
const getAllByTestId: ReactTestInstance[] = tree.getAllByTestId('test-id');
|
|
const getAllByNameString: Array<ReactTestInstance> = tree.getAllByName('View');
|
|
const getAllByNameConstructor: Array<ReactTestInstance> = tree.getAllByName(
|
|
View
|
|
);
|
|
const getAllByType: Array<ReactTestInstance> = tree.getAllByType(View);
|
|
const getAllByTypeWithRequiredProps: Array<
|
|
ReactTestInstance
|
|
> = tree.getAllByType(ElementWithRequiredProps);
|
|
const getAllByTextString: Array<ReactTestInstance> = tree.getAllByText(
|
|
'<View />'
|
|
);
|
|
const getAllByTextRegExp: Array<ReactTestInstance> = tree.getAllByText(/Text/g);
|
|
const getAllByProps: Array<ReactTestInstance> = tree.getAllByProps({
|
|
value: 2,
|
|
});
|
|
|
|
// queuryByAPI tests
|
|
const queryByNameString: ReactTestInstance | null = tree.queryByName('View');
|
|
const queryByNameConstructor: ReactTestInstance | null = tree.queryByName(View);
|
|
const queryByType: ReactTestInstance | null = tree.queryByType(View);
|
|
const queryByTypeWithRequiredProps: ReactTestInstance | null = tree.queryByType(
|
|
ElementWithRequiredProps
|
|
);
|
|
const queryByTextString: ReactTestInstance | null = tree.queryByText('View');
|
|
const queryByTextRegExp: ReactTestInstance | null = tree.queryByText(/View/g);
|
|
const queryByPlaceholderString: ReactTestInstance | null = tree.queryByPlaceholder(
|
|
'my placeholder'
|
|
);
|
|
const queryByPlaceholderRegExp: ReactTestInstance | null = tree.queryByPlaceholder(
|
|
/placeholder/g
|
|
);
|
|
const queryByDisplayValueString: ReactTestInstance | null = tree.queryByDisplayValue(
|
|
'my value'
|
|
);
|
|
const queryByDisplayValueRegExp: ReactTestInstance | null = tree.queryByDisplayValue(
|
|
/value/g
|
|
);
|
|
const queryByProps: ReactTestInstance | null = tree.queryByProps({ value: 2 });
|
|
const queryByTestId: ReactTestInstance | null = tree.queryByTestId('test-id');
|
|
const queryAllByTestId: ReactTestInstance[] | null = tree.queryAllByTestId(
|
|
'test-id'
|
|
);
|
|
const queryAllByNameString: Array<ReactTestInstance> = tree.queryAllByName(
|
|
'View'
|
|
);
|
|
const queryAllByNameConstructor: Array<ReactTestInstance> = tree.queryAllByName(
|
|
View
|
|
);
|
|
const queryAllByType: Array<ReactTestInstance> = tree.queryAllByType(View);
|
|
const queryAllByTypeWithRequiredProps: Array<
|
|
ReactTestInstance
|
|
> = tree.queryAllByType(ElementWithRequiredProps);
|
|
const queryAllByTextString: Array<ReactTestInstance> = tree.queryAllByText(
|
|
'View'
|
|
);
|
|
const queryAllByTextRegExp: Array<ReactTestInstance> = tree.queryAllByText(
|
|
/View/g
|
|
);
|
|
const queryAllByDisplayValueString: Array<
|
|
ReactTestInstance
|
|
> = tree.queryAllByDisplayValue('View');
|
|
const queryAllByDisplayValueRegExp: Array<
|
|
ReactTestInstance
|
|
> = tree.queryAllByDisplayValue(/View/g);
|
|
|
|
// Accessibility queries
|
|
const getByA11yLabel: ReactTestInstance = tree.getByA11yLabel('label');
|
|
const getAllByA11yLabel: Array<ReactTestInstance> = tree.getAllByA11yLabel(
|
|
'label'
|
|
);
|
|
const queryByA11yLabel: ReactTestInstance = tree.queryByA11yLabel('label');
|
|
const queryAllByA11yLabel: Array<ReactTestInstance> = tree.queryAllByA11yLabel(
|
|
'label'
|
|
);
|
|
const getByA11yHint: ReactTestInstance = tree.getByA11yHint('label');
|
|
const getAllByA11yHint: Array<ReactTestInstance> = tree.getAllByA11yHint(
|
|
'label'
|
|
);
|
|
const queryByA11yHint: ReactTestInstance = tree.queryByA11yHint('label');
|
|
const queryAllByA11yHint: Array<ReactTestInstance> = tree.queryAllByA11yHint(
|
|
'label'
|
|
);
|
|
const getByA11yRole: ReactTestInstance = tree.getByA11yRole('label');
|
|
const getAllByA11yRole: Array<ReactTestInstance> = tree.getAllByA11yRole(
|
|
'label'
|
|
);
|
|
const queryByA11yRole: ReactTestInstance = tree.queryByA11yRole('label');
|
|
const queryAllByA11yRole: Array<ReactTestInstance> = tree.queryAllByA11yRole(
|
|
'label'
|
|
);
|
|
const getByA11yStates: ReactTestInstance = tree.getByA11yStates('label');
|
|
const getByA11yStatesArray: ReactTestInstance = tree.getByA11yStates(['label']);
|
|
const getAllByA11yStates: Array<ReactTestInstance> = tree.getAllByA11yStates(
|
|
'label'
|
|
);
|
|
const getAllByA11yStatesArray: Array<
|
|
ReactTestInstance
|
|
> = tree.getAllByA11yStates(['label']);
|
|
const queryByA11yStates: ReactTestInstance = tree.queryByA11yStates('label');
|
|
const queryByA11yStatesArray: ReactTestInstance = tree.queryByA11yStates([
|
|
'label',
|
|
]);
|
|
const queryAllByA11yStates: Array<
|
|
ReactTestInstance
|
|
> = tree.queryAllByA11yStates('label');
|
|
const queryAllByA11yStatesArray: Array<
|
|
ReactTestInstance
|
|
> = tree.queryAllByA11yStates(['label']);
|
|
|
|
const debugFn = tree.debug();
|
|
const debugFnWithMessage = tree.debug('my message');
|
|
|
|
tree.update(<View />);
|
|
tree.rerender(<View />);
|
|
tree.unmount();
|
|
|
|
// fireEvent API tests
|
|
fireEvent(getByNameString, 'press');
|
|
fireEvent(getByNameString, 'press', 'data');
|
|
fireEvent.press(getByNameString);
|
|
fireEvent.changeText(getByNameString, 'string');
|
|
fireEvent.scroll(getByNameString, 'eventData');
|
|
|
|
// shallow API
|
|
const shallowTree: { output: React.ReactElement<any> } = shallow(
|
|
<TestComponent />
|
|
);
|
|
|
|
const waitForFlush: Promise<any> = flushMicrotasksQueue();
|
|
|
|
// debug API
|
|
debug(<TestComponent />);
|
|
debug(<TestComponent />, 'message');
|
|
debug(getByNameString);
|
|
debug(getByNameString, 'message');
|
|
debug.shallow(<TestComponent />);
|
|
debug.shallow(<TestComponent />, 'message');
|
|
debug.deep(<TestComponent />);
|
|
debug.deep(<TestComponent />, 'message');
|
|
debug.deep(tree.toJSON());
|
|
|
|
const waitBy: Promise<ReactTestInstance> = waitForElement<ReactTestInstance>(
|
|
() => tree.getByName('View')
|
|
);
|
|
const waitByAll: Promise<Array<ReactTestInstance>> = waitForElement<
|
|
Array<ReactTestInstance>
|
|
>(() => tree.getAllByName('View'), 1000, 50);
|
|
|
|
act(() => {
|
|
render(<TestComponent />);
|
|
});
|