#1039 Fail tests when error provided to test hook done callback

nightwatchjs · Jun 11, 2017 · 5ecf985 · 5ecf985
1 parent a2810c4
commit 5ecf985
Show file tree

Hide file tree

Showing 6 changed files with 91 additions and 9 deletions.
diff --git a/lib/runner/testsuite.js b/lib/runner/testsuite.js
@@ -86,12 +86,12 @@ TestSuite.prototype.initHooks = function() {
           var called = false;
           var originalFn = self.module.get(key);
 
-          var doneFn = function() {
+          var doneFn = function(err) {
             called = true;
             if (callbackDeffered) {
               return;
             }
-            return done();
+            return done(err, true);
           };
 
           self.runHookMethod(item, context, argsCount, key, doneFn, this.deferred);
@@ -177,8 +177,8 @@ TestSuite.prototype.initAfterEachHook = function() {
         if (self.options.compatible_testcase_support) {
           asyncFn.call(module, doneFn);
         } else {
-          asyncFn.call(module, api, function() {
-            doneFn();
+          asyncFn.call(module, api, function(err) {
+            doneFn(err);
           });
         }
 
@@ -509,9 +509,8 @@ TestSuite.prototype.adaptDoneCallback = function(done, hookName, deferred) {
 TestSuite.prototype.makePromise = function (fn) {
   var deferred = Q.defer();
   try {
-    fn.call(this, function(err, hookErr) {
-      // in case of an exception thrown inside a global hook, we need to reject the promise here
-      if (hookErr && Utils.isErrorObject(err)) {
+    fn.call(this, function(err, rejectOnError) {
+      if (rejectOnError && Utils.isErrorObject(err)) {
         deferred.reject(err);
       } else {
         deferred.resolve();

diff --git a/test/asynchookstests/async-provide-error/after.js b/test/asynchookstests/async-provide-error/after.js
@@ -0,0 +1,11 @@
+module.exports = {
+  demoTest : function (client) {
+    client.url('http://localhost')
+      .assert.elementPresent('#weblogin')
+      .end();
+  },
+
+  after : function(client, done) {
+    done(new Error('Provided error after'));
+  }
+};
diff --git a/test/asynchookstests/async-provide-error/afterEach.js b/test/asynchookstests/async-provide-error/afterEach.js
@@ -0,0 +1,11 @@
+module.exports = {
+  demoTest : function (client) {
+    client.url('http://localhost')
+      .assert.elementPresent('#weblogin')
+      .end();
+  },
+
+  afterEach : function(client, done) {
+    done(new Error('Provided error afterEach'));
+  }
+};
diff --git a/test/asynchookstests/async-provide-error/before.js b/test/asynchookstests/async-provide-error/before.js
@@ -0,0 +1,11 @@
+module.exports = {
+  demoTest : function (client) {
+    client.url('http://localhost')
+      .assert.elementPresent('#weblogin')
+      .end();
+  },
+
+  before : function(client, done) {
+    done(new Error('Provided error before'));
+  }
+};
diff --git a/test/asynchookstests/async-provide-error/beforeEach.js b/test/asynchookstests/async-provide-error/beforeEach.js
@@ -0,0 +1,11 @@
+module.exports = {
+  demoTest : function (client) {
+    client.url('http://localhost')
+      .assert.elementPresent('#weblogin')
+      .end();
+  },
+
+  beforeEach : function(client, done) {
+    done(new Error('Provided error beforeEach'));
+  }
+};
diff --git a/test/src/runner/testRunWithHooks.js b/test/src/runner/testRunWithHooks.js
@@ -4,7 +4,7 @@ var common = require('../../common.js');
 var CommandGlobals = require('../../lib/globals/commands.js');
 var Runner = common.require('runner/run.js');
 
-module.exports = {
+var tests = {
   'testRunWithHooks' : {
     before: function (done) {
       CommandGlobals.beforeEach.call(this, done);
@@ -174,7 +174,7 @@ module.exports = {
         persist_globals : true,
         globals: globals
       }, {
-        output_folder: false, 
+        output_folder: false,
         start_session: true
       }, function (err, results) {
         if (err) {
@@ -219,3 +219,42 @@ module.exports = {
     }
   }
 };
+
+var hooks = ['before', 'after', 'beforeEach', 'afterEach'];
+
+hooks.forEach(function (hook) {
+  var provideErrorTest = 'test async ' + hook + ' hook provide error';
+
+  tests.testRunWithHooks[provideErrorTest] = function (done) {
+    var provideErrorTestPath = path.join(__dirname,
+      '../../asynchookstests/async-provide-error/' + hook + '.js');
+    var expectedErrorMessage = 'Provided error ' + hook;
+
+    var globals = {
+      calls : 0,
+      asyncHookTimeout: 10
+    };
+
+    var runner = new Runner([provideErrorTestPath], {
+      seleniumPort: 10195,
+      silent: true,
+      output: false,
+      persist_globals : true,
+      globals: globals
+    }, {
+      output_folder: false,
+      start_session: true
+    }, function (err, results) {
+      assert.equal(err.message, expectedErrorMessage);
+      assert.ok(err instanceof Error);
+
+      done();
+    });
+
+    runner.run().catch(function(err) {
+      done(err);
+    });
+  };
+});
+
+module.exports = tests;