added allowUncaught option (mochajs#553)

added tests for allowUncaught option error handler prints to dom with allowUncaught
pumpupapp · Apr 18, 2015 · cd132a9 · cd132a9
1 parent 5bc6500
commit cd132a9
Show file tree

Hide file tree

Showing 7 changed files with 132 additions and 32 deletions.
diff --git a/lib/mocha.js b/lib/mocha.js
@@ -401,6 +401,18 @@ Mocha.prototype.noHighlighting = function() {
   return this;
 };
 
+/**
+ * Enable uncaught errors to propagate (in browser).
+ *
+ * @return {Mocha}
+ * @api public
+ */
+
+Mocha.prototype.allowUncaught = function(){
+  this.options.allowUncaught = global.mocha.allowUncaught = true;
+  return this;
+};
+
 /**
  * Delay root suite execution.
  * @returns {Mocha}
@@ -428,6 +440,7 @@ Mocha.prototype.run = function(fn){
   runner.ignoreLeaks = false !== options.ignoreLeaks;
   runner.fullStackTrace = options.fullStackTrace;
   runner.asyncOnly = options.asyncOnly;
+  runner.allowUncaught = options.allowUncaught;
   if (options.grep) runner.grep(options.grep, options.invert);
   if (options.globals) runner.globals(options.globals);
   if (options.growl) this._growl(runner, reporter);

diff --git a/lib/runnable.js b/lib/runnable.js
@@ -229,24 +229,26 @@ Runnable.prototype.run = function(fn){
   if (this.async) {
     this.resetTimeout();
 
-    try {
-      this.fn.call(ctx, function(err){
-        if (err instanceof Error || toString.call(err) === "[object Error]") return done(err);
-        if (null != err) {
-          if (Object.prototype.toString.call(err) === '[object Object]') {
-            return done(new Error('done() invoked with non-Error: ' + JSON.stringify(err)));
-          } else {
-            return done(new Error('done() invoked with non-Error: ' + err));
-          }
-        }
-        done();
-      });
+    if (this.allowUncaught) {
+      callFnAsync(this.fn);
+    } else try {
+      callFnAsync(this.fn);
     } catch (err) {
       done(utils.getError(err));
     }
     return;
   }
 
+  if (this.asyncOnly) {
+    return done(new Error('--async-only option in use without declaring `done()`'));
+  }
+
+  if (this.allowUncaught) {
+    callFn(this.fn);
+    done();
+    return;
+  }
+
   // sync or promise-returning
   try {
     if (this.pending) {
@@ -270,11 +272,21 @@ Runnable.prototype.run = function(fn){
           done(reason || new Error('Promise rejected with no or falsy reason'))
         });
     } else {
-      if (self.asyncOnly) {
-        return done(new Error('--async-only option in use without declaring `done()` or returning a promise'));
-      }
-
       done();
     }
   }
+
+  function callFnAsync(fn) {
+    fn.call(ctx, function(err){
+      if (err instanceof Error || toString.call(err) === "[object Error]") return done(err);
+      if (null != err) {
+        if (Object.prototype.toString.call(err) === '[object Object]') {
+          return done(new Error('done() invoked with non-Error: ' + JSON.stringify(err)));
+        } else {
+          return done(new Error('done() invoked with non-Error: ' + err));
+        }
+      }
+      done();
+    });
+  }
 };
diff --git a/lib/runner.js b/lib/runner.js
@@ -383,7 +383,10 @@ Runner.prototype.runTest = function(fn){
 
   if (this.asyncOnly) test.asyncOnly = true;
 
-  try {
+  if (this.allowUncaught) {
+    test.allowUncaught = true;
+    test.run(fn);
+  } else try {
     test.on('error', function(err){
       self.fail(test, err);
     });

diff --git a/mocha.js b/mocha.js
@@ -1805,6 +1805,18 @@ Mocha.prototype.noHighlighting = function() {
   return this;
 };
 
+/**
+ * Enable uncaught errors to propagate (in browser).
+ *
+ * @return {Mocha}
+ * @api public
+ */
+
+Mocha.prototype.allowUncaught = function(){
+  this.options.allowUncaught = global.mocha.allowUncaught = true;
+  return this;
+};
+
 /**
  * Delay root suite execution.
  * @returns {Mocha}
@@ -1832,6 +1844,7 @@ Mocha.prototype.run = function(fn){
   runner.ignoreLeaks = false !== options.ignoreLeaks;
   runner.fullStackTrace = options.fullStackTrace;
   runner.asyncOnly = options.asyncOnly;
+  runner.allowUncaught = options.allowUncaught;
   if (options.grep) runner.grep(options.grep, options.invert);
   if (options.globals) runner.globals(options.globals);
   if (options.growl) this._growl(runner, reporter);
@@ -4525,18 +4538,10 @@ Runnable.prototype.run = function(fn){
   if (this.async) {
     this.resetTimeout();
 
-    try {
-      this.fn.call(ctx, function(err){
-        if (err instanceof Error || toString.call(err) === "[object Error]") return done(err);
-        if (null != err) {
-          if (Object.prototype.toString.call(err) === '[object Object]') {
-            return done(new Error('done() invoked with non-Error: ' + JSON.stringify(err)));
-          } else {
-            return done(new Error('done() invoked with non-Error: ' + err));
-          }
-        }
-        done();
-      });
+    if (this.allowUncaught) {
+      callFnAsync(this.fn);
+    } else try {
+      callFnAsync(this.fn);
     } catch (err) {
       done(utils.getError(err));
     }
@@ -4547,6 +4552,12 @@ Runnable.prototype.run = function(fn){
     return done(new Error('--async-only option in use without declaring `done()`'));
   }
 
+  if (this.allowUncaught) {
+    callFn(this.fn);
+    done();
+    return;
+  }
+
   // sync or promise-returning
   try {
     if (this.pending) {
@@ -4573,6 +4584,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 (null != err) {
+        if (Object.prototype.toString.call(err) === '[object Object]') {
+          return done(new Error('done() invoked with non-Error: ' + JSON.stringify(err)));
+        } else {
+          return done(new Error('done() invoked with non-Error: ' + err));
+        }
+      }
+      done();
+    });
+  }
 };
 
 }); // module: runnable.js
@@ -4967,7 +4992,10 @@ Runner.prototype.runTest = function(fn){
 
   if (this.asyncOnly) test.asyncOnly = true;
 
-  try {
+  if (this.allowUncaught) {
+    test.allowUncaught = true;
+    test.run(fn);
+  } else try {
     test.on('error', function(err){
       self.fail(test, err);
     });
@@ -6456,7 +6484,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/support/tail.js b/support/tail.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
@@ -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
@@ -292,6 +292,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)'