feat(rules): Add option --time-setup to include beforeEach in duration

Fix timing to work with latest version of mocha. Add tests.

Fixes #419

lib/cli/run-option-metadata.js

@@ -42,6 +42,7 @@ exports.types = {
     'recursive',
     'reporters',
     'sort',
+    'time-setup',
     'watch'
   ],
   number: ['retries', 'slow', 'timeout'],

lib/cli/run.js

@@ -233,6 +233,11 @@ exports.builder = yargs =>
         description: 'Specify test timeout threshold (in milliseconds)',
         group: GROUPS.RULES
       },
+      'time-setup': {
+        description:
+          'Include any beforeEach (or setup) time in duration of each test',
+        group: GROUPS.RULES
+      },
       ui: {
         default: defaults.ui,
         description: 'Specify user interface',

lib/mocha.js

@@ -113,6 +113,7 @@ function Mocha(options) {
     .reporter(options.reporter, options.reporterOptions)
     .useColors(options.color)
     .slow(options.slow)
+    .timeSetup(options.timeSetup)
     .useInlineDiffs(options.inlineDiffs)
     .globals(options.globals);
 
@@ -666,6 +667,21 @@ Mocha.prototype.slow = function(msecs) {
   return this;
 };
 
+/**
+ * Sets time setup option, which will cause time for any beforeEach (setup)
+ * methods to be included in the duration of each test.
+ *
+ * @public
+ * @see {@link https://mochajs.org/#-s---time-setup|CLI option}
+ * @param {boolean} timeSetup - Whether to enable the time setup option.
+ * @return {Mocha} this
+ * @chainable
+ */
+Mocha.prototype.timeSetup = function(timeSetup) {
+  this.suite.timeSetup(timeSetup);
+  return this;
+};
+
 /**
  * Enables or disables timeouts.
  *

lib/runnable.js

@@ -290,10 +290,10 @@ Runnable.prototype.globals = function(globals) {
 Runnable.prototype.run = function(fn) {
   var self = this;
   var start;
-  if (typeof self.start === 'number') {
+  if (self.start) {
     start = self.start;
   } else {
-    start = Date.now();
+    start = new Date();
   }
   var ctx = this.ctx;
   var finished;

lib/runner.js

@@ -27,6 +27,11 @@ var type = utils.type;
 var createInvalidExceptionError = require('./errors')
   .createInvalidExceptionError;
 
+/**
+ * Save timer references to avoid Sinon interfering (see GH-237).
+ */
+var Date = global.Date;
+
 /**
  * Non-enumerable globals.
  * @readonly
@@ -501,13 +506,15 @@ Runner.prototype.parents = function() {
 Runner.prototype.runTest = function(fn) {
   var self = this;
   var test = this.test;
-  test.start = self.start;
 
   if (!test) {
     return;
   }
 
   var suite = this.parents().reverse()[0] || this.suite;
+  if (suite._timeSetup) {
+    test.start = self.start;
+  }
   if (this.forbidOnly && suite.hasOnly()) {
     fn(new Error('`.only` forbidden'));
     return;
@@ -624,7 +631,9 @@ Runner.prototype.runTests = function(suite, fn) {
     }
 
     // execute test and hook(s)
-    self.start = Date.now();
+    if (suite._timeSetup) {
+      self.start = new Date();
+    }
     self.emit(constants.EVENT_TEST_BEGIN, (self.test = test));
     self.hookDown(HOOK_TYPE_BEFORE_EACH, function(err, errSuite) {
       if (test.isPending()) {

lib/suite.js

@@ -70,6 +70,7 @@ function Suite(title, parentContext, isRoot) {
   this._timeout = 2000;
   this._enableTimeouts = true;
   this._slow = 75;
+  this._timeSetup = false;
   this._bail = false;
   this._retries = -1;
   this._onlyTests = [];
@@ -107,6 +108,7 @@ Suite.prototype.clone = function() {
   suite.enableTimeouts(this.enableTimeouts());
   suite.slow(this.slow());
   suite.bail(this.bail());
+  suite.timeSetup(this.timeSetup());
   return suite;
 };
 
@@ -183,6 +185,22 @@ Suite.prototype.slow = function(ms) {
   return this;
 };
 
+/**
+ * Set or get time setup option.
+ *
+ * @private
+ * @param {boolean} timeSetup
+ * @return {Suite|boolean} for chaining
+ */
+Suite.prototype.timeSetup = function(timeSetup) {
+  if (!arguments.length) {
+    return this._timeSetup;
+  }
+  debug('timeSetup %s', timeSetup);
+  this._timeSetup = timeSetup;
+  return this;
+};
+
 /**
  * Set or get whether to bail after first error.
  *
@@ -338,6 +356,7 @@ Suite.prototype.addSuite = function(suite) {
   suite.enableTimeouts(this.enableTimeouts());
   suite.slow(this.slow());
   suite.bail(this.bail());
+  suite.timeSetup(this.timeSetup());
   this.suites.push(suite);
   this.emit(constants.EVENT_SUITE_ADD_SUITE, suite);
   return this;

test/integration/fixtures/options/time-setup.fixture.js

@@ -0,0 +1,10 @@
+'use strict';
+
+describe('time-setup', function () {
+  beforeEach(function(done) {
+    // simulate some slow setup process
+    setTimeout(done, 20);
+  });
+
+  it('should run quickly', function () {});
+});

test/integration/options/timeSetup.spec.js

@@ -0,0 +1,39 @@
+'use strict';
+
+var path = require('path').posix;
+var helpers = require('../helpers');
+var runMochaJSON = helpers.runMochaJSON;
+
+describe('--time-setup', function() {
+  var args = [];
+
+  describe('with the option', function() {
+    before(function() {
+      args = ['--time-setup'];
+    });
+
+    it('should include the setup time', function(done) {
+      var fixture = path.join('options', 'time-setup');
+      runMochaJSON(fixture, args, function(err, res) {
+        if (err) {
+          return done(err);
+        }
+
+        expect(res.tests[0].duration, 'to be greater than or equal to', 20);
+        done();
+      });
+    });
+  });
+
+  it('should not include the setup time if --time-setup is not specified', function(done) {
+    var fixture = path.join('options', 'time-setup');
+    runMochaJSON(fixture, args, function(err, res) {
+      if (err) {
+        return done(err);
+      }
+
+      expect(res.tests[0].duration, 'to be less than', 20);
+      done();
+    });
+  });
+});