When you use a React Portal, much of your component can be rendered outside the main DOM tree. Let’s see how we can use utilities provided by React Testing Library to allow us to select elements within the portal. To perform actions and assert on what’s rendered.

Test React Components with Jest and React Testing Library

Test React Portals with within from React Testing Library

Instructor: [00:01] In `modal.js` we have a simple modal component that creates an element, appends that to the document and removes it when it's unmounted and it's using reactDOM.createPortal to render the children into that element. 

#### modal.js
```js
import React from 'react'
import ReactDOM from 'react-dom'

let modalRoot = document.getElementById('modal-root')
if (!modalRoot) {
  modalRoot = document.createElement('div')
  modalRoot.setAttribute('id', 'modal-root')
  document.body.appendChild(modalRoot)
}

// don't use this for your modals.
// you need to think about accessibility and styling.
// Look into: https://ui.reach.tech/dialog
function Modal({children}) {
  const el = React.useRef(document.createElement('div'))
  React.useLayoutEffect(() => {
    const currentEl = el.current
    modalRoot.appendChild(currentEl)
    return () => modalRoot.removeChild(currentEl)
  }, [])
  return ReactDOM.createPortal(children, el.current)
}

export {Modal}
```

Let's see how we test something like this.

[00:14] We're going to `import React from 'react'` and we're going to `import {render} from '@testing-library/react'` and then we'll `import` the `Modal` from that `modal` module. 

#### portals.js
```js
import React from 'react'
import {render} from '@testing-library/react'
import {Modal} from '../modal'
```

We're going to add a `test` for modal shows the children and then we want to `render` that `Modal`.

[00:31] We'll render a `div` in here with a `data-testid` of `test`. What we need to get from here is a `getByTestId` so we can access that test. Then we'll just simply expect getByTestId test to be in the document. 

```js
test('modal shows the children', () => {
  const {getByTextId} = render(
    <Modal>
      <div data-testid="test" />
    </Modal>,
  )
  expect(getByTestId('test')).toBeInTheDocument()
})
```

Save that and our test is passing.

[00:51] What's interesting about this is this div is not appearing inside of the container that render creates for us. You might think we have to do something special to get access to the div that's being rendered in a totally different DOM node, but actually the `getByTextId` and all of the queries that are returned here by default are going to be bound to document.body.

[01:12] With the way that our portal is implemented, we're automatically creating this model route elements and appending that to the body over in `modal.js`. Your model contents actually do need to be appended to the body one way or another.

[01:23] By having all of the queries bound to the body, you don't actually have to do anything special to get the DOM nodes that are rendered in this model. Let me show you one other thing here. We're going to a `debug` here in the `const`. We'll call a `debug`. 

```js
test('modal shows the children', () => {
  const {getByTextId, debug} = render(
    <Modal>
      <div data-testid="test" />
    </Modal>,
  )
  debug()
  expect(getByTestId('test')).toBeInTheDocument()
})
```

We'll save that. Here's what it looks like.

[01:37] This is the container that React touching library is creating for us to render stuff into that container, but our model doesn't actually render anything in that container. Instead, it simply returns a React portal which is going to render our children to the element that we create in our layout effect.

![debug printed in the terminal](https://res.cloudinary.com/dg3gyk0gu/image/upload/v1574730718/transcript-images/scikit-learn-test-react-portals-with-within-from-react-testing-library-debug-printed-in-terminal.jpg)

[01:53] Those children are going to get appended to the div that's inside that model root node. If you wanted to limit these queries to just the contents of your model, then one way that you could do that is by using a React testing libraries `within` utility.

[02:07] We'll say, `within`. Then we want everything to be within this model route which we can see right here in our output. We'll just say, `document.getElementById`, `'model-route'`. 

```js
test('modal shows the children', () => {
  const {getByTextId, debug} = render(
    <Modal>
      <div data-testid="test" />
    </Modal>,
  )
  within(document.getElementById('modal-root'))
  expect(getByTestId('test')).toBeInTheDocument()
})
```

This is going to return all the same queries that we get from render except they'll be bound to this element rather than the body.

[02:27] We can say, `getByTestId` Then we can just get rid of all of this stuff from `render`. 

```js
test('modal shows the children', () => {
  render(
    <Modal>
      <div data-testid="test" />
    </Modal>,
  )
  const {getByTestId} = within(document.getElementById('modal-root'))
  expect(getByTestId('test')).toBeInTheDocument()
})
```

Our test should continue to pass except if there's anything rendered outside of that model, then we won't be able to access it. For example, let's just render a fragment here.

[02:40] We'll render the `modal` there, and we'll render a `div` with the `data-testid` of `foo`. 

```js
test('modal shows the children', () => {
  render(
    <>
      <div data-testid="foo" />
      <Modal>
        <div dta-testid="test" />
      </Modal>
    </>
  )
  const {getByTestId} = within(document.getElementById('modal-root'))
  getByTestId('foo')
  expect(getByTestId('test')).toBeInTheDocument()
})
```

Now, if I say get by test ID foo, we're going to get an error here because foo does not appear within our scoped element. If we wanted to get access to that, then we'd have our `bodyUtils`.

[02:59] We'll just give it that name. That's no convention or anything. 

```js
test('modal shows the children', () => {
  const bodyUtils = render(
    <>
      <div data-testid="foo" />
      <Modal>
        <div dta-testid="test" />
      </Modal>
    </>
  )
  const {getByTestId} = within(document.getElementById('modal-root'))
  bodyUtils.getByTestId('foo')
  expect(getByTestId('test')).toBeInTheDocument()
})
```

Then that will work just fine, or we could get rid of this. We could do another `within` that is `document.body`, `getByTestId('foo')`.

```js
test('modal shows the children', () => {
  render(
    <>
      <div data-testid="foo" />
      <Modal>
        <div dta-testid="test" />
      </Modal>
    </>
  )
  const {getByTestId} = within(document.getElementById('modal-root'))
  within(document.body).getByTestId('foo')
  expect(getByTestId('test')).toBeInTheDocument()
})
```

[03:11] That works fine, or you can take this even further and import `queries` from React testing library and say `queries.getByTestId`. This one is going to accept the container as the first argument. You can say `document.body`. 

```js
import {render, within, queries} from '@testing-library/react'


test('modal shows the children', () => {
  render(
    <>
      <div data-testid="foo" />
      <Modal>
        <div dta-testid="test" />
      </Modal>
    </>
  )
  const {getByTestId} = within(document.getElementById('modal-root'))
  queries.getByTestId(document.body, 'foo')
  expect(getByTestId('test')).toBeInTheDocument()
})
```

That works just as well. You have a couple of options here.

[03:27] I recommend that you typically just stick with what render's going to give you. If you want a scope things down, then you can scope it down using within. I'll tell you about one other option, and that is your `baseElement` option that you can specify below our fragment. Here, we can say our `baseElement` is that modal root.

[03:45] Then, we can do `{getByTestId} = render`. We'll get rid of this `within` at the bottom. 

```js
test('modal shows the children', () => {
  const {getByTextId} = render(
    <>
      <div data-testid="foo" />
      <Modal>
        <div dta-testid="test" />
      </Modal>
    </>
    {baseElement: document.getElementById('modal-root')}
  )
  queries.getByTestId(document.body, 'foo')
  expect(getByTestId('test')).toBeInTheDocument()
})
```

Save that, and that will work just as well. The `baseElement` is basically saying, "Hey React testing library, the queries that you give me back from render, I want those to be bound to this element rather than the body."

[04:01] There are a couple ways to do this, but if I were writing this test and it just so happens that I am, then this is probably what I would wind up with. I'd just leave render as it is. Then, I'd say, "Hey, I want to get some specific queries that are within the modal root."

If you want to ship your applications with confidence - and of course you do - you need an excellent suite of automated tests to make absolutely sure that when changes reach your users, nothing gets broken. To get this confidence, your tests need to realistically mimic how users actually use your React components. Otherwise, tests could pass when the application is broken in the real world.

In this course, we’ll write a series of render methods and run a range of tests to see how we can get the confidence we’re looking for, without giving up maintainability or test run-speed.

What's changed in Test React Components with Jest and React Testing Library

Intro to Test React Components with Jest and React Testing Library

Let’s start basic by using ReactDOM to render a simple React component to a <div> we create ourselves and assert that it’s rendering the right thing based on the props we provide.

Render a React Component for Testing

The Jest DOM library provides really useful extensions to jest’s built-in assertion library that will make it easier for us to write our test assertions (like toHaveTextContent). Let’s see how to use that in our project.

Use Jest DOM for Improved Assertions

Our tests are currently tightly coupled to the implementation of our component’s element structure. A refactor to that structure wont break our application, but will definitely break our tests because we’re testing implementation details. Let’s use DOM Testing Library to create a custom render function that will give us some helpful utilities for searching for elements in the DOM in the same way a user would.

Use DOM Testing Library to Write More Maintainable React Tests

Let’s create a simple render method to be able to reuse this functionality for our other tests. The render method we’ve created is similar to [the render method](https://testing-library.com/docs/react-testing-library/api#render) that’s provided by React Testing Library. Let’s swap our implementation to that!

Use React Testing Library to Render and Test React Components

While you’re writing your tests it can be helpful to see what the DOM looks like. You can do this with React Testing Library’s debug function which will log a formatted and syntax highlighted state of the DOM at the time it is called.

Debug the DOM State During Tests using React Testing Library’s debug Function

The fireEvent utility in React Testing Library supports all the events that you regularly use in the web (change, click, etc.). Let’s see how we can test our change event handler with an input.

Test React Component Event Handlers with fireEvent from React Testing Library

The User Event module is part of the Testing Library family of tools and lets you fire events on DOM nodes that more closely resemble the way your users will interact with your elements. Let’s refactor our fire event usages to use that instead.

Improve Test Confidence with the User Event Module

Sometimes it can be useful to change the props of a component you’ve rendered and make assertions about what’s rendered after that prop change has taken place. Let’s see how to go about doing this with React Testing Library.

Test Prop Updates with React Testing Library

It’s pretty straightforward to assert that a certain element is rendered with react-testing-library, but what if we want to ensure that something is NOT being rendered. For example, if we re-render our component with a different maximum amount leading to the error message being hidden. Let’s see how we can use the query* APIs from react-testing-library to assert that certain elements are not rendered.

Assert That Something is NOT Rendered with React Testing Library

While not all of accessibility testing of a web application can be automated, much of it can be and quite easily using [axe-core](https://github.com/dequelabs/axe-core) and [jest-axe](https://github.com/nickcolley/jest-axe). Let’s see how to integrate this with React Testing Library to help catch common accessibility issues.

Test Accessibility of Rendered React Components with jest-axe

If you have a component that makes HTTP requests, you’ll probably want to mock those out for UI unit and integration tests. Let’s see how to use jest’s built-in mocking capabilities to do that.

Mock HTTP Requests with jest.mock in React Component Tests

Mocking an API module works, but it's incomplete because we have to make all these assertions that we're calling it properly and then we'd need to write some other tests for the API module itself to make sure that it responds properly to those calls. 

In this lesson, I'll show you how you can use a package called [MSW](https://mswjs.io/) to intercept and handle those HTTP requests instead so we can get a great deal more confidence.

[Get the code on GitHub](https://github.com/kentcdodds/react-testing-library-course/blob/46d2608caaa404476c9224cd136aea270a739e6d/src/__tests__/http-msw-mock.js)

Mock HTTP Requests with MSW

There are some situations where you want to focus your tests on a particular component and not any of its children. There are other situations where you want to mock out the behavior of components that your component renders. In the case of react-transition-group, we don’t want to have to wait until the transition has completed before we can go on with our tests. Let’s see how we can mock the implementation of react-transition-group using jest.mock to make our tests more reliable and easier to write and maintain.

Mock react-transition-group in React Component Tests with jest.mock

If the user experiences an error while using your application you may want to send information to a monitoring tool to ensure you can be made aware of the error and deal with it as quickly as possible. Let’s see about testing a component that is responsible for this componentDidCatch error boundary using React Testing Library.

Test componentDidCatch Handler Error Boundaries with React Testing Library

When testing an error boundary, your console will be filled with console.error calls from React. Those can be a real distraction from the rest of the output for your tests. Let’s clean those up with jest.spyOn.

Hide console.error Logs when Testing Error Boundaries with jest.spyOn

Our error boundary has some other use cases that it supports and we should try to make sure our tests cover all those use cases, so let’s add a test to make sure the recovery feature of our error boundary works properly.

Ensure Error Boundaries Can Successfully Recover from Errors

We have a bit of repetition in our rerender calls here and it would be nice if we could avoid that. Let’s use the wrapper option for React Testing Library so we can avoid the repetition in our rerender calls.

Use React Testing Library’s Wrapper Option to Simplify using rerender

Normally using Test Driven Development (TDD) with UI is really difficult because testing utilities for UI often tie your tests closely to the implementation. Because React Testing Library is not this way, we can actually use it to TDD our UI. Let’s build the structure of a form using TDD with React Testing Library.

Test Drive the Development of a React Form with React Testing Library

Now that we have our react form structure written using TDD, let’s take it a step further and TDD our form’s submission with an onSubmit handler as well.

Test Drive the Submission of a React Form with React Testing Library

Once the data has been saved on the server, we’ll want to redirect the user to the home screen with react-router’s <Redirect /> component. Let’s go ahead and mock that component as well and verify that it’s being rendered with the correct props. We’ll have to make our test asynchronous so we can make that assertion because the <Redirect /> component is rendered after the async call happens.

Test Drive Mocking react-router’s Redirect Component on a Form Submission

It’s great that our form can be submitted, but we need to get that data to our server to actually save the post to the database. We don’t want to actually make requests to the server during these unit tests, so we’ll mock out the function responsible for doing that and assert that it’s being called with the right data. Then we’ll go ahead and implement that functionality in our form component.

Test Drive the API Call of a React Form with React Testing Library

Our post should probably have a creation date associated with it (typically you’ll add this on the server, but for the purposes of our example, we’ll do it on the client). Dates are notoriously challenging to test. There are existing libraries that help, but often you can get close enough to the desired effect for your assertions. Let’s go ahead and test that a correct creation date has been set for our posts.

Test Drive Assertions with Dates in React

A really important aspect of TDD is the refactor phase. A critical piece to making your tests easier to maintain is using code structure and values to communicate what is important and what is not. We’ll use data generation with [test-data-bot](https://github.com/jackfranklin/test-data-bot) to communicate that the specific data values are irrelevant and it’s just what kind of data it is. Let’s refactor our tests to communicate this effectively.

Use Generated Data in Tests with tests-data-bot to Improve Test Maintainability

We have the happy path covered for our post editor component, but what happens if there’s an error in saving the user’s information? We should probably show them an error message and give them the chance to try again. Let’s add a new test for this error case and implement some error handling.

Test Drive Error State with React Testing Library

We’ve finished with our post editor component, but let’s not forget the refactor phase! We have a bunch of duplicate logic between our two tests. When you have multiple tests with duplicate logic, it becomes hard for folks who come to maintain the tests later to identify what the differences between the tests are. This makes it harder to understand what the different features of the component are. So let’s refactor the tests slightly so we can communicate clearly what the important and unique parts of the tests are to make it easier for future maintainers.

Write a Custom Render Function to Share Code between Tests and Simplify Tests

Mocking the <Redirect /> component in react-router works, but it’s imperfect because we don’t know for sure that the user will be redirected properly. Alternatively, we can render our component within a Router with a custom implementation of a history via createMemoryHistory. Then we can make assertions on that history object.

Test React Components that Use the react-router Router Provider with createMemoryHistory

If the user enters a bad URL or there’s some kind of routing error, we should show the user a helpful error page. Let’s see how we can test that our page is wired up with the router properly to do this.

Initialize the `history` Object with a Bad Entry to Test the react-router no-match Route

Many of our components need (or will eventually need) the router context from the router provider. Let’s write a custom render method that looks and acts like the render method from React Testing Library but adds features for our router so we don’t have to concern ourselves about the implementation detail of the router.

Create a Custom render Function to Simplify Tests of react-router Components

Similar to react-router, we can render our component under test with the redux provider, our full redux store, and then we can interact with our component in the same way the user would and be confident that our component, action creators, and reducers are all working properly.

Test a Redux Connected React Component

There are definitely some scenarios where you want to test what a component will do given certain state in the store. Let’s see how we can initialize our redux provider with a store that has some custom initialized data. One thing that I should note here is that while it can be useful to do this, make sure you at least have one test that verifies that you can  into this state in the first place.

Test a Redux Connected React Component with Initialized State

It’s very common for our components to use state from the redux store (or to be refactored to use it eventually). Having to change our tests every time we do this would be frustrating. Let’s see how we can write a render method we could use to not worry about that implementation detail when it’s irrelevant for our tests. This could be combined with the custom render method for the router to be a single render method that supports all providers our components need.

Create a Custom Render Function to Simplify Tests of Redux Components

We’ve got a custom useCounter hook here and we want to make sure the increment and decrement functions it returns will update the count state that it returns. Because hooks must be run within the render phase of a component, we’ll create a simple component that simply uses the hook and render that component. One catch is that whenever there’s a state update in your tests, React needs you to wrap that in a call to act. We don’t have to do that for regular component tests that use React Testing Library utilities because those utilities manage the act call internally, but since we’re calling these state updater functions ourselves, we have to wrap things in act. Let’s do that for our useCounter hook.

Test a Custom React Hook with React’s Act Utility and a Test Component

Once we add tests for all the use cases of our hook, we’ll notice a bunch of common setup, so let’s put that in a setup function.

Write a Setup Function to Reduce Duplication of Testing Custom React Hooks

That setup function is pretty handy. Seems like a good opportunity for an abstraction. Well, we already have one! It’s called React Hooks Testing Library. Let’s swap our setup function for the renderHook function from @testing-library/react-hooks.

Test a Custom React Hook with renderHook from React Hooks Testing Library

Just like React Testing Library, React Hooks Testing Library has a rerender function which can be useful for testing changes to props. Let’s test what happens if the step option changes for our hook.

Test Updates to Your Custom React Hook with rerender from React Hooks Testing Library

Sometimes your react component may need to do some cleanup work in the return value from useEffect or useLayoutEffect, or the componentWillUnmount lifecycle method for class components. Luckily for us, as far as React Testing Library is concerned, whichever of those you use is an implementation detail, so your test looks exactly the same regardless of how you implement it. Check out how you can test that simply with React Testing Library and a <Countdown /> component.

Test Unmounting a React Component with React Testing Library

You can get a huge amount of confidence and coverage from integration tests that test an entire page, or even your entire app. Let’s write a test that renders our whole app using React Testing Library and navigate around it like a normal user would. These tests are typically a bit longer, but they provide a huge amount of value.

Write React Application Integration Tests with React Testing Library

By using some of the get* queries, we’re assuming that those elements will be available on the page right when we execute the query. This is a bit of an implementation detail and it’d be cool if we could not make that assumption in our test. Let’s swap all those for find* queries.

Improve Reliability of Integration Tests using find* Queries from React Testing Library

Let’s take things a step closer to the way our app is used by using the User Event module for interacting with our app. Once we’ve done all this implementation detail-free testing, we’ll find out that we can drastically change the implementation of our app and our tests can give us confidence that our changes were successful. That’s fantastic!

Test React Portals with within from React Testing Library

Transcript

Test React Portals with within from React Testing Library