@remote-ui/testing

This library provides a unit testing framework for code that uses @remote-ui/core. Its API is heavily inspired by the Shopify’s React testing library.

Installation

Using yarn:

yarn add @remote-ui/testing --dev

or, using npm:

npm install @remote-ui/testing --save-dev

Usage

This library exports a mount function. The first argument to this function is a function, in which you can perform any number of operations on a @remote-ui/core RemoteRoot object:

1import {mount} from '@remote-ui/testing';
2
3const tree = mount((root) => {
4  const button = root.createComponent('Button');
5  button.append('Submit');
6  root.append(button);
7});

This function is called with a "noop" RemoteRoot object by default, but you may provide your own RemoteRoot object instead by passing it as the second argument:

1import {createRemoteRoot} from '@remote-ui/core';
2import {mount} from '@remote-ui/testing';
3
4const myRoot = createRemoteRoot(() => {
5  /* handle updates */
6});
7
8const tree = mount((root) => {
9  const button = root.createComponent('Button', {
10    onPress: () => 'Paid!',
11  });
12  button.append('Submit');
13  root.append(button);
14}, myRoot);

The value returned from this function reflects the state of the remote-ui root after the operations have been performed. This object exposes a rich API for traversing the resulting tree: it includes all the same operations as a @shopify/react-testing RemoteRoot, with the exception of any DOM-related properties (which don’t make sense, since there’s no DOM anywhere in sight!).

1const tree = mount(() => {
2  /* ... */
3});
4
5const buttonProps = tree.find('Button').props;
6const buttonText = tree.find('Button').text;
7const allByText = tree.findAllWhere((element) => /submit/.test(element.text));
8const descendantButtons = tree.children.findAll('Button');

This object also has a few important methods for simulating changes in the tree, and updating the "snapshot" of that tree in order to make assertions. Most notable, calling the trigger() method calls the prop with that name, updates the tree, and returns the result of the call.

1const tree = mount(() => {
2  /* ... */
3});
4
5console.log(tree.find('Button').trigger('onPress'));

For more details on the available methods, refer to the @shopify/react-testing documentation.

Matchers

In addition to mount(), this library provides Jest custom matchers. To include them in your environment, import the @remote-ui/testing/matchers entrypoint in any file included in Jest’s setupFilesAfterEnv option.

Once imported, you’ll be able to call the following matchers from any test:

.toContainRemoteComponent(type: RemoteComponentType, props?: object)

Asserts that at least one component matching type is in the descendants of the passed node. If the second argument is passed, this expectation will further filter the matches by components whose props are equal to the passed object (Jest’s asymmetric matchers, like expect.objectContaining, are fully supported).

1function render(root) {
2  const button = root.createComponent('Button', {
3    onPress: () => {},
4  });
5
6  button.append('Submit');
7  root.append(button);
8}
9
10const myComponent = mount(render);
11expect(myComponent).toContainRemoteComponent('Button', {
12  onPress: expect.any(Function),
13});

.toContainRemoteComponentTimes(type: RemoteComponentType, times: number, props?: object)

Asserts that a component matching type is in the descendants of the passed node a number of times. If the third argument is passed, this expectation will further filter the matches by components whose props are equal to the passed object (again, asymmetric matchers are fully supported). To assert that one component is or is not the descendant of the passed node use .toContainRemoteComponent or .not.toContainRemoteComponent.

.toHaveRemoteProps(props: object)

Checks whether the node has the specified props.

1function render(root) {
2  const button = root.createComponent('Button', {
3    primary: true,
4  });
5
6  button.append('Submit');
7  root.append(button);
8}
9
10const myComponent = mount(render);
11expect(myComponent.find('Button')).toHaveRemoteProps({primary: true});

.toContainRemoteText(text: string)

Asserts that the rendered output of the component contains the passed string as text content (that is, the text is included in what you would get by calling textContent on all root DOM nodes rendered by the component).

1function render(root) {
2  const button = root.createComponent('Button', {
3    onPress: () => {
4      text.update('Goodbye!');
5    },
6  });
7
8  const text = root.createText('Hello!');
9  button.append(text);
10  root.append(button);
11}
12
13const myComponent = mount(render);
14myComponent.find('Button').trigger('onPress');
15
16expect(myComponent.find('Button')).toContainRemoteText('Goodbye!');