Fixed a problem with Selenium server log not being written properly in case of test failures/errors

Author: beatfactor

lib/runner/cli/clirunner.js

@@ -276,9 +276,11 @@ CliRunner.prototype = {
    * Stops the selenium server if it is running
    * @returns {CliRunner}
    */
-  stopSelenium : function() {
+  stopSelenium : function(callback) {
     if (this.manageSelenium) {
-      Selenium.stopServer();
+      Selenium.stopServer(callback);
+    } else {
+      callback();
     }
     return this;
   },
@@ -307,18 +309,18 @@ CliRunner.prototype = {
         testcase : self.argv.testcase,
         end_session_on_fail : self.endSessionOnFail
       }, function(err, results) {
-        self.stopSelenium();
-
-        var globalsContext = self.test_settings && self.test_settings.globals || null;
-        var afterGlobal = Utils.checkFunction('after', globalsContext) || function(done) {done();};
-
-        try {
-          afterGlobal.call(globalsContext, function done() {
-            self.globalErrorHandler(err, results, finished);
-          });
-        } catch (ex) {
-          self.globalErrorHandler(ex, results, finished);
-        }
+        self.stopSelenium(function() {
+          var globalsContext = self.test_settings && self.test_settings.globals || null;
+          var afterGlobal = Utils.checkFunction('after', globalsContext) || function(done) {done();};
+
+          try {
+            afterGlobal.call(globalsContext, function done() {
+              self.globalErrorHandler(err, results, finished);
+            });
+          } catch (ex) {
+            self.globalErrorHandler(ex, results, finished);
+          }
+        });
       });
     });
 
@@ -522,13 +524,14 @@ CliRunner.prototype = {
 
     this.startSelenium(function() {
       self.startChildProcesses(envs, function(o, code) {
-        self.stopSelenium();
-        if (done) {
-          done(o, code);
-        }
-        if (code) {
-          process.exit(code);
-        }
+        self.stopSelenium(function() {
+          if (done) {
+            done(o, code);
+          }
+          if (code) {
+            process.exit(code);
+          }
+        });
       });
     });
 

lib/runner/selenium.js

@@ -68,11 +68,11 @@ SeleniumServer.prototype.stop = function(callback) {
   }
   try {
     this.process.kill();
-    callback(true);
+    this.writeLogFile(callback);
   } catch (e) {
     Logger.warn('Selenium process could not be stopped.');
     console.log(e);
-    callback(false);
+    callback();
   }
 };
 
@@ -81,18 +81,27 @@ SeleniumServer.prototype.exitHandler = function (code) {
 };
 
 SeleniumServer.prototype.closeHandler = function() {
+  Logger.info('Selenium process finished.');
+};
+
+SeleniumServer.prototype.writeLogFile = function(callback) {
+  if (this.settings.selenium.log_path === false) {
+    callback();
+    return;
+  }
+
   if (typeof this.settings.selenium.log_path == 'undefined') {
     this.settings.selenium.log_path = '';
   }
 
-  if (this.settings.selenium.log_path !== false) {
-    fs.writeFile(path.join(this.settings.selenium.log_path, DEFAULT_LOG_FILE), this.output, 'utf8', function(err) {
-      if (err) {
-        console.log(Logger.colors.light_red('\nError writing log file to:'), err.path);
-      }
-    });
-  }
-  Logger.info('Selenium process finished.');
+  var filePath = path.resolve(path.join(this.settings.selenium.log_path, DEFAULT_LOG_FILE));
+
+  fs.writeFile(filePath, this.output, function(err) {
+    if (err) {
+      console.log(Logger.colors.light_red('\nError writing log file to:'), err.path);
+    }
+    callback();
+  });
 };
 
 SeleniumServer.prototype.onError = function(err) {
@@ -143,7 +152,7 @@ module.exports = new (function() {
 
     if (!server) {
       console.log('Selenium server is not running.');
-      callback(false);
+      callback();
       return;
     }
 

lib/runner/testsuite.js

@@ -130,8 +130,8 @@ TestSuite.prototype.initAfterEachHook = function() {
       asyncArgsCount = 2;
     }
     asyncFn = Utils.makeFnAsync(asyncArgsCount, hookFn, module);
-    return self.makePromise(function(done) {
-      var doneFn = self.adaptDoneCallback(done, 'afterEach');
+    return self.makePromise(function(done, deferred) {
+      var doneFn = self.adaptDoneCallback(done, 'afterEach', deferred);
       if (expectedArgs < 2) {
         // user has only supplied the done callback argument (pre v0.6 behaviour), e.g.:
         // afterEach : function(done) { ... }
@@ -298,8 +298,8 @@ TestSuite.prototype.globalAfterEach = function() {
 };
 
 TestSuite.prototype.adaptGlobalHook = function(hookName) {
-  return this.makePromise(function(done) {
-    var doneFn = this.adaptDoneCallback(done, 'global ' + hookName);
+  return this.makePromise(function(done, deffered) {
+    var doneFn = this.adaptDoneCallback(done, 'global ' + hookName, deffered);
     var argsCount, expectedCount = 1;
     if (Utils.checkFunction(hookName, this.options.globals)) {
       argsCount = this.options.globals[hookName].length;
@@ -318,10 +318,14 @@ TestSuite.prototype.adaptGlobalHook = function(hookName) {
   });
 };
 
-TestSuite.prototype.adaptDoneCallback = function(done, hookName) {
+TestSuite.prototype.adaptDoneCallback = function(done, hookName, deferred) {
   var timeout = setTimeout(function() {
-    throw new Error('done() callback timeout was reached while executing '+ hookName + '.' +
-    ' Make sure to call the done() callback when the operation finishes.');
+    try {
+      throw new Error('done() callback timeout was reached while executing '+ hookName + '.' +
+        ' Make sure to call the done() callback when the operation finishes.');
+    } catch (err) {
+      deferred.reject(err);
+    }
   }, ASYNC_HOOK_TIMEOUT);
 
   return function() {
@@ -338,7 +342,7 @@ TestSuite.prototype.makePromise = function (fn) {
   try {
     fn.call(this, function() {
       deferred.resolve();
-    });
+    }, deferred);
   } catch (e) {
     deferred.reject(e);
   }