WEB

【Jest超基礎】導入篇

WEB
この記事は約3分で読めます。

はじめに

この記事は実務1ヶ月弱の新人エンジニアがアウトプットを目的として書いている記事になります。
携わらせていただいている案件で
「Jestを使うぞ!」と言われたので、
「Jestってなんぞや?」となり、学習を始めました!!
間違っている箇所等ございましたらご指摘ください。

Jestってなに?

Jest はシンプルさを重視した、快適な JavaScript テスティングフレームワークです。
(Jestドキュメント引用)
つまり、テストコードを簡単にJavaScriptで書けるってことですね!

Babel, TypeScript, Node, React, Angular, Vue等、様々なフレームワークにも使用できます。

↓テストコードについてはこちら
【初心者向け】テストコードの方針を考える(何をテストすべきか?どんなテストを書くべきか?)

導入

早速始めていきましょう!
まずはテストを取り入れたいご自分のプロジェクト配下で以下を実行します。
yarnの場合

yarn add --dev jest

npmの場合

npm install --save-dev jest

続いてsum,jsファイルを作成します。

sum.js

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

次にsum.test.jsを作成します。

sum.test.js

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

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

そして、package.jsonを確認します。

package.json

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

このようになっていたらOKです!
私はこの部分が少し違っていてエラーが起こっていたので、ちゃんと確認しないといけませんね。。。

ここまでできたらあとは実行するだけ!!

yarnの場合

yarn test

npmの場合

npm test

結果

PASS  ./sum.test.js
   ✓ adds 1 + 2 to equal 3 (2 ms)
 Test Suites: 1 passed, 1 total
 Tests:       1 passed, 1 total
 Snapshots:   0 total
 Time:        1.332 s, estimated 2 s
 Ran all test suites.

こんな感じに表示されていたら成功です!

参考文献

Jestドキュメント
ドキュメント導入部分