2023.12.18

開発技術

Jestでユニットテストをしてみよう

その他

この記事を書いたチーム：frontier

Jestについて
Jestのインストール
テストの作成
テストの実行
おわりに

Jestについて

【エンジニア募集中】フルリモート可◎、売上/従業員数9年連続UP、平均残業8時間、有給取得率90％、年休124日以上 etc.　　詳細はこちらから＞

JestはFacebookによって開発されたJavaScriptのテストフレームワークです。今回は紹介しませんが、外部APIへのリクエストをモックしてテストを実行したり、コードのテスト状況を視覚的に確認できるカバレッジレポートを生成する機能などがあります。

今回は簡単にJestについてユニットテストを例に紹介したいと思います。

Jestのインストール

はじめにnpmでpackage.jsonを生成します。

npm init

npm init

続いて、次のコマンドでJestをインストールします。

npm install --save-dev jest

1	npm install --save-dev jest

続いて、package.jsonに以下を追加します。

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

{

"scripts": {

"test": "jest"

}

テストの作成

テストコードを作成します。今回は、「math.js」というファイルを作成します。

作成後、テスト対象の関数を追加します。

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

function subtract(a, b) { 
  return a - b; 
} 

function multiply(a, b) { 
  return a * b; 
} 

function divide(a, b) { 
  if (b === 0) { 
    throw new Error("0で割ることはできません"); 
  } 
  return a / b; 
} 

module.exports = { add, subtract, multiply, divide };

function add(a, b) {

return a + b;

}

function subtract(a, b) {

return a - b;

}

function multiply(a, b) {

return a * b;

}

function divide(a, b) {

if (b === 0) {

throw new Error("0で割ることはできません");

}

return a / b;

}

module.exports = { add, subtract, multiply, divide };

続いて、テスト実行ファイルを作成します。今回は、「math.test.js」というファイルを作成します。

以下のテストケースの内容を追加します。

const { add, subtract, multiply, divide }= require('./math'); 

test('1と2を足すと3になる', () => { 
  expect(add(1, 2)).toBe(3); 
}); 

test('5から2を引くと3になる', () => { 
  expect(subtract(5, 2)).toBe(3); 
}); 

test('2と3を掛けると6になる', () => { 
  expect(multiply(2, 3)).toBe(6); 
}); 

test('6を2で割ると3になる', () => { 
  expect(divide(6, 2)).toBe(3); 
}); 

test('0で割ろうとするとエラーが発生する', () => { 
  expect(() => divide(6, 0)).toThrow("0で割ることはできません"); 
});

const { add, subtract, multiply, divide }= require('./math');

test('1と2を足すと3になる', () => {

expect(add(1, 2)).toBe(3);

});

test('5から2を引くと3になる', () => {

expect(subtract(5, 2)).toBe(3);

});

test('2と3を掛けると6になる', () => {

expect(multiply(2, 3)).toBe(6);

});

test('6を2で割ると3になる', () => {

expect(divide(6, 2)).toBe(3);

});

test('0で割ろうとするとエラーが発生する', () => {

expect(() => divide(6, 0)).toThrow("0で割ることはできません");

});

ここまでのファイル構成は以下のようになります。

. 
├─ math.js 
├─ math.test.js 
├─ package-lock.json 
└─ package.json

├─ math.js

├─ math.test.js

├─ package-lock.json

└─ package.json

テストの実行

次のコマンドでJestを実行し、テストが正常に通るか確認します。

npm test

npm test

上記を実行した結果、以下のように表示されます。

> jest 

 PASS  ./math.test.js 
  √ 1と2を足すと3になる (2 ms) 
  √ 5から2を引くと3になる 
  √ 2と3を掛けると6になる (1 ms)                                                                                                                                                                           
  √ 6を2で割ると3になる                                                                                                                                                                                    
  √ 0で割ろうとするとエラーが発生する (11 ms)                                                                                                                                                                                                                                                                                                                                                         

Test Suites: 1 passed, 1 total                                                                                                                                                                             
Tests:       5 passed, 5 total                                                                                                                                                                             
Snapshots:   0 total 
Time:        4.538 s 
Ran all test suites.