Merge pull request #94 from KunalKapadia/develop

Add npm test, test:watch, test:check-coverage npm tasks

Author: kunalkapadia

.istanbul.yml

@@ -0,0 +1,25 @@
+verbose: false
+instrumentation:
+  excludes: ['dist/**', 'coverage/**', 'gulpfile.babel.js']
+  include-all-sources: true
+reporting:
+    print: summary
+    reports:
+        - lcov
+    dir: ./coverage
+    watermarks:
+        statements: [50, 80]
+        lines: [50, 80]
+        functions: [50, 80]
+        branches: [50, 80]
+check:
+    global:
+        statements: 50
+        lines: 50
+        branches: 50
+        functions: 50
+    each:
+        statements: 50
+        lines: 50
+        branches: 50
+        functions: 20

README.md

@@ -25,7 +25,7 @@ Heavily inspired from [Egghead.io - How to Write an Open Source JavaScript Libra
 | Authentication via JsonWebToken                  	 	 | Supports authentication using [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken).  |
 | Code Linting               			 | JavaScript code linting is done using [ESLint](http://eslint.org) - a pluggable linter tool for identifying and reporting on patterns in JavaScript. Uses ESLint with [eslint-config-airbnb](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb), which tries to follow the Airbnb JavaScript style guide.                                                                                                |
 | Auto server restart                  	 | Restart the server using [nodemon](https://github.com/remy/nodemon) in real-time anytime an edit is made, with babel compilation and eslint.                                                                                                                                                                            |
-| ES6 Code Coverage via [istanbul](https://www.npmjs.com/package/istanbul)                  | Supports code coverage of ES6 code using istanbul and mocha. Code coverage reports are saved in `coverage/` directory post `npm test` execution. Open `lcov-report/index.html` to view coverage report. `npm test` also displays code coverage summary on console.                                                                                                                                                                            |
+| ES6 Code Coverage via [istanbul](https://www.npmjs.com/package/istanbul)                  | Supports code coverage of ES6 code using istanbul and mocha. Code coverage reports are saved in `coverage/` directory post `npm test` execution. Open `coverage/lcov-report/index.html` to view coverage report. `npm test` also displays code coverage summary on console. Code coverage can also be enforced overall and per file as well, configured via .istanbul.yml                                                                                                                                                                            |
 | Debugging via [debug](https://www.npmjs.com/package/debug)           | Instead of inserting and deleting console.log you can replace it with the debug function and just leave it there. You can then selectively debug portions of your code by setting DEBUG env variable. If DEBUG env variable is not set, nothing is displayed to the console.                       |
 | Promisified Code via [bluebird](https://github.com/petkaantonov/bluebird)           | We love promise, don't we ? All our code is promisified and even so our tests via [supertest-as-promised](https://www.npmjs.com/package/supertest-as-promised).                       |
 | API parameter validation via [express-validation](https://www.npmjs.com/package/express-validation)           | Validate body, params, query, headers and cookies of a request (via middleware) and return a response with errors; if any of the configured validation rules fail. You won't anymore need to make your route handler dirty with such validations. |
@@ -60,11 +60,14 @@ gulp serve
 
 Execute tests:
 ```sh
-# compile with babel and run tests
-npm test (or gulp mocha)
+# Run tests written in ES6 along with code coverage
+npm test
 
-# use --code-coverage-reporter text to get code coverage for each file
-gulp mocha --code-coverage-reporter text
+# Run tests on file change
+npm run test:watch
+
+# Run tests enforcing code coverage (configured via .istanbul.yml)
+npm run test:check-coverage
 ```
 
 Other gulp tasks:

gulpfile.babel.js

@@ -3,8 +3,6 @@ import gulpLoadPlugins from 'gulp-load-plugins';
 import path from 'path';
 import del from 'del';
 import runSequence from 'run-sequence';
-import babelCompiler from 'babel-core/register';
-import * as isparta from 'isparta';
 
 const plugins = gulpLoadPlugins();
 
@@ -14,29 +12,11 @@ const paths = {
   tests: './server/tests/*.js'
 };
 
-const options = {
-  codeCoverage: {
-    reporters: ['lcov', 'text-summary'],
-    thresholds: {
-      global: { statements: 80, branches: 80, functions: 80, lines: 80 }
-    }
-  }
-};
-
 // Clean up dist and coverage directory
 gulp.task('clean', () =>
   del(['dist/**', 'coverage/**', '!dist', '!coverage'])
 );
 
-// Set env variables
-gulp.task('set-env', () => {
-  plugins.env({
-    vars: {
-      NODE_ENV: 'test'
-    }
-  });
-});
-
 // Copy non-js files to dist
 gulp.task('copy', () =>
   gulp.src(paths.nonJs)
@@ -69,66 +49,6 @@ gulp.task('nodemon', ['copy', 'babel'], () =>
   })
 );
 
-// covers files for code coverage
-gulp.task('pre-test', () =>
-  gulp.src([...paths.js, '!gulpfile.babel.js'])
-    // Covering files
-    .pipe(plugins.istanbul({
-      instrumenter: isparta.Instrumenter,
-      includeUntested: true
-    }))
-    // Force `require` to return covered files
-    .pipe(plugins.istanbul.hookRequire())
-);
-
-// triggers mocha test with code coverage
-gulp.task('test', ['pre-test', 'set-env'], () => {
-  let reporters;
-  let exitCode = 0;
-
-  if (plugins.util.env['code-coverage-reporter']) {
-    reporters = [...options.codeCoverage.reporters, plugins.util.env['code-coverage-reporter']];
-  } else {
-    reporters = options.codeCoverage.reporters;
-  }
-
-  return gulp.src([paths.tests], { read: false })
-    .pipe(plugins.plumber())
-    .pipe(plugins.mocha({
-      reporter: plugins.util.env['mocha-reporter'] || 'spec',
-      ui: 'bdd',
-      timeout: 6000,
-      compilers: {
-        js: babelCompiler
-      }
-    }))
-    .once('error', (err) => {
-      plugins.util.log(err);
-      exitCode = 1;
-    })
-    // Creating the reports after execution of test cases
-    .pipe(plugins.istanbul.writeReports({
-      dir: './coverage',
-      reporters
-    }))
-    // Enforce test coverage
-    .pipe(plugins.istanbul.enforceThresholds({
-      thresholds: options.codeCoverage.thresholds
-    }))
-    .once('end', () => {
-      plugins.util.log('completed !!');
-      process.exit(exitCode);
-    });
-});
-
-// clean dist, compile js files, copy non-js files and execute tests
-gulp.task('mocha', ['clean'], () => {
-  runSequence(
-    ['copy', 'babel'],
-    'test'
-  );
-});
-
 // gulp serve for development
 gulp.task('serve', ['clean'], () => runSequence('nodemon'));
 

index.js

@@ -22,9 +22,13 @@ if (config.MONGOOSE_DEBUG) {
   });
 }
 
-// listen on port config.port
-app.listen(config.port, () => {
-  debug(`server started on port ${config.port} (${config.env})`);
-});
+// module.parent check is required to support mocha watch
+// src: https://github.com/mochajs/mocha/issues/1912
+if (!module.parent) {
+  // listen on port config.port
+  app.listen(config.port, () => {
+    debug(`server started on port ${config.port} (${config.env})`);
+  });
+}
 
 export default app;

package.json

@@ -14,7 +14,9 @@
     "build": "gulp",
     "lint": "esw *.js server/**/*.js config/**/*.js --color",
     "lint:watch": "npm run lint -- --watch",
-    "test": "gulp mocha",
+    "test": "NODE_ENV=test babel-node node_modules/.bin/isparta cover _mocha -- --ui bdd --reporter spec --colors --compilers js:babel-core/register ./server/**/*.test.js",
+    "test:watch": "npm run test -- --watch",
+    "test:check-coverage": "npm run test && istanbul check-coverage",
     "commit": "git-cz",
     "report-coverage": "coveralls < ./coverage/lcov.info"
   },
@@ -73,13 +75,9 @@
     "ghooks": "^1.2.4",
     "gulp": "3.9.1",
     "gulp-babel": "6.1.2",
-    "gulp-env": "^0.4.0",
-    "gulp-istanbul": "1.1.1",
     "gulp-load-plugins": "^1.2.0",
-    "gulp-mocha": "3.0.1",
     "gulp-newer": "^1.1.0",
     "gulp-nodemon": "^2.0.6",
-    "gulp-plumber": "^1.0.1",
     "gulp-sourcemaps": "^1.6.0",
     "gulp-util": "^3.0.7",
     "isparta": "4.0.0",

server/tests/user.test.js

@@ -1,10 +1,22 @@
+import mongoose from 'mongoose';
 import request from 'supertest-as-promised';
 import httpStatus from 'http-status';
 import chai, { expect } from 'chai';
 import app from '../../index';
 
 chai.config.includeStack = true;
 
+/**
+ * root level hooks
+ */
+after((done) => {
+  // required because https://github.com/Automattic/mongoose/issues/1251#issuecomment-65793092
+  mongoose.models = {};
+  mongoose.modelSchemas = {};
+  mongoose.connection.close();
+  done();
+});
+
 describe('## User APIs', () => {
   let user = {
     username: 'KK123',