23.3

Edit

Getting Started

Установите Jest с помощью yarn:

yarn add --dev jest

Или npm:

npm install --save-dev jest

Для начала напишем тест для функции, которая складывает два числа. Во-первых создайте файл sum.js:

function sum(a, b) {
  return a + b;
}
module.exports = sum;

Затем создайте файл с именем sum.test.js. Он будет содержать сам тест:

const sum = require('./sum');

test('adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3);
});

Добавьте следующий раздел в package.json:

{
  "scripts": {
    "test": "jest"
  }
}

Наконец, запустите yarn test и Jest напечатает данное сообщение:

PASS  ./sum.test.js
✓ adds 1 + 2 to equal 3 (5ms)

Вы только что успешно написали первый тест с использованием Jest!

Данный тест использует expect и toBe для проверки идентичности двух данных значений. Чтобы узнать об остальных вещах, которые можно протестировать с использованием Jest, смотрите использование вычислителей.

Запуск из командной строки

You can run Jest directly from the CLI (if it's globally available in your PATH, e.g. by yarn global add jest) with a variety of useful options.

Вот так можно запустить Jest для проверки файлов совпадающих с my-test, используя config.json в качестве файла конфигурации и для отображения нативного уведомления ОС после завершения:

jest my-test --notify --config=config.json

If you'd like to learn more about running jest through the command line, take a look at the Jest CLI Options page.

Дополнительная конфигурация

Generate a basic configuration file

Based on your project, Jest will ask you a few questions and will create a basic configuration file with a short description for each option:

jest --init

С использованием Babel

Для использования Babel, установите пакеты babel-jest и regenerator-runtime:

yarn add --dev babel-jest babel-core regenerator-runtime

Note: If you are using a babel version 7 then you need to install babel-jest with the following command:

yarn add --dev babel-jest 'babel-core@^7.0.0-0' @babel/core regenerator-runtime


*Примечание: явная установка `regenerator-runtime` не требуется если вы используете `npm` версии 3 или 4 либо Yarn*

Не забудьте добавить файл [`.babelrc`](https://babeljs.io/docs/usage/babelrc/) в корневую папку вашего проекта. For example, if you are using ES6 and [React.js](https://facebook.github.io/react/) with the [`babel-preset-env`](https://babeljs.io/docs/plugins/preset-env/) and [`babel-preset-react`](https://babeljs.io/docs/plugins/preset-react/) presets:

```json
{
  "presets": ["env", "react"]
}

Теперь вы можете использовать все возможности ES6 и React синтаксис.

Note: If you are using a more complicated Babel configuration, using Babel's env option, keep in mind that Jest will automatically define NODE_ENV as test. Jest не будет использовать значение development как Babel делает по умолчанию, когда явно не задан параметр NODE_ENV.

Note: If you've turned off transpilation of ES6 modules with the option { "modules": false }, you have to make sure to turn this on in your test environment.

{
  "presets": [["env", {"modules": false}], "react"],
  "env": {
    "test": {
      "presets": [["env"], "react"]
    }
  }
}

Примечание: babel-jest автоматически устанавливается при установке Jest и преобразует файлы если в вашем проекте есть существующая конфигурация babel. Для обхода данного поведения, вы можете явно сбросить опцию transform в конфигурации:

// package.json
{
  "jest": {
    "transform": {}
  }
}

С использованием Webpack

Jest может использоваться в проектах, использующих webpack для управления активами, стилями и компиляцией. webpack действительно вносит некоторые уникальные сложности в сравнении с другими инструментами. Обратитесь к разделу руководство по работе с Webpack для начала работы.

С использованием TypeScript

To use TypeScript in your tests you can use ts-jest.

Using Matchers →