🙆‍♂️

Node.jsで標準ライブラリだけを使って単体テストを行う方法【動画版あり】

2022/05/12に公開

Node.js

Test

tech

この記事について

この記事ではNode.jsの標準ライブラリのassertだけを使って単体テストを行う方法について紹介します。

おおまかな手順

おおまか手順を下記に示します。

ソースコードの作成準備
ソースコードの作成
テストコードの作成準備
テストコードの作成
動作確認

ソースコードの作成準備

ターミナルで下記のコマンドを実行してコーディングの準備をします。

mkdir nodejs-test-unit
cd nodejs-test-unit
touch MyMath.js

ソースコードの作成

MyMath.js

エディタでMyMath.jsを開いて下記の内容を入力します。

テストコードの作成準備

ターミナルで下記のコマンドを実行してコーディングの準備をします。

touch MyMathTest.js

テストコードの作成

MyMathTest.js

エディタでMyMathTest.jsを開いて下記の内容を入力します。

ポイントを下記に示します。

テスト対象のソースコードをインポートします。
main関数では実行するテストケースを列挙します。
forループを使ってテストケースを順番に実行します。
例外が発生しなかった場合はOKと出力します。
例外が発生した場合はNGに加えてエラーオブジェクトを出力します。
テストケースではまずテスト対象に渡す引数n1、n2、実際の結果actual、期待する結果expectedなどの変数を定義します。
次にassert.strictEqual関数を呼び出します。

動作確認

ターミナルで下記のコマンドを実行してaddTestが成功してalwaysFailTestが失敗することを確認します。

node MyMathTest.js

上記のコマンドの実行結果を下記に示します。

OK addTest
NG alwaysFailTest
AssertionError [ERR_ASSERTION]: alwaysFail
    at alwaysFailTest (/Users/susukida/workspace/tech-blog/articles/nodejs-test-unit/MyMathTest.js:39:10)
    at main (/Users/susukida/workspace/tech-blog/articles/nodejs-test-unit/MyMathTest.js:17:15) {
  generatedMessage: false,
  code: 'ERR_ASSERTION',
  actual: undefined,
  expected: undefined,
  operator: 'fail'
}

おわりに

Node.jsで単体テストといえば Mocha ですが、itでテストケースのやっていることを英語で説明しようとしては自分の英語力の乏しさを痛感するのでなんとなく疎遠になり、この記事で紹介したようなassertを使った自己流のテストコードを書くようになりました。そろそろ自己流をやめて日本語で書くか関数名みたいに書くかしてMochaに移行しようと思います。

単体テストではテスト対象にデータベースにアクセスするなどの外部依存が含まれていると厄介ですが、そのような場合は関数的な部分（入力のみに従って出力が決定する部分）だけを切り出して単体テストを行い、残りはAPIテストやUIテストに任せる方針にしています。理想をいえば単体テストしやすいソースコードを書ければ良いのですが今の私のレベルでは読みやすさやメンテナンスしやすさを犠牲にしてしまうため、背伸びせずに自分の能力に見合うやり方から逸脱しないように気をつけたいと思います。

私はWebアプリの開発で単体テスト／APIテスト／UIテストの3つを基本にしていますが、どれも自己流で体系的にテストを学んだことがないのでおすすめの書籍やWebサイトなどがありましたらご指導のコメントをいただければ幸いです、その他のコメントも大歓迎です。最後までお読みいただきありがとうございました！

GitHubで編集を提案