📒

Jest に入門する

2022/12/09に公開

JestはJavaScript向けのテストフレームワークです。

https://jestjs.io/ja/

Jestを使用すると、JavaScriptのコードを単体テストや結合テストなど、さまざまな方法でテストすることができます。Jestは標準で、断片的なテストやMock(モック)を行うためのAPIを提供しています。

Jestは、JavaScriptの他にもReactやAngularなどのフロントエンドフレームワーク向けのテストをサポートしています。また、JestはFacebookがメンテナンスしており、比較的新しいフレームワークでありながら広く採用されています。

インストール

npm install --save-dev jest

または

yarn add --dev jest

package.json に以下を追加します。

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

実行

yarn test または npm test でテストを実行します。

Jestは、特定の名前やパターンにマッチするテストファイルを自動的に検出して実行します。
デフォルトでは、__tests__ フォルダ内のファイルや、 *.test.js*.spec.jsファイルがテスト対象として検出されます。

サンプルコード

次の例では、add関数を定義し、その関数を使用したテストを実行しています。テストはtest関数を使用して定義し、expect関数とマッチャー(この例ではtoBe)を使用して、実行結果を検証します。

// add.js
function add(a, b) {
  return a + b;
}

module.exports = add;

// add.test.js
const add = require('./add');

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

Discussion