Skip to content

armgit / mocha

Public Imported from GitHub
0

☕️ Classic, reliable, trusted test framework for Node.js and the browser

added allowUncaught option (#553) allows unhandled exceptions to propagate in the browser added tests for allowUncaught option global error handler prints to dom with allowUncaught

amsul92dfdd420ff2
diff --git a/lib/mocha.js b/lib/mocha.js
index 1817ccf2..e3a2321e 100644
--- a/lib/mocha.js
+++ b/lib/mocha.js
@@ -68,8 +68,8 @@ function image(name) {
* - `fullTrace` display the full stack-trace on failing
* - `grep` string or regexp to filter tests with
*
- * @api public
* @param {Object} options
+ * @api public
*/
function Mocha(options) {
options = options || {};
@@ -141,6 +141,8 @@ Mocha.prototype.addFile = function(file) {
/**
* Set reporter to `reporter`, defaults to "spec".
*
+ * @param {String|Function} reporter name or constructor
+ * @param {Object} reporterOptions optional options
* @api public
* @param {string|Function} reporter name or constructor
* @param {Object} reporterOptions optional options
@@ -243,6 +245,8 @@ Mocha.prototype._growl = function(runner, reporter) {
/**
* Add regexp to grep, if `re` is a string it is escaped.
*
+ * @param {RegExp|String} re
+ * @return {Mocha}
* @api public
* @param {RegExp|string} re
* @return {Mocha}
@@ -255,8 +259,8 @@ Mocha.prototype.grep = function(re) {
/**
* Invert `.grep()` matches.
*
- * @api public
* @return {Mocha}
+ * @api public
*/
Mocha.prototype.invert = function() {
this.options.invert = true;
@@ -266,6 +270,8 @@ Mocha.prototype.invert = function() {
/**
* Ignore global leaks.
*
+ * @param {Boolean} ignore
+ * @return {Mocha}
* @api public
* @param {boolean} ignore
* @return {Mocha}
@@ -278,8 +284,8 @@ Mocha.prototype.ignoreLeaks = function(ignore) {
/**
* Enable global leak checking.
*
- * @api public
* @return {Mocha}
+ * @api public
*/
Mocha.prototype.checkLeaks = function() {
this.options.ignoreLeaks = false;
@@ -289,8 +295,8 @@ Mocha.prototype.checkLeaks = function() {
/**
* Display long stack-trace on failing
*
- * @api public
* @return {Mocha}
+ * @api public
*/
Mocha.prototype.fullTrace = function() {
this.options.fullStackTrace = true;
@@ -300,8 +306,8 @@ Mocha.prototype.fullTrace = function() {
/**
* Enable growl support.
*
- * @api public
* @return {Mocha}
+ * @api public
*/
Mocha.prototype.growl = function() {
this.options.growl = true;
@@ -311,6 +317,8 @@ Mocha.prototype.growl = function() {
/**
* Ignore `globals` array or string.
*
+ * @param {Array|String} globals
+ * @return {Mocha}
* @api public
* @param {Array|string} globals
* @return {Mocha}
@@ -323,6 +331,8 @@ Mocha.prototype.globals = function(globals) {
/**
* Emit color output.
*
+ * @param {Boolean} colors
+ * @return {Mocha}
* @api public
* @param {boolean} colors
* @return {Mocha}
@@ -337,6 +347,8 @@ Mocha.prototype.useColors = function(colors) {
/**
* Use inline diffs rather than +/-.
*
+ * @param {Boolean} inlineDiffs
+ * @return {Mocha}
* @api public
* @param {boolean} inlineDiffs
* @return {Mocha}
@@ -349,6 +361,8 @@ Mocha.prototype.useInlineDiffs = function(inlineDiffs) {
/**
* Set the timeout in milliseconds.
*
+ * @param {Number} timeout
+ * @return {Mocha}
* @api public
* @param {number} timeout
* @return {Mocha}
@@ -361,6 +375,8 @@ Mocha.prototype.timeout = function(timeout) {
/**
* Set slowness threshold in milliseconds.
*
+ * @param {Number} slow
+ * @return {Mocha}
* @api public
* @param {number} slow
* @return {Mocha}
@@ -373,6 +389,8 @@ Mocha.prototype.slow = function(slow) {
/**
* Enable timeouts.
*
+ * @param {Boolean} enabled
+ * @return {Mocha}
* @api public
* @param {boolean} enabled
* @return {Mocha}
@@ -385,8 +403,8 @@ Mocha.prototype.enableTimeouts = function(enabled) {
/**
* Makes all tests async (accepting a callback)
*
- * @api public
* @return {Mocha}
+ * @api public
*/
Mocha.prototype.asyncOnly = function() {
this.options.asyncOnly = true;
@@ -397,7 +415,6 @@ Mocha.prototype.asyncOnly = function() {
* Disable syntax highlighting (in browser).
*
* @api public
- * @returns {Mocha}
*/
Mocha.prototype.noHighlighting = function() {
this.options.noHighlighting = true;
@@ -405,9 +422,18 @@ Mocha.prototype.noHighlighting = function() {
};
/**
- * Delay root suite execution.
+ * Enable uncaught errors to propagate (in browser).
*
+ * @return {Mocha}
* @api public
+ */
+Mocha.prototype.allowUncaught = function() {
+ this.options.allowUncaught = true;
+ return this;
+};
+
+/**
+ * Delay root suite execution.
* @returns {Mocha}
*/
Mocha.prototype.delay = function delay() {
@@ -434,6 +460,7 @@ Mocha.prototype.run = function(fn) {
runner.ignoreLeaks = options.ignoreLeaks !== false;
runner.fullStackTrace = options.fullStackTrace;
runner.asyncOnly = options.asyncOnly;
+ runner.allowUncaught = options.allowUncaught;
if (options.grep) {
runner.grep(options.grep, options.invert);
}
diff --git a/lib/runnable.js b/lib/runnable.js
index a048d4a0..01b84ccb 100644
--- a/lib/runnable.js
+++ b/lib/runnable.js
@@ -36,6 +36,8 @@ module.exports = Runnable;
/**
* Initialize a new `Runnable` with the given `title` and callback `fn`.
*
+ * @param {String} title
+ * @param {Function} fn
* @api private
* @param {string} title
* @param {Function} fn
@@ -205,8 +207,8 @@ Runnable.prototype.globals = function(globals) {
/**
* Run the test and invoke `fn(err)`.
*
- * @api private
* @param {Function} fn
+ * @api private
*/
Runnable.prototype.run = function(fn) {
var self = this;
@@ -255,25 +257,23 @@ Runnable.prototype.run = function(fn) {
if (this.async) {
this.resetTimeout();
+ if (this.allowUncaught) {
+ return callFnAsync(this.fn);
+ }
try {
- this.fn.call(ctx, function(err) {
- if (err instanceof Error || toString.call(err) === '[object Error]') {
- return done(err);
- }
- if (err != null) {
- if (Object.prototype.toString.call(err) === '[object Object]') {
- return done(new Error('done() invoked with non-Error: ' + JSON.stringify(err)));
- }
- return done(new Error('done() invoked with non-Error: ' + err));
- }
- done();
- });
+ callFnAsync(this.fn);
} catch (err) {
done(utils.getError(err));
}
return;
}
+ if (this.allowUncaught) {
+ callFn(this.fn);
+ done();
+ return;
+ }
+
// sync or promise-returning
try {
if (this.pending) {
@@ -304,4 +304,20 @@ Runnable.prototype.run = function(fn) {
done();
}
}
+
+ function callFnAsync(fn) {
+ fn.call(ctx, function(err) {
+ if (err instanceof Error || toString.call(err) === '[object Error]') {
+ return done(err);
+ }
+ if (err) {
+ if (Object.prototype.toString.call(err) === '[object Object]') {
+ return done(new Error('done() invoked with non-Error: '
+ + JSON.stringify(err)));
+ }
+ return done(new Error('done() invoked with non-Error: ' + err));
+ }
+ done();
+ });
+ }
};
diff --git a/lib/runner.js b/lib/runner.js
index a63bb9ee..968e4080 100644
--- a/lib/runner.js
+++ b/lib/runner.js
@@ -79,8 +79,8 @@ function Runner(suite, delay) {
/**
* Wrapper for setImmediate, process.nextTick, or browser polyfill.
*
- * @api private
* @param {Function} fn
+ * @api private
*/
Runner.immediately = global.setImmediate || process.nextTick;
@@ -96,6 +96,9 @@ Runner.prototype = create(EventEmitter.prototype, {
* Run tests with full titles matching `re`. Updates runner.total
* with number of tests matched.
*
+ * @param {RegExp} re
+ * @param {Boolean} invert
+ * @return {Runner} for chaining
* @api public
* @param {RegExp} re
* @param {boolean} invert
@@ -113,6 +116,8 @@ Runner.prototype.grep = function(re, invert) {
* Returns the number of tests matching the grep search for the
* given suite.
*
+ * @param {Suite} suite
+ * @return {Number}
* @api public
* @param {Suite} suite
* @return {number}
@@ -137,8 +142,8 @@ Runner.prototype.grepTotal = function(suite) {
/**
* Return a list of global properties.
*
- * @api private
* @return {Array}
+ * @api private
*/
Runner.prototype.globalProps = function() {
var props = keys(global);
@@ -157,6 +162,8 @@ Runner.prototype.globalProps = function() {
/**
* Allow the given `arr` of globals.
*
+ * @param {Array} arr
+ * @return {Runner} for chaining
* @api public
* @param {Array} arr
* @return {Runner} Runner instance.
@@ -264,6 +271,7 @@ Runner.prototype.failHook = function(hook, err) {
* @param {string} name
* @param {Function} fn
*/
+
Runner.prototype.hook = function(name, fn) {
var suite = this.suite;
var hooks = suite['_' + name];
@@ -349,9 +357,9 @@ Runner.prototype.hooks = function(name, suites, fn) {
/**
* Run hooks from the top level down.
*
- * @api private
- * @param {string} name
+ * @param {String} name
* @param {Function} fn
+ * @api private
*/
Runner.prototype.hookUp = function(name, fn) {
var suites = [this.suite].concat(this.parents()).reverse();
@@ -361,9 +369,9 @@ Runner.prototype.hookUp = function(name, fn) {
/**
* Run hooks from the bottom up.
*
- * @api private
- * @param {string} name
+ * @param {String} name
* @param {Function} fn
+ * @api private
*/
Runner.prototype.hookDown = function(name, fn) {
var suites = [this.suite].concat(this.parents());
@@ -374,8 +382,8 @@ Runner.prototype.hookDown = function(name, fn) {
* Return an array of parent Suites from
* closest to furthest.
*
- * @api private
* @return {Array}
+ * @api private
*/
Runner.prototype.parents = function() {
var suite = this.suite;
@@ -389,8 +397,8 @@ Runner.prototype.parents = function() {
/**
* Run the current test and callback `fn(err)`.
*
- * @api private
* @param {Function} fn
+ * @api private
*/
Runner.prototype.runTest = function(fn) {
var self = this;
@@ -400,6 +408,10 @@ Runner.prototype.runTest = function(fn) {
test.asyncOnly = true;
}
+ if (this.allowUncaught) {
+ test.allowUncaught = true;
+ return test.run(fn);
+ }
try {
test.on('error', function(err) {
self.fail(test, err);
@@ -627,8 +639,8 @@ Runner.prototype.runSuite = function(suite, fn) {
/**
* Handle uncaught exceptions.
*
- * @api private
* @param {Error} err
+ * @api private
*/
Runner.prototype.uncaught = function(err) {
if (err) {
@@ -684,6 +696,8 @@ Runner.prototype.uncaught = function(err) {
* Run the root suite and invoke `fn(failures)`
* on completion.
*
+ * @param {Function} fn
+ * @return {Runner} for chaining
* @api public
* @param {Function} fn
* @return {Runner} Runner instance.
@@ -789,11 +803,11 @@ function filterLeaks(ok, globals) {
/**
* Array of globals dependent on the environment.
*
- * @api private
* @return {Array}
+ * @api private
*/
function extraGlobals() {
- if (!process.browser) {
+ if (typeof process === 'object' && typeof process.version === 'string') {
var nodeVersion = process.version.split('.').reduce(function(a, v) {
return a << 8 | v;
});
diff --git a/support/browser-entry.js b/support/browser-entry.js
index c711ce3e..bd2c0aad 100644
--- a/support/browser-entry.js
+++ b/support/browser-entry.js
@@ -53,7 +53,7 @@ process.on = function(e, fn){
if ('uncaughtException' == e) {
global.onerror = function(err, url, line){
fn(new Error(err + ' (' + url + ':' + line + ')'));
- return true;
+ return !mocha.allowUncaught;
};
uncaughtExceptionHandlers.push(fn);
}
diff --git a/test/runnable.js b/test/runnable.js
index 2508a5fa..6d66e310 100644
--- a/test/runnable.js
+++ b/test/runnable.js
@@ -132,6 +132,20 @@ describe('Runnable(title, fn)', function(){
})
})
})
+
+ describe('when an exception is thrown and is allowed to remain uncaught', function(){
+ it('throws an error when it is allowed', function(done) {
+ var test = new Runnable('foo', function(){
+ throw new Error('fail');
+ });
+ test.allowUncaught = true;
+ function fail() {
+ test.run(function(err) {});
+ }
+ fail.should.throw('fail');
+ done();
+ })
+ })
})
describe('when timeouts are disabled', function() {
@@ -239,6 +253,21 @@ describe('Runnable(title, fn)', function(){
});
})
+ describe('when an exception is thrown and is allowed to remain uncaught', function(){
+ it('throws an error when it is allowed', function(done) {
+ var test = new Runnable('foo', function(done){
+ throw new Error('fail');
+ process.nextTick(done);
+ });
+ test.allowUncaught = true;
+ function fail() {
+ test.run(function(err) {});
+ }
+ fail.should.throw('fail');
+ done();
+ })
+ })
+
describe('when an error is passed', function(){
it('should invoke the callback', function(done){
var calls = 0;
diff --git a/test/runner.js b/test/runner.js
index 1e023143..cbf6b49f 100644
--- a/test/runner.js
+++ b/test/runner.js
@@ -314,6 +314,21 @@ describe('Runner', function(){
})
});
+ describe('allowUncaught', function() {
+ it('should allow unhandled errors to propagate through', function(done) {
+ var newRunner = new Runner(suite);
+ newRunner.allowUncaught = true;
+ newRunner.test = new Test('failing test', function() {
+ throw new Error('allow unhandled errors');
+ });
+ function fail() {
+ newRunner.runTest();
+ }
+ fail.should.throw('allow unhandled errors');
+ done();
+ });
+ });
+
describe('stackTrace', function() {
var stack = [ 'AssertionError: foo bar'
, 'at EventEmitter.<anonymous> (/usr/local/dev/test.js:16:12)'