123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217 |
- /**
- * Module dependencies.
- */
- var EventEmitter = require('events').EventEmitter
- , debug = require('debug')('mocha:runnable')
- , milliseconds = require('./ms');
- /**
- * Save timer references to avoid Sinon interfering (see GH-237).
- */
- var Date = global.Date
- , setTimeout = global.setTimeout
- , setInterval = global.setInterval
- , clearTimeout = global.clearTimeout
- , clearInterval = global.clearInterval;
- /**
- * Object#toString().
- */
- var toString = Object.prototype.toString;
- /**
- * Expose `Runnable`.
- */
- module.exports = Runnable;
- /**
- * Initialize a new `Runnable` with the given `title` and callback `fn`.
- *
- * @param {String} title
- * @param {Function} fn
- * @api private
- */
- function Runnable(title, fn) {
- this.title = title;
- this.fn = fn;
- this.async = fn && fn.length;
- this.sync = ! this.async;
- this._timeout = 2000;
- this._slow = 75;
- this.timedOut = false;
- }
- /**
- * Inherit from `EventEmitter.prototype`.
- */
- Runnable.prototype.__proto__ = EventEmitter.prototype;
- /**
- * Set & get timeout `ms`.
- *
- * @param {Number|String} ms
- * @return {Runnable|Number} ms or self
- * @api private
- */
- Runnable.prototype.timeout = function(ms){
- if (0 == arguments.length) return this._timeout;
- if ('string' == typeof ms) ms = milliseconds(ms);
- debug('timeout %d', ms);
- this._timeout = ms;
- if (this.timer) this.resetTimeout();
- return this;
- };
- /**
- * Set & get slow `ms`.
- *
- * @param {Number|String} ms
- * @return {Runnable|Number} ms or self
- * @api private
- */
- Runnable.prototype.slow = function(ms){
- if (0 === arguments.length) return this._slow;
- if ('string' == typeof ms) ms = milliseconds(ms);
- debug('timeout %d', ms);
- this._slow = ms;
- return this;
- };
- /**
- * Return the full title generated by recursively
- * concatenating the parent's full title.
- *
- * @return {String}
- * @api public
- */
- Runnable.prototype.fullTitle = function(){
- return this.parent.fullTitle() + ' ' + this.title;
- };
- /**
- * Clear the timeout.
- *
- * @api private
- */
- Runnable.prototype.clearTimeout = function(){
- clearTimeout(this.timer);
- };
- /**
- * Inspect the runnable void of private properties.
- *
- * @return {String}
- * @api private
- */
- Runnable.prototype.inspect = function(){
- return JSON.stringify(this, function(key, val){
- if ('_' == key[0]) return;
- if ('parent' == key) return '#<Suite>';
- if ('ctx' == key) return '#<Context>';
- return val;
- }, 2);
- };
- /**
- * Reset the timeout.
- *
- * @api private
- */
- Runnable.prototype.resetTimeout = function(){
- var self = this;
- var ms = this.timeout() || 1e9;
- this.clearTimeout();
- this.timer = setTimeout(function(){
- self.callback(new Error('timeout of ' + ms + 'ms exceeded'));
- self.timedOut = true;
- }, ms);
- };
- /**
- * Run the test and invoke `fn(err)`.
- *
- * @param {Function} fn
- * @api private
- */
- Runnable.prototype.run = function(fn){
- var self = this
- , ms = this.timeout()
- , start = new Date
- , ctx = this.ctx
- , finished
- , emitted;
- if (ctx) ctx.runnable(this);
- // timeout
- if (this.async) {
- if (ms) {
- this.timer = setTimeout(function(){
- done(new Error('timeout of ' + ms + 'ms exceeded'));
- self.timedOut = true;
- }, ms);
- }
- }
- // called multiple times
- function multiple(err) {
- if (emitted) return;
- emitted = true;
- self.emit('error', err || new Error('done() called multiple times'));
- }
- // finished
- function done(err) {
- if (self.timedOut) return;
- if (finished) return multiple(err);
- self.clearTimeout();
- self.duration = new Date - start;
- finished = true;
- fn(err);
- }
- // for .resetTimeout()
- this.callback = done;
- // async
- if (this.async) {
- try {
- this.fn.call(ctx, function(err){
- if (err instanceof Error || toString.call(err) === "[object Error]") return done(err);
- if (null != err) return done(new Error('done() invoked with non-Error: ' + err));
- done();
- });
- } catch (err) {
- done(err);
- }
- return;
- }
- if (this.asyncOnly) {
- return done(new Error('--async-only option in use without declaring `done()`'));
- }
- // sync
- try {
- if (!this.pending) this.fn.call(ctx);
- this.duration = new Date - start;
- fn();
- } catch (err) {
- fn(err);
- }
- };
|