JavaScript

【Node.js】テストコードの書き方と実行方法【基本型】

どうも、つよぽんです!

今回は、Node.jsで利用できるテストツールを使って「テストコードの書き方」と「テストコードの実行方法」について解説します。

今回利用するテストツールは、前回記事「【Node.JS】テストツールの種類とインストール方法を覚える」でインストールした以下の2つとなります。

  1. Mocha
  2. Power Assert

今回の記事の内容は以下の解説記事でも使っているスライドの内容をさらに詳しく解説したものとなります。

あわせて読みたい
【Node.JS】テストの書き方・実行方法を覚える【基本型】今回は「mocha」と「power-assert」を使ったテストコードの書き方とテストコードの実行方法を学習します。また、「node_modules/.bin」と「package.jsonのscriptsプロパティ」の説明もしています。...

今回の記事は次のような方に向けて書きました。

想定読者
  1. テストコードの書き方を知りたい
  2. テストコードの実行方法を知りたい

この記事を読み終えた後のあなたは次のことがわかるようになっています。

この記事を読み終えた後のあなた
  • テストコードが書けるようになる
  • テストコードを実行できるようになる

それでは以下の内容で話を進めていきます。

今回の内容
  1. テストコードの書き方【mochaとpower-assertを利用】
  2. テストコードの実行方法

テストコードの書き方【mochaとpower-assertを利用】

テストコードを作る前に、テストファイルの格納先ディレクトリを用意する

テストファイルを作るためには、当然、テストファイルをどこに保存するかを考える必要があります。

Mochaのドキュメント(THE TEST/ DIRECTORY)を読むと、以下のようなことが書かれています。

By default, mocha looks for the glob ./test/*.js, so you may want to put your tests in test/ folder.

つまり、テスト実行時は「test」ディレクトリを探すということなので、package.jsonと同じ階層にtestディレクトリを作成しましょう。

以下の画像は、testディレクトリをpackage.jsonと同じ階層に用意した様子をあらわしたものです。(※画像をクリックすると別のタブで画像が開きます。)

テストファイルを格納するための「testディレクトリ」を用意するテストファイルを格納するための「testディレクトリ」を用意する

testディレクトリの中にテストファイルを作成する

先ほどの画像の赤枠内を観ると「math.spec.js」というファイルがあるのがわかるかと思います。

この「math.spec.js」はテストファイルとなります。

テストファイルを作成するときはtestディレクトリ内に保存するようにします。

また、テストファイルの末尾は「.js」であれば良いですが、ファイル名からだけでもテストファイルであることが理解できるようにするために、慣例的に末尾を「.test.js」もしくは「.spec.js」とすることが多いです。(今回のサンプルファイルでは「.spec.js」の方を採用しました。)

テストコードの基本型を覚える

テストコードの基本型を覚えるには、実際にサンプルコードを見るほうが早いかと思うので、まずは以下の画像内のコードを見ていただけたらと思います。(※画像をクリックすると別のタブで画像が開きます。)

テストコードの基本型テストコードの基本型

サンプルコードと一緒に書いてある説明も一緒に読んでいただけたらと思いますが、基本的には次のような形式でテストコードを記述します。

  1. アサーションライブラリを読み込む
    (今回の場合は「Power Assert」がアサーションライブラリとなる)
  2. テストしたい機能を読み込む
  3. Mocha(テストフレームワーク)が提供している「describeメソッド」を使い、各引数には次の値をセットする
    • 第1引数 : どんな内容のテストかわかるようなタイトルをセットする
    • 第2引数 : コールバック関数をセットする
  4. Mochaが提供している「itメソッド」を使い、各引数には次に値をセットする
    • 第1引数 : describeでセットしたタイトルよりも、もっと具体的なテストタイトルをセットする
    • 第2引数 : コールバック関数をセットする
  5. itの第2引数にセットしたコールバック関数の中で、アサーションライブラリのメソッドを使ってテストコードを書く
    • GitHubの「Power Assert > API」を見ると、どんなアサーションメソッドが提供されているか確認できる
    • アサーションライブラリを使うタイミングは、2つの値を比較したいとき

Mochaのドキュメントの「GETTING STARTED」にもテストコードのサンプルコードが書かれているので、そちらも参考にすると良いでしょう。

テストコードの実行方法

「./node_modules/.bin/mocha」でテストを実行する

結論から言うと、「./node_modules/.bin/mocha」を実行するとテストが実行できるようになっています。(testディレクトリ内にテストファイルがあることが前提)

なぜ「./node_modules/.bin/mocha」が実行できるか?

npm install -D mocha」を実行すると「node_modules」ディレクトリにmochaが追加されます。

このとき、ライブラリの中には「コマンド」を提供しているライブラリもあり、「mocha」はコマンドを提供しているライブラリの1つになります。

コマンドを提供しているライブラリをインストールすると「node_modules/.bin」ディレクトリに、ライブラリが提供しているコマンドが追加されます。

以下の画像の左側の赤枠内を見ると「node_modules/.bin/mocha」があることがわかるかと思います。(※画像をクリックすると別のタブで画像が開きます。)

「node_modules/.bin」ディレクトリ内にある「mochaコマンド」が使えることを確認した様子「node_modules/.bin」ディレクトリ内にある「mochaコマンド」が使えることを確認した様子

実際にコマンドが使えるかどうか確認するために「–version」オプションを付けてmochaコマンドを実行した様子が、上の画像の右側の赤枠内を見ると分かるかと思います。

実行結果として「5.2.0」が表示されていることから、mochaコマンドを実行できていることがわかります。

「npm test」でテストを実行する

先ほどは「./node_modules/.bin/mocha」コマンドを実行すると、テストを実行できることを説明しました。

しかし、毎回「./node_modules/.bin/mocha」と打ち込むのは面倒です。

そこで、「package.json」のscriptsに「”test”: “mocha”」を追加することで、「npm test」でmochaコマンドを実行できるようになります。

以下の画像は、package.jsonのscriptsに「”test”: “mocha”」を追加して、「npm test」を実行したようすをあらわしたものです。(※画像をクリックすると別のタブで画像が開きます。)

package.jsonのscriptsに「test: mocha」を追加すると「npm test」でテストが実行できるようになるpackage.jsonのscriptsに「test: mocha」を追加すると「npm test」でテストが実行できるようになる

上の画像の右下の赤枠で「npm test」を実行しており、実行後はmochaコマンドが実行されて、テストが実行されているのがわかります。

このようにpackage.jsonのscriptsに「”test”: “mocha”」を記述すると、テストの実行が楽になります。

まとめ

今回の話をまとめると次のとおりです。

今回のまとめ
  • テストファイルは「test」ディレクトリの中に保存する
  • 「Mocha」が提供している「describeメソッド」「itメソッド」、「Power Assert」が提供しているアサーションメソッドを使ってテストを記述する
  • 「Mocha」をインストールすると「node_modules/.bin」ディレクトリ内に「mochaコマンド」が追加される
  • package.jsonのscriptsに「”test”: “mocha”」を追加すると「npm test」でmochaコマンドを実行できるようになる
  • mochaコマンドを実行することで、テストファイルに書いたテストコードが実行される

今回の内容は以下の記事内のスライドの補足資料として作成しました。スライドの全部を確認したい方は以下の記事も参照して頂けたらと思います。

あわせて読みたい
【Node.JS】テストの書き方・実行方法を覚える【基本型】今回は「mocha」と「power-assert」を使ったテストコードの書き方とテストコードの実行方法を学習します。また、「node_modules/.bin」と「package.jsonのscriptsプロパティ」の説明もしています。...
【やる気満々な方向け】学習サポートとオンライン講義やってます!

Webエンジニアになりたい人向けに、MENTA にて『【やる気満々な方向け】未経験からのWebエンジニア育成コース』というプランを用意しております。

このプランでは、主に「【学習コンテンツ】Web開発」を使って学習を進めていただきます。

あわせて読みたい
Web開発Webエンジニアになるために必要な知識・スキルを学習できるコンテンツを用意しました。未経験者でも、①開発環境の準備、②Webの基本的な仕組み、③HTML、④CSS、⑤JavaScriptと順を追って学習することでスキルが身につくことを目的に教材を作成しています。...

誰向けのプラン?

こちらのプランは次のような方に向けて作られています。

プラン対象者
  1. Progateやドットインストールで一通り学習したけど、次に何をすればよいかわからない
  2. Webエンジニアになるまでの学習プランがあると助かる
  3. 学習していてわからないところが出てきたときに質問したい
  4. コードレビューして欲しい
  5. オンライン講義に参加したい
  6. 学習した内容をアウトプットした際に、フィードバックがもらえたら嬉しい
  7. おすすめの学習教材を知りたい
  8. Webフロントエンド・バックエンドを学習したい
  9. フルスタックエンジニアになりたい
  10. 文系出身で今までプログラミングをしてこなかったけど、将来Webエンジニアになりたい
  11. 将来フリーランスになることを目指している

プラン内容は?

【やる気満々な方向け】未経験からのWebエンジニア育成コース』では次のことを行っております。

プラン内容
  1. Web白熱教室の学習コンテンツをメインに、指定した教材を使って学習する (学習プランに沿って学習を進めていただきます。)
  2. 学習コンテンツの課題をこなしたあとは、僕にコードレビュー依頼を投げていただくことで、コードを添削する(課題クリア後は、引き続き学習プランの内容を続けていただきます。)
  3. プラン契約者が参加するSlackグループにて質問し放題
  4. Slack内にある「アウトプットの場」チャンネルにて、学習したことをアウトプットをしていただくことで、それに対しフィードバックをする (学習内容のアウトプットは復習にもなるため、アウトプットすることを強く推奨します。)
  5. 画面共有を使ったオンライン講義 (オンライン講義は録画して、いつでもふり返れるようにしています。(オンライン講義動画(ウェビナー動画)))
  6. 学習プラン以外の内容に対しての質疑応答 (内容によっては回答できないものもありますが、まずは気軽に質問していただけたらと思います。)
  7. 不定期で行うオフラインでの勉強会に参加(僕自身が東京住みのため、東京・もしくは東京近郊で開催します)

1日1回カフェでコーヒー1杯頼むくらいの金額で参加できます

1日1回、カフェでコーヒー1杯分くらいの値段(約330円)」で以下の環境が手に入るとイメージして頂けたらと思います。

  1. コードを添削してもらえる
  2. 学習したことのアウトプットに対してフィードバックしてもらえる
  3. いつでも質問出来る
  4. 週1のオンライン講義に参加できる
  5. 過去のオンライン講義動画を好きな時間に復習できる(いつでも閲覧可能)
  6. 不定期で行うオフラインでの勉強会に参加できる(僕自身が東京住みのため、東京・もしくは東京近郊で開催します)
  7. 自分の住まいの近場のメンティーさん同士で集まって、オフラインで勉強会を開くのも可能(初めて開催する場合は事前に僕に連絡をいただけたらと思います)

学習教材には、このサイトで用意している「【学習コンテンツ】Web開発」を使います。

【学習コンテンツ】Web開発」を使って学習を進めることで、Webのフロントエンドとバックエンドのスキルを身につけていくことができます。

プログラミングスクールとの比較

プログラミングスクールに通う場合は1ヶ月で10万円以上するところも多いですし、3ヶ月で50万円、更には100万円するところもあります。

プログラミングスクールの値段が高い理由は、「プログラミングスクールで働いている人の人件費」「就職のサポート」なども含まれているからです。

10万円50万円100万円」のいずれの場合も、自己投資とはいえ、支払うのにはだいぶ勇気がいる金額かと思います。

オススメの学習方法

個人的にオススメするのは、プログラミングのできるメンター(師匠)を見つけて、まずは1ヶ月プログラミング学習をしてみて、自分にプログラミングが向いているかどうか確かめてみることです。

10万円50万円100万円」を払って、学習していく中で「やっぱり自分にはプログラミングは向いてない」と判断した場合、その金額はかなりの痛手となります。

そのため、まずは「これくらいの金額なら最悪失っても痛くないな」の値段で教えてくれるメンターを見つけて、そのメンターに色々と質問をしてみましょう。

それで、「良さそうだな」と思ったら教えてもらうといった流れで学習を始めると、金額もだいぶ節約できます。

注意点

ただし、参加者が増えてきたら、1人1人へのサポートの質を維持するのが難しくなるので、値上げする可能性もあります。

値上げする理由は次の以下の理由となります。

  • 値段を上げて参加ハードルをあげることで、自己解決スキルも身につけたいと考えている学習意欲の高い人だけが参加するようになる
    • 調べたらすぐにわかることを、自分で調べずに何でもかんでも質問すると、自己解決スキルも身につかない
    • 更に、他のメンティーさんの対応する時間が取れなくなりサポートの質の低下にも繋がる

詳しく話を聞いてみたい方は

以下のいずれかでメッセージをいただけたらと思います^^

 

プラン内容については以下のリンク先からも確認することが出来ます^^

【やる気満々な方向け】未経験からのWebエンジニア育成コース

COMMENT

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です