In most real-world applications using webpack, you’re likely using a few loaders. In this lesson we’ll see how to make Jest load our modules properly with a moduleNameMapper so we can test our code that makes use of these loaders.

Configure Jest for Testing JavaScript Applications

Support Importing CSS files with Jest’s moduleNameMapper

Instructor: [00:01] Let's go ahead and get this `AutoScalingTextComponent` tested. It's the default export here so I'm going to add an auto-scaling-text.js inside of the `___test___` folder and I'll just paste in a test right inside auto-scaling-text.js. We're using testing library React, so let's go ahead and install as a dev dependency testing library React.

```bash
npm install --save-dev @testing-library/react
```

[00:20] With that installed, we can now run `npm t` to run our test and we're getting that test picked up, but we've got a bit of a problem. Jest is again explaining to us that this module had a syntax error. We're not sure what's going on with it. You probably need to make sure that you're compiling this properly.

[00:38] In our case, it's actually not a compilation issue, it's actually mocking that JS module. That's this suggestion that it's giving us with the moduleNameMapper.

[00:47] Let's see what's going on here. We're getting a syntax error unexpected token that and it's pointing at this import of the styles from auto-scaling-text-module.css. An actual code right here is the auto scaling text.

[00:59] If we take a look at the file, it's from auto-scaling-text-module.css. It's this file right there. That's the auto scaling text. What's going on here, Jest is trying to require this file like it's a common JS module. Clearly, this is not a common JS module. This is a CSS file and that's why we're running into this syntax error.

[01:17] What we're going to do here is use the moduleNameMapper suggestion so that we can map modules that end in .css to a different module. A mock version of the module, so it can be stubbed out and we can require this file in our test.

[01:31] Let's go ahead and open up our jest.config.js file and we'll add a `moduleNameMapper{}` object. We'll say anything that ends in .css and this is a Redux pattern here, we want to require resolve. We want that module to resolve to a different module instead.

[01:50] The module that we're going to have it resolve to a new module we're going to make in test-style-mock.js. This will just say `module.exports =  {}` and then we'll resolve to test-style-mock.js. 

```js
module.exports = {
  testEnvironment: 'jest-environment-jsdom',
  moduleNameMapper: {
    '\\.css$': require.resolve('./test/style-mock.js'),
  },
}
```

With that, we can now run `npm t` and our test passes with flying colors.

[02:10] If we take a look at our auto-scaling-text-module.js and we ```console.log(styles)``` and then we run our test again, we're going to see that console log is just that empty object. It actually is exactly that module.

[02:24] When Jest comes across a file that matches this instead of requiring the file that matches `\\.css$`, it's going to require the `styles-mock.js`. You can see that if I say, "Hello World" right here and then I run `npm t` again, when I'm going to get logged is hello world.

```js
module.exports = {hello: 'world'}
```

[02:43] This is fine for us because it's pretty uncommon to test CSS anyway. If you wanted to do that testing, then visual regression testing will probably be a better fit for that.

[02:52] On review what we had to do here, was we created a test right next to the file that we're testing called autoscaling text. All that we're doing in here, is checking that it renders just for demonstration purposes.

[03:04] Then in here, we're importing some CSS. Things didn't work because Jest was trying to require that file. We told Jest that when it comes across the file that ends in .css, instead of requiring that file, it should require this marked version of that file, which is just a match of export's empty object.

[03:22] On this end, the reason that this works in our application is because this is being bundled with webpack. We have webpack configured to handle CSS files with the CSS-loader and the style-loader. Webpack is managing this for our application and we simply needed to make Jest manage the same thing for our test.


Jest is a fully featured testing framework with a developer experience that is second to none. It’s remarkably simple and flexible at the same time. For simple use cases, you often don’t need to configure anything, install and enjoy the built-in coverage and watch mode support.

In a real-world application though, you’ll often have needs specific to your application, especially when testing browser-based applications. You'll need to handle Webpack loaders, dynamic imports, and custom module resolution which Node.js does not support.

In this course we’ll go over ways you can optimize your Jest configuration to make testing real-world JavaScript applications a delight. We’ll cover what’s already been mentioned in addition to Babel support, code coverage, how to make watch mode even more helpful, and how to run test suites with entirely different configurations.

Intro to Configure Jest for Testing JavaScript Applications

We start in a small, but real-world application that’s built with webpack and React. We’ll go over installing the Jest testing framework locally to our project, adding an npm script to make it easy to run, and adding an example test file.

Install and Run Jest

Jest automatically loads and applies our babel configuration. However, because our project takes advantage of tree shaking with webpack, our babel configuration disables compiling modules. For Jest to work on our code, we need to make sure that our babel configuration compiles modules during our tests. We’ll use the NODE_ENV environment variable to generate the proper configuration.

Compile Modules with Babel in Jest Tests

In our application we’re testing code that should run in the browser, but Jest is intended to test JavaScript that runs in the browser or in node. Let’s create a custom jest config file so we can customize the test environment.

Configure Jest’s Test Environment for Testing Node or Browser Code

If you’re using CSS modules with webpack, then we can improve our moduleNameMapper to improve our experience and capabilities testing our components by including the css module property name in our tests using identity-obj-proxy.

Support using Webpack CSS Modules with Jest

Snapshot testing is a way to simplify writing and maintaining assertions. As noted in [the Jest documentation](http://jestjs.io/docs/en/snapshot-testing.html#snapshot-testing-with-jest): “The snapshot artifact should be committed alongside code changes, and reviewed as part of your code review process. Jest uses pretty-format to make snapshots human-readable during code review. On subsequent test runs Jest will simply compare the rendered output with the previous snapshot. If they match, the test will pass. If they don't match, either the test runner found a bug in your code that should be fixed, or the implementation has changed and the snapshot needs to be updated.” Let’s see how these work and in what situations we can and should use them.

This lesson uses a simple demo before hopping into the application code testing DOM nodes. This example code isn't available.

Generate a Serializable Value with Jest Snapshots

Part of the power of snapshots is the ability to provide custom serializers. Let’s check out how to use jest-emotion to include our emotion CSS styles in our React component snapshots so we can be made aware of the impact of our CSS changes on our components.

UPDATE: `jest-emotion` has been renamed to `@emotion/jest` and you add the serializer with `'@emotion/jest/serializer'` instead of simply `'jest-emotion'`.

Test an Emotion Styled UI with Custom Jest Snapshot Serializers

Webpack’s resolve.modules configuration is a great way to make common application utilities easily accessible throughout your application. We can emulate this same behavior in Jest using the moduleDirectories configuration option.

Support Custom Module Resolution with Jest moduleDirectories

Often you’ll have some setup that you want to run before your tests start. Let’s see how we can use the setupFilesAfterEnv configuration in Jest to take care of test boilerplate and establish a good testing environment for our tests.

Configure Jest to Run Setup for All Tests with Jest setupFilesAfterEnv

Every large testbase has common utilities that make testing easier to accomplish. Whether that be a custom render function or a way to generate random data. Let’s see how we can make accessing these custom utilities throughout the tests easier using Jest’s moduleDirectories feature.

Support a Test Utilities File with Jest moduleDirectories

As the codebase grows it makes our test runs take longer and longer. Naturally people will run the tests less frequently to avoid waiting. With Jest’s powerful and interactive watch mode we can easily run the tests that we want to focus on without having to run all the tests in the codebase.

Use Jest Watch Mode to Speed Up Development

Sometimes it can be a real challenge to determine what’s going on when testing your code. It can be really helpful to step through your code in a debugger. In this lesson we’ll see how to use Jest’s --runInBand flag with node’s --inspect-brk to debug our tests in Chrome’s debugger.

Step through Code in Jest using the Node.js Debugger and Chrome DevTools

Jest comes with code coverage reporting built-into the framework, let’s see how quick and easy it is to add code coverage reporting to our project and take a look at the generated report. 

Configure Jest to Report Code Coverage on Project Files

You may have an idea of what Code Coverage is, but let’s take a quick look at how it’s recorded so we can understand how to analyze code coverage reports.

Analyze Jest Code Coverage Reports

Wherever you are at with code coverage you generally don’t want that level to go down. Let’s add coverage thresholds globally as well as in specific files to ensure we never drop below a certain level of coverage.

Set a Code Coverage Threshold in Jest to Maintain Code Coverage Levels

The coverage report generated by Jest is fantastic, but it’d be great to track that coverage over time and be able to review that coverage at a glance, maybe even put it up on a display in the office! Codecov.io is a fantastic service that can consume our code coverage report and it integrates great with GitHub. Let’s see how we can extend our existing Travis build configuration to send the coverage report to Codecov.io.

Report Jest Test Coverage to Codecov through TravisCI

In CI, we don’t want to start the tests in watch mode, but locally we normally want to run the tests in watch mode. We can have separate scripts, but it’d be great to not have to remember which script to run locally. Let’s use is-ci-cli to run the right script in the right environment when running the test script.

Run Jest Watch Mode by Default Locally with is-ci-cli

Sometimes you may have situations where configuration needs to be different for certain tests. In this lesson we’ll take a look at how we could create a custom configuration for tests that are intended to run in a node environment.

Run Tests with a Different Configuration using Jest’s --config Flag and testMatch Option

Sometimes you may find it useful to have more than one configuration in a project (for example, running some tests in a node environment and others in the jsdom environment). In this lesson we’ll learn about Jest’s projects feature to have jest run both of these configurations at once.

Support Running Multiple Configurations with Jest’s Projects Feature

Jest is more than a testing framework. It’s a highly optimized, blazing fast platform with incredible parallelization for running tasks across many files in our project. It has a capability to run more than just tests. We can bring these features to our linting as well. Let’s see how we can bring our favorite Jest features (like watch mode) to ESLint with jest-runner-eslint.

Run ESLint with Jest using jest-runner-eslint

It’s great that we can run multiple projects in our watch mode and that we can scope the tests down to specific tests, but sometimes it’s nice to be able to quickly switch between projects in watch mode. Let’s see how this works with jest-watch-select-projects.

Test Specific Projects in Jest Watch Mode with jest-watch-select-projects

Jest’s watch mode is [pluggable](http://jestjs.io/docs/en/watch-plugins.html) and jest-watch-typeahead is one plugin that you definitely don’t want to live without. It enhances the watch mode experience to help you know which tests will be run based on your filter. Making it even easier to run only the tests you’re concerned with running as you develop your codebase.

Filter which Tests are Run with Typeahead Support in Jest Watch Mode

Running the project tests on commit is a great way to avoid breaking the application accidentally and leverage the mechanism for confidence you have from your testbase. However, as the testbase grows this can take a very long time and slow productivity down. Let’s see how Jest is capable of running only the tests and linting only the files that are affected by the files we’re committing with husky and lint-staged to speed up our local test runs as well as help us avoid accidentally committing code that breaks our application.

Support Importing CSS files with Jest’s moduleNameMapper

Transcript

Support Importing CSS files with Jest’s moduleNameMapper