👩‍👧‍👦 👨🏼‍🎓 🥘 Nodejsアプリケーションのテスト 🛠️ 🦒 👨🏾‍🚒

前回、フレームワークとしてexpressjsを使用し、テンプレートエンジンとしてjadeを使用して、nodejsでアプリケーションを作成することについて書きました。今回は、サーバー側のテストに焦点を当てたいと思います。

テストには、次のものを使用します。
-Mocha-テストを記述し、簡単かつ簡単に実行できるフレームワーク。さまざまなバージョンのレポートを生成し、テストからドキュメントを作成する方法も知っています。
-Should- 「承認」のスタイルのテスト用ライブラリ_{（正しい名前が見つかりませんでした）}
-SuperTest - nodejsで HTTPサーバーをテストするためのライブラリ
-jscoverage-テストでコードカバレッジを評価する

すべてをゼロから作成したわけではありませんが、前の記事のアプリケーションをテストでラップし、app2フォルダーに完全にコピーすることにしました。

まず、必要なモジュールをpackage.jsonファイルに追加します。必要なのは、mocha、should、supertestです。

package.json

{ "name": "app2", "version": "0.0.0", "author": "Evgeny Reznichenko <kusakyky@gmaill.com>", "dependencies": { "express": "3", "jade": "*", "should": "*", "mocha": "*", "supertest": "*" } }

npm iコマンドを実行して、必要なすべてのモジュールをインストールします。
jscoverageをインストールします（Ubuntu sudo apt-get install jscoverageの下 ）。

次に、プロジェクトのルートにlibディレクトリを作成し、そこにapp.jsをコピーします。これは、すべてのスクリプトをカバレッジテストで簡単にカバーするために必要です。
app.jsファイルを編集してサーバーを外部にエクスポートし、プロジェクトのルートにindex.jsファイルを作成します。これにより、サーバーが接続され、ソケットにハングアップします。また、ビューとパブリックディレクトリへのパスを修正することを忘れないでください。
次のようになります。

index.js

 var app = require('./lib/app.js'); app.listen(3000);

lib / app.js

 var express = require('express'), jade = require('jade'), fs = require('fs'), app = express(), viewOptions = { compileDebug: false, self: true }; //data var db = { users: [ { id: 0, name: 'Jo', age: 20, sex: 'm' }, { id: 1, name: 'Bo', age: 19, sex: 'm' }, { id: 2, name: 'Le', age: 18, sex: 'w' }, { id: 10, name: 'NotFound', age: 18, sex: 'w' } ], titles: { '/users': ' ', '/users/profile': ' ' } }; //utils function merge(a, b) { var key; if (a && b) { for (key in b) { a[key] = b[key]; } } return a; } //App settings app.set('views', __dirname + '/../views'); app.set('view engine', 'jade'); app.set('title', ' '); app.locals.compileDebug = viewOptions.compileDebug; app.locals.self = viewOptions.self; app.use(express.static(__dirname + '/../public')); app.use(app.router); app.use(function (req, res, next) { next('not found'); }); //error app.use(function (err, req, res, next) { if (/not found/i.test(err)) { res.locals.title = '  :('; res.render('/errors/notfound'); } else { res.locals.title = ''; res.render('/errors/error'); } }); app.use(express.errorHandler()); //routes //  app.all('*', function replaceRender(req, res, next) { var render = res.render, view = req.path.length > 1 ? req.path.substr(1).split('/'): []; res.render = function(v, o) { var data, title = res.locals.title; res.render = render; res.locals.title = app.get('title') + (title ? ' - ' + title: ''); //         //  if ('string' === typeof v) { if (/^\/.+/.test(v)) { view = v.substr(1).split('/'); } else { view = view.concat(v.split('/')); } data = o; } else { data = v; } // res.locals      //     (res.locals.title) data = merge(data || {}, res.locals); if (req.xhr) { //     json res.json({ data: data, view: view.join('.') }); } else { //   ,    // (   history api) data.state = JSON.stringify({ data: data, view: view.join('.') }); //    .       . view[view.length - 1] = '_' + view[view.length - 1]; //   res.render(view.join('/'), data); } }; next(); }); //   app.all('*', function loadPageTitle(req, res, next) { res.locals.title = db.titles[req.path]; next(); }); app.get('/', function(req, res){ res.render('index'); }); app.get('/users', function(req, res){ var data = { users: db.users }; res.render('index', data); }); app.get('/users/profile', function(req, res, next){ var user = db.users[req.query.id], data = { user: user }; if (user) { res.render(data); } else { next('Not found'); } }); // function loadTemplate(viewpath) { var fpath = app.get('views') + viewpath, str = fs.readFileSync(fpath, 'utf8'); viewOptions.filename = fpath; viewOptions.client = true; return jade.compile(str, viewOptions).toString(); } app.get('/templates', function(req, res) { var str = 'var views = { ' + '"index": (function(){ return ' + loadTemplate('/index.jade') + ' }()),' + '"users.index": (function(){ return ' + loadTemplate('/users/index.jade') + ' }()),' + '"users.profile": (function(){ return ' + loadTemplate('/users/profile.jade') + ' }()),' + '"errors.error": (function(){ return ' + loadTemplate('/errors/error.jade') + ' }()),' + '"errors.notfound": (function(){ return ' + loadTemplate('/errors/notfound.jade') + ' }())' + '};' res.set({ 'Content-type': 'text/javascript' }).send(str); }); module.exports = app;

app.jsファイルを見てみましょう。3つの論理部分に分かれているのは明らかです。
-最初の部分では、データモデルを操作するロジック全体を取り上げます。
-2番目の部分、すべての補助ユーティリティでは、 マージ機能のみがあります。
-3番目はサーバー自体になります

私たちは希望を決めたので、テストの作成を始めましょう。テストを実行するのに便利なMakefileを最初に作成し、プロジェクトのルートに配置します。

メイクファイル

 MOCHA = ./node_modules/.bin/mocha test: @NODE_ENV=test $(MOCHA) \ -r should \ -R spec .PHONY: test

--r-Mochaがshouldライブラリを接続することを示します
--R-テストレポートを表示する形式を示します。レポートにはいくつかのタイプがあり、これは次のようになります。

写真

「ツール」のテスト

デフォルトでは、Mochaはテストディレクトリからテストを実行するため、このようなディレクトリを作成して最初のテストを記述します。
そして、「ツール」を使用してテストを開始し、小さな計画を作成します。
-「ツール」ではマージ関数である必要があります
-マージ機能は、2つのオブジェクトを1つにマージする必要があります
-さらに、最初に送信されたオブジェクトは展開する必要があり、2番目のオブジェクトは
-関数は2番目のオブジェクトを変更してはなりません

MochaのBDDテストは、 describe（）ブロックで始まります。、テスト自体はit（）ブロックに書き込まれます。 describe（）ブロック内に配置する必要があります。 describe（）ブロックを相互にネストすることができます。フックも使用できます：before（）、after（）、beforeEach（）、afterEach（）。フックは、describe（）ブロック内にも記述する必要があります。偽のデータベースを操作するモデルをテストするときのフックについて詳しく説明します。

テストディレクトリで、tools.jsファイルを作成し、tools.mergeのテストを記述します。

test / tools.js

 var tools = require('../lib/tools/index.js'); describe('tools', function () { // ""    merge it('should be have #merge', function () { tools.should.be.have.property('merge'); tools.merge.should.be.a('function'); }); describe('#merge', function () { // merge       it('should merged', function () { var a = { foo: '1' }, b = { bar: '2' }; tools.merge(a, b).should.eql({ foo: '1', bar: '2' }); }); //      ,   it('should be extend', function () { var a = { foo: '1' }, b = { bar: '2' }; tools.merge(a, b); //   ,    //     a.should.not.equal({ foo: '1', bar: '2' }); a.should.equal(a); }); //      it('should not be extended', function () { var a = { foo: '1' }, b = { bar: '2' }; tools.merge(a, b); b.should.not.eql({ foo: '1', bar: '2' }); }); }); });

ここでテストを実行すると、ツールモジュールを接続する段階でエラーに陥りますが、これは正常であり、このモジュールはまだありません。ファイルlib / tools / index.jsを作成し、そこにlib / app.jsからマージ関数コードを転送します。
makeテストを実行し、4つのテストすべてが圧倒されることを確認します。

写真

なぜなら最初のテストが圧倒されると、マージ機能がツールモジュールからエクスポートされないことが明らかになります。エクスポートを追加し、テストを再度実行すると、すべてが正常に動作するようになります。

アプリケーションの残りをさらにテストする前に、カバレッジテストを追加します。
パラメーター--encoding = utf8および--no-highlightを 使用してjscoverageの実行を追加し、着信ディレクトリーとしてlibを、発信ディレクトリーとしてlib- covを指定します。ここで、カバレッジテストのMocha起動を追加し、環境変数COVERAGE = 1を設定し、レポーターとしてhtml-covを指定して、カバレッジテストの結果を含む美しいhtmlページを取得します。

メイクファイル

 MOCHA = ./node_modules/.bin/mocha test: @NODE_ENV=test $(MOCHA) \ -r should \ -R spec test-cov: lib-cov @COVERAGE=1 $(MOCHA) \ -r should \ -R html-cov > coverage.html lib-cov: clear @jscoverage --encoding=utf8 --no-highlight lib lib-cov clear: @rm -rf lib-cov coverage.html .PHONY: test test-cov clear

テストに戻って、一番上の行を置き換えましょう。

 var tools = require('../lib/tools/index.js');

に

 var tools = process.env.COVERAGE ? require('../lib-cov/tools/index.js') : require('../lib/tools/index.js');

それだけですこれでmake test-covを実行できます。 coverage.htmlファイルがプロジェクトルートに表示されます。カバレッジテストの結果、ファイルは自己完結型であり、ブラウザですぐに開くことができます。

写真

エントリが1つもなかった行は赤で表示されます。つまり、この場所はテストの対象外です。各ファイルの割合としてのテスト範囲の一般的な統計も提供されます。

さて、テスト環境は構成されていますが、データベースとサーバーのテストを記述することは残っています。

データベースでの作業のテスト

モデルをテストするためのコードを書きます。まず、機能を決定しましょう。
1）UserとUserListの2つのモデルが必要です
2）ユーザーモデルにはメソッドが必要です。
-find-関数は、UserList型のオブジェクトを持つユーザーのリストを返します（何もない場合でも）
-findById-関数はIDでユーザーを検索し、結果をUser型のオブジェクトとして返すか、このIDを持つユーザーがいない場合は何も返さない
-保存-関数はユーザーを保存する必要があり、エラーの場合はerrを返します
-toJSON-関数は、User型のオブジェクトをjsonにキャストする
3）UserListモデルにはtoJSONメソッドのみが必要です

テストコード

 var should = require('should'), db = process.env.COVERAGE ? require('../lib-cov/models/db.js') : require('../lib/models/db.js'), models = process.env.COVERAGE ? require('../lib-cov/models/index.js') : require('../lib/models/index.js'), User = models.User, UserList = models.UserList; describe('models', function () { //      //   "describe('models')" before(function () { db.regen(); }); //    User it('should be have User', function () { models.should.be.have.property('User'); models.User.should.be.a('function'); }); //    UserList it('should be have UserList', function () { models.should.be.have.property('UserList'); models.UserList.should.be.a('function'); }); //  User describe('User', function () { // User    find it('should be have #find', function () { User.should.be.have.property('find'); User.find.should.be.a('function'); }); // User    findById it('should be have #findById', function () { User.should.be.have.property('findById'); User.findById.should.be.a('function'); }); // User    save it('should be have #save', function () { User.prototype.should.be.have.property('save'); User.prototype.save.should.be.a('function'); }); // User    toJSON it('should be have #toJSON', function () { User.prototype.should.be.have.property('toJSON'); User.prototype.toJSON.should.be.a('function'); }); describe('#find', function () { //find   UserList it('should be instanceof UserList', function (done) { User.find(function (err, list) { if (err) return done(err); list.should.be.an.instanceOf(UserList); done(); }); }); //find   UserList,     it('should not be exist', function (done) { //  db.drop(); User.find(function (err, list) { //  db.generate(); if (err) return done(err); list.should.be.an.instanceOf(UserList); done(); }); }); }); describe('#findById', function () { //findById     User it('should be instanceof User', function (done) { User.findById(0, function (err, user) { if (err) return done(err); user.should.be.an.instanceOf(User); done(); }); }); //findById   ,     it('should not be exists', function (done) { User.findById(100, function (err, user) { if (err) return done(err); should.not.exist(user); done(); }); }); }); describe('#save', function () { //save   ,     it('should not be saved', function (done) { var user = new User({ name: 'New user', age: 0, sex: 'w' }); user.save(function (err) { err.should.eql('Invalid age'); done(); }); }); //  ,       it('should be saved', function (done) { var newuser = new User({ name: 'New user', age: 2, sex: 'w' }); newuser.save(function (err) { if (err) return done(err); User.findById(newuser.id, function (err, user) { if (err) return done(err); user.should.eql(newuser); done(); }); }); }); }); describe('#toJSON', function () { //toJSON   json   it('should be return json', function (done) { User.findById(0, function (err, user) { if (err) return done(err); user.toJSON().should.be.eql({ id: 0, name: 'Jo', age: 20, sex: 'm' }); done(); }); }); }); }); describe('UserList', function () { //UserList    toJSON it('should be have #toJSON', function () { UserList.prototype.should.be.have.property('toJSON'); UserList.prototype.toJSON.should.be.a('function'); }); }); });

コードにはコメントが付いているため、特定のポイントにのみ焦点を当てます。

  before(function () { db.regen(); });

このコードは、テストの開始時に一度呼び出されます。ここでは、データベースに接続してテストデータを入力できます。実際のデータベースはないため、regenメソッドを呼び出すだけで、データベースをテストデータで初期化します。
データベースでの作業は非同期スタイルで実行されるという事実に注意を払う価値があります。非同期メソッドをテストするとき、ブロックテストを完了するためにdone（）メソッドを呼び出す必要があります。エラーの場合、エラーを渡す必要があります。明確にするためのコード：

 ... //find   UserList it('should be instanceof UserList', function (done) { User.find(function (err, list) { if (err) return done(err); list.should.be.an.instanceOf(UserList); done(); }); }); ...

それでは始めましょう。 libディレクトリで、モデルを操作するための機能が実装されるモデルディレクトリを作成します。

モデル/ db.js

 /* *    */ //  var users = []; exports.users = users; //     exports.regen = function () { exports.drop(); exports.generate(); }; exports.drop = function () { //    , //      users.splice(0, users.length); }; exports.generate = function () { //  users.push({ id: 0, name: 'Jo', age: 20, sex: 'm' }); users.push({ id: 1, name: 'Bo', age: 19, sex: 'm' }); users.push({ id: 2, name: 'Le', age: 18, sex: 'w' }); users.push({ id: 10, name: 'NotFound', age: 18, sex: 'w' }); }; //   exports.generate();

モデル/ user.js

 var util = require('util'), db = require('./db.js'), UserList = require('./userlist.js'), users = db.users; /* *   */ var User = module.exports = function User(opt) { this.id = users.length; this.name = opt.name; this.age = opt.age; this.sex = opt.sex; this.isNew = true; } /* *        */ function loadFromObj(obj) { var user = new User(obj); user.id = obj.id; user.isNew = false; return user; } /* *       */ User.find = function (fn) { var i, l = users.length, list; if (l) { list = new UserList(); for (i = 0, l; l > i; i += 1) { list.push(loadFromObj(users[i])); } } fn(null, list); }; /* *    id */ User.findById = function (id, fn) { var obj = users[id], user; if (obj) { user = loadFromObj(obj); } fn(null, user); }; /* *  */ User.prototype.save = function (fn) { var err; //    if (Number.isFinite(this.age) && this.age > 0 && this.age < 150) { if (this.isNew) { users.push(this.toJSON()); this.isNew = false; } else { users[this.id] = this.toJSON(); } } else { err = 'Invalid age'; } fn(err); }; User.prototype.toJSON = function () { var json = { id: this.id, name: this.name, age: this.age, sex: this.sex }; return json; };

モデル/ userlist.js

 var util = require('util'); /* * UserList -  ,   Array */ var UserList = module.exports = function UserList() { Array.apply(this) } util.inherits(UserList, Array); UserList.prototype.toJSON = function () { var i, l = this.length, arr = new Array(l); for (i = 0; l > i; i += 1) { arr[i] = this[i].toJSON(); } return arr; };

モデル/ index.js

 exports.User = require('./user.js'); exports.UserList = require('./userlist.js');

ユーザーモデル接続を追加することでlib / app.jsコードを調整し、それを介してユーザーとのすべての作業を行います。

lib / app.js

 var ... User = require('./models/index.js').User, ... ... app.get('/users', function(req, res, next){ User.find(function (err, users) { if (err) { next(err); } else { res.render('index', { users: users.toJSON() }); } }); }); app.get('/users/profile', function(req, res, next){ var id = req.query.id; User.findById(id, function(err, user) { if (user) { res.render({ user: user.toJSON() }); } else { next('Not found'); } }); }); ...

アプリケーションをテストする

テストでカバーされない最後の部分がありました。これは直接HTTPサーバーです。ここでは、4つの状況のみをフリーズしてテストすることにしました。
1）これが通常のリクエストである場合、答えはhtmlに来る必要があります
2）それがajaxの場合、答えはjsonに来る必要があります
3）サイトのルートへのGETリクエストは、タイトルに値「My site」が含まれるページ/オブジェクトを返す必要があります
スーパーテストライブラリのおかげで、このようなテストの作成は簡単で簡単です。

test / app.js

 var request = require('supertest'), app = process.env.COVERAGE ? require('../lib-cov/app.js') : require('../lib/app.js'); describe('Response html or json', function () { //   ,   //   html it('should be responded as html', function (done) { request(app) .get('/') .expect('Content-Type', /text\/html/) .expect(200, done); }); //  ,   json it('should be responded as json', function (done) { request(app) .get('/') .set('X-Requested-With', 'XMLHttpRequest') .expect('Content-Type', /application\/json/) .expect(200, done); }); }); describe('GET /', function () { //  title ===   it('should be included title', function (done) { request(app) .get('/') .end(function (err, res) { if (err) return done(err); res.text.should.include('<title> </title>'); done(); }); }); //  title ===   it('should be included title', function (done) { request(app) .get('/') .set('X-Requested-With', 'XMLHttpRequest') .end(function (err, res) { if (err) return done(err); res.body.should.have.property('data'); res.body.data.should.have.property('title', ' '); done(); }); }); });

request（）で、http.Serverのインスタンスまたは要求を実行する関数を渡す必要があります。 SuperTestはSuperAgentを使用してサーバーと対話するため、すべての機能を使用してサーバーへのリクエストを作成できます。応答の検証は、 expect（）関数で、またはハンドラー関数をend（）に渡すことで要求の結果として直接実行できます。

おわりに

アプリケーションのテストを書くのはとても簡単です（そして必要ですら）。私のテスト用の小さなサンプルコードでも、テストコード自体よりも多くのことが判明しましたが、これらのテストでさえ不完全であり、たとえば、2人のユーザーを同時に作成して保存した場合、エラーはテストでカバーされません。カバレッジテストは、ユーザーモデルが新しいユーザーが保存された場所のテストでカバーされることを示していますが。
したがって、テスト自体は万能薬ではありません。テストは正しく記述されている必要があり、ささいなことを理解し、問題を引き起こす可能性のある場所を正確にテストする必要があります。

コードはgithubで入手できます

Nodejsアプリケーションのテスト

「ツール」のテスト

データベースでの作業のテスト

アプリケーションをテストする

おわりに

More articles: