A Complete Guide to React Test Renderer: What You Need to Know

React Test Renderer is a package provided by the React team that allows you to render React components to pure JavaScript objects without depending on the DOM or a native mobile environment. This is particularly useful for snapshot testing. The output of this renderer is a tree of React elements, which can be manipulated and traversed for testing purposes.

‍

Why Use React Test Renderer?

React Test Renderer is a powerful tool for testing React components. It allows you to write tests that assert on the output of your components in a way that's decoupled from the DOM. This makes your tests more reliable and easier to maintain.

‍

Installing React Test Renderer

To use React Test Renderer, you need to install it as a devDependency in your project. You can do this using npm or yarn:

1     npm install --save-dev react-test-renderer
2     

or

1     yarn add --dev react-test-renderer
2     

‍

Rendering with React Test Renderer

React Test Renderer provides two main methods for rendering components: create() and render(). The create() method is used to render React components to pure JavaScript objects. The render() method, on the other hand, is used to render React components to the DOM.

Here's an example of how you can use the create() method to render a component:

1     import React from 'react';
2    import TestRenderer from 'react-test-renderer';
3    import MyComponent from './MyComponent';
4    
5    const testRenderer = TestRenderer.create(<MyComponent />);
6    const testInstance = testRenderer.root;
7    
8    console.log(testInstance.findByType(MyComponent).props);
9     

In this example, we're importing the TestRenderer from the react-test-renderer package and using it to render MyComponent. We then access the root of the rendered tree using the root property and log the props of MyComponent.

‍

Snapshot Testing with React Test Renderer

One of the most powerful features of React Test Renderer is its integration with Jest's snapshot testing feature. Snapshot testing allows you to automatically save a copy of the rendered output of your components and compare it to the output in future tests. This helps catch unintended changes in your components.

Here's an example of how you can use React Test Renderer with Jest's snapshot testing feature:

1     import React from 'react';
2    import TestRenderer from 'react-test-renderer';
3    import MyComponent from './MyComponent';
4    
5    it('renders correctly', () => {
6      const tree = TestRenderer.create(<MyComponent />).toJSON();
7      expect(tree).toMatchSnapshot();
8    });
9     

In this example, we're creating a snapshot test for MyComponent. We render MyComponent using TestRenderer.create(), convert the output to JSON using the toJSON() method, and then use Jest's toMatchSnapshot() matcher to compare the output to the saved snapshot.

‍

Diving Deeper into React Test Renderer

Understanding the TestRenderer Instance

The TestRenderer instance returned by TestRenderer.create() provides several methods and properties that you can use to interact with the rendered tree. The most commonly used ones are:

• root: This property gives you access to the root of the rendered tree. You can use it to traverse the tree and find specific nodes.
• update(element): This method is used to re-render the component with new props.
• unmount(): This method unmounts the component from the tree.

Here's an example of how you can use these methods and properties:

1     import React from 'react';
2    import TestRenderer from 'react-test-renderer';
3    import MyComponent from './MyComponent';
4    
5    const testRenderer = TestRenderer.create(<MyComponent />);
6    const testInstance = testRenderer.root;
7    
8    console.log(testInstance.findByType(MyComponent).props); // Logs the props of MyComponent
9    
10    testRenderer.update(<MyComponent newProp={true} />); // Re-renders MyComponent with new props
11    
12    testRenderer.unmount(); // Unmounts MyComponent
13     

‍

Understanding the TestInstance Instance

The TestInstance instance returned by testRenderer.root and other traversal methods provides several methods and properties that you can use to interact with a specific node in the tree. The most commonly used ones are:

• props: This property gives you access to the props of the node.
• type: This property gives you the type of the node (e.g., the component function/class, the tag name of the DOM node, etc.).
• parent: This property gives you access to the parent of the node.
• children: This property gives you access to the children of the node.

Here's an example of how you can use these methods and properties:

1     import React from 'react';
2    import TestRenderer from 'react-test-renderer';
3    import MyComponent from './MyComponent';
4    
5    const testRenderer = TestRenderer.create(<MyComponent />);
6    const testInstance = testRenderer.root;
7    
8    console.log(testInstance.props); // Logs the props of the root node
9    console.log(testInstance.type); // Logs the type of the root node
10    console.log(testInstance.parent); // Logs the parent of the root node
11    console.log(testInstance.children); // Logs the children of the root node
12     

‍

Traversing the Rendered Tree

React Test Renderer provides several methods for traversing the rendered tree. These methods can be used to find specific nodes in the tree, making it easier to assert on the output of your components. The most commonly used traversal methods are:

• findByType(type): This method returns the first instance of the node with the specified type.
• findAllByType(type): This method returns all instances of the node with the specified type.
• findByProps(props): This method returns the first instance of the node with the specified props.
• findAllByProps(props): This method returns all instances of the node with the specified props.

Here's an example of how you can use these traversal methods:

1     import React from 'react';
2    import TestRenderer from 'react-test-renderer';
3    import MyComponent from './MyComponent';
4    
5    const testRenderer = TestRenderer.create(<MyComponent />);
6    const testInstance = testRenderer.root;
7    
8    console.log(testInstance.findByType(MyComponent)); // Logs the first instance of MyComponent
9    console.log(testInstance.findAllByType(MyComponent)); // Logs all instances of MyComponent
10    console.log(testInstance.findByProps({ myProp: true })); // Logs the first instance with myProp set to true
11    console.log(testInstance.findAllByProps({ myProp: true })); // Logs all instances with myProp set to true
12     

‍

Advanced Use Cases of React Test Renderer

Testing Component Lifecycle Methods

React Test Renderer allows you to test the lifecycle methods of your components. By using the update() method of the TestRenderer instance, you can trigger an update lifecycle and assert on the side effects of your componentDidUpdate() method.

Here's an example:

1     import React from 'react';
2    import TestRenderer from 'react-test-renderer';
3    import MyComponent from './MyComponent';
4    
5    const testRenderer = TestRenderer.create(<MyComponent />);
6    const testInstance = testRenderer.root;
7    
8    // Trigger an update lifecycle
9    testRenderer.update(<MyComponent newProp={true} />);
10    
11    // Assert on the side effects of componentDidUpdate()
12    expect(testInstance.findByType(MyComponent).props.newProp).toBe(true);
13     

‍

Testing React Hooks

React Test Renderer also supports testing components that use React Hooks. You can test the effects of your hooks by triggering an update lifecycle and asserting on the new state of your component.

Here's an example:

1     import React, { useState } from 'react';
2    import TestRenderer from 'react-test-renderer';
3    
4    function MyComponent() {
5      const [count, setCount] = useState(0);
6    
7      return (
8        <button onClick={() => setCount(count + 1)}>
9          Count: {count}
10        </button>
11      );
12    }
13    
14    const testRenderer = TestRenderer.create(<MyComponent />);
15    const testInstance = testRenderer.root;
16    
17    // Trigger an update lifecycle
18    testInstance.findByType('button').props.onClick();
19    
20    // Assert on the new state of the component
21    expect(testInstance.findByType('button').children[1]).toBe('1');
22     

‍

Testing Event Handlers

React Test Renderer allows you to test the event handlers of your components. You can simulate events by calling the event handlers directly and asserting on the side effects.

Here's an example:

1     import React from 'react';
2    import TestRenderer from 'react-test-renderer';
3    
4    function MyComponent() {
5      return (
6        <button onClick={() => console.log('Button clicked!')}>
7          Click me
8        </button>
9      );
10    }
11    
12    const testRenderer = TestRenderer.create(<MyComponent />);
13    const testInstance = testRenderer.root;
14    
15    // Simulate a click event
16    testInstance.findByType('button').props.onClick();
17    
18    // Assert on the side effects of the click event
19    // This will depend on your implementation
20     

‍

The Bottom Line!

React Test Renderer is a powerful tool for testing React components. It provides a simple and intuitive API for rendering components to pure JavaScript objects, allowing you to write tests that are decoupled from the DOM. This makes your tests more reliable and easier to maintain. By understanding and using the advanced features of React Test Renderer, you can write more robust and comprehensive tests for your React components.

Short on time? Speed things up with DhiWise!!

Tired of manually designing screens, coding on weekends, and technical debt? Let DhiWise handle it for you!

You can build an e-commerce store, healthcare app, portfolio, blogging website, social media or admin panel right away. Use our library of 40+ pre-built free templates to create your first application using DhiWise.