Merge branch 'master' into proxy_support

Author: dhimil

bin/cli.js

@@ -5,6 +5,11 @@ if (process.argv[2] == '--verbose')
 else
   global.logLevel = "info";
 
+if (process.argv[2] == 'init') {
+  require('./init.js');
+  return;
+}
+
 var Log = require('../lib/logger'),
     logger = new Log(global.logLevel),
     BrowserStack = require('browserstack'),
@@ -26,30 +31,47 @@ var Log = require('../lib/logger'),
     tunnelingAgent,
     tunnel;
 
-function cleanUp(signal) {
-  try {
-    server.close();
-  } catch (e) {
-    logger.debug("Server already closed");
-  }
-
-  logger.info("Exiting");
-
-  for (var key in workers) {
-    var worker = workers[key];
-    if (workers.hasOwnProperty(key)) {
-      client.terminateWorker(worker.id, function () {
-        if (!workers[key]) {
-          return;
-        }
-
+function terminateAllWorkers(callback) {
+  var cleanWorker = function(id, key) {
+    client.terminateWorker(id, function() {
+      var worker = workers[key];
+      if(worker) {
         logger.debug('[%s] Terminated', worker.string);
         clearTimeout(worker.activityTimeout);
+        clearTimeout(worker.testActivityTimeout);
         delete workers[key];
         delete workerKeys[worker.id];
-      });
+      }
+      if (utils.objectSize(workers) === 0) {
+        callback();
+      }
+    });
+  };
+
+  if (utils.objectSize(workers) === 0) {
+    callback();
+  } else {
+    for (var key in workers){
+      var worker = workers[key];
+      if (worker.id) {
+        cleanWorker(worker.id, key);
+      } else {
+        delete workers[key];
+        if (utils.objectSize(workers) === 0) {
+          callback();
+        }
+      }
     }
   }
+};
+
+function cleanUpAndExit(signal, status) {
+  try {
+    server.close();
+  } catch (e) {
+    logger.debug("Server already closed");
+  }
+
   if (statusPoller) statusPoller.stop();
 
   try {
@@ -62,9 +84,24 @@ function cleanUp(signal) {
   } catch (e) {
     logger.debug("Non existent pid file.");
   }
-  if (signal) {
-    process.kill(process.pid, 'SIGTERM');
+
+  if (signal == 'SIGTERM') {
+    logger.info("Exiting");
+    process.exit(status);
+  } else {
+    terminateAllWorkers(function() {
+      logger.info("Exiting");
+      process.exit(1);
+    });
+  }
+}
+
+function getTestBrowserInfo(browserString, path) {
+  var info = browserString;
+  if(config.multipleTest) {
+    info += ", " + path;
   }
+  return info;
 }
 
 function launchServer() {
@@ -74,9 +111,10 @@ function launchServer() {
   server.listen(parseInt(serverPort, 10));
 }
 
-function launchBrowser(browser, url) {
+function launchBrowser(browser, path) {
+  var url = 'http://localhost:' + serverPort.toString() + '/' + path;
   var browserString = utils.browserString(browser);
-  logger.debug("[%s] Launching", browserString);
+  logger.debug("[%s] Launching", getTestBrowserInfo(browserString, path));
 
   var key = utils.uuid();
 
@@ -121,6 +159,7 @@ function launchBrowser(browser, url) {
 
     worker.config = browser;
     worker.string = browserString;
+    worker.test_path = path;
     workers[key] = worker;
     workerKeys[worker.id] = {key: key, marked: false};
   });
@@ -130,13 +169,13 @@ function launchBrowser(browser, url) {
 function launchBrowsers(config, browser) {
   setTimeout(function () {
     if(Object.prototype.toString.call(config.test_path) === '[object Array]'){
+      config.multipleTest = config.test_path.length > 1? true : false;
       config.test_path.forEach(function(path){
-        var url = 'http://localhost:' + serverPort.toString() + '/' + path;
-        launchBrowser(browser,url);
+        launchBrowser(browser, path);
       });
     } else {
-      var url = 'http://localhost:' + serverPort.toString() + '/' + config.test_path;
-      launchBrowser(browser,url);
+      config.multipleTest = false;
+      launchBrowser(browser, config.test_path);
     }
   }, 100);
 }
@@ -160,7 +199,7 @@ var statusPoller = {
 
           if (_worker.status === 'running') {
             //clearInterval(statusPoller);
-            logger.debug('[%s] Launched', worker.string);
+            logger.debug('[%s] Launched', getTestBrowserInfo(worker.string, worker.test_path));
             worker.launched = true;
             workerData.marked = true;
 
@@ -180,12 +219,12 @@ var statusPoller = {
                     config.status = 1;
                   }
 
-                  process.exit(config.status);
+                  process.kill(process.pid, 'SIGTERM');
                 }
               }
             }, activityTimeout * 1000);
 
-            setTimeout(function () {
+            worker.testActivityTimeout = setTimeout(function () {
               if (worker.acknowledged) {
                 var subject = "Tests timed out on: " + worker.string;
                 var content = "Worker details:\n" + JSON.stringify(worker.config, null, 4);
@@ -201,7 +240,7 @@ var statusPoller = {
                     config.status = 1;
                   }
 
-                  process.exit(config.status);
+                  process.kill(process.pid, 'SIGTERM');
                 }
               }
             }, (activityTimeout * 1000));
@@ -232,7 +271,8 @@ function runTests() {
       launchServer();
       tunnel = new Tunnel(config.key, serverPort, config.tunnelIdentifier, function () {
         statusPoller.start();
-        logger.info("Launching " + browsers.length + " workers");
+        var total_workers = config.browsers.length * (Object.prototype.toString.call(config.test_path) === '[object Array]' ? config.test_path.length : 1);
+        logger.info("Launching " + total_workers + " workers");
         browsers.forEach(function(browser) {
           if (browser.browser_version === "latest") {
             logger.debug("[%s] Finding version.", utils.browserString(browser));
@@ -254,21 +294,16 @@ function runTests() {
 }
 
 try {
-  if (process.argv[2] == 'init') {
-    require('./init.js');
-  } else {
-    var client = BrowserStack.createClient({
-      username: config.username,
-      password: config.key
-    });
-    runTests();
-    var pid_file = process.cwd() + '/browserstack-run.pid';
-    fs.writeFileSync(pid_file, process.pid, 'utf-8')
-    process.on('exit', function() {cleanUp(false)});
-    process.on('SIGINT', function() {cleanUp(true)});
-  }
+  var client = BrowserStack.createClient({
+    username: config.username,
+    password: config.key
+  });
+  runTests();
+  var pid_file = process.cwd() + '/browserstack-run.pid';
+  fs.writeFileSync(pid_file, process.pid, 'utf-8')
+  process.on('SIGINT', function() { cleanUpAndExit('SIGINT', 1) });
+  process.on('SIGTERM', function() { cleanUpAndExit('SIGTERM', config.status) });
 } catch (e) {
   console.log(e);
   console.log('Invalid command.');
 }
-

lib/local.js

@@ -30,9 +30,9 @@ var Tunnel = function Tunnel(key, port, uniqueIdentifier, callback, err) {
       logger.debug(stderr);
       logger.debug(error);
       if (stdout.indexOf('Error') >= 0 || error) {
-        logger.info("[%s] Tunnel launching failed", new Date());
-        logger.info(stdout);
-        process.exit(1);
+        logger.debug("[%s] Tunnel launching failed", new Date());
+        logger.debug(stdout);
+        process.kill(process.pid, 'SIGINT');
       }
     });
 
@@ -98,7 +98,7 @@ var Tunnel = function Tunnel(key, port, uniqueIdentifier, callback, err) {
         }, 100);
       }).on('error', function(e) {
         logger.info("Got error while downloading binary: " + e.message);
-        process.exit(1);
+        process.kill(process.pid, 'SIGINT');
       });
     });
   });

lib/server.js

@@ -20,6 +20,14 @@ var mimeTypes = {
   "css": "text/css"
 };
 
+function getTestBrowserInfo(worker) {
+  var info = worker.string;
+  if(config.multipleTest) {
+    info += ", " + worker.test_path
+  }
+  return info;
+}
+
 
 exports.Server = function Server(bsClient, workers) {
 
@@ -28,8 +36,9 @@ exports.Server = function Server(bsClient, workers) {
     var query = url_parts.query;
 
     if (query._worker_key && workers[query._worker_key]) {
-      workers[query._worker_key].acknowledged = true;
-      logger.debug("[%s] Acknowledged", query._browser_string);
+      worker = workers[query._worker_key] || {};
+      worker.acknowledged = true;
+      logger.debug("[%s] Acknowledged", getTestBrowserInfo(worker));
     }
 
     fs.exists(filename, function(exists) {
@@ -136,7 +145,7 @@ exports.Server = function Server(bsClient, workers) {
   handlers = {
     "_progress": function progressHandler(uri, body, request, response) {
       var uuid = request.headers['x-worker-uuid'];
-      var worker = workers[uuid];
+      var worker = workers[uuid] || {};
       query = "";
       try {
         query = parseBody(body);
@@ -147,7 +156,7 @@ exports.Server = function Server(bsClient, workers) {
 
       if (query.tracebacks) {
         query.tracebacks.forEach(function(traceback) {
-          logger.info(chalk.red("[%s] Error:"), worker.string, formatTraceback(traceback));
+          logger.info(chalk.red("[%s] Error:"), getTestBrowserInfo(worker), formatTraceback(traceback));
         });
       }
       response.end();
@@ -159,36 +168,37 @@ exports.Server = function Server(bsClient, workers) {
         query = parseBody(body);
       } catch (e) {}
       var uuid = request.headers['x-worker-uuid'];
-      var worker = workers[uuid];
+      var worker = workers[uuid] || {};
 
       if (query === null) {
         logger.info("[%s] Null response from remote Browser", request.headers['x-browser-string']);
       } else {
         if (query.tracebacks && query.tracebacks.length > 0) {
-          logger.info("Tracebacks:");
+          logger.info(chalk["red"]("[%s] Tracebacks:"), getTestBrowserInfo(worker));
           query.tracebacks.forEach(function(traceback) {
             logger.info(traceback);
           });
         }
         var color = query.failed ? "red" : "green";
-        logger.info(chalk[color]("[%s] Completed in %d milliseconds. %d of %d passed, %d failed."), request.headers['x-browser-string'], query.runtime, query.passed, query.total, query.failed);
+        logger.info(chalk[color]("[%s] Completed in %d milliseconds. %d of %d passed, %d failed."), getTestBrowserInfo(worker), query.runtime, query.passed, query.total, query.failed);
         config.status += query.failed;
       }
 
       if (worker) {
         bsClient.takeScreenshot(worker.id, function(error, screenshot) {
           if (!error && screenshot.url) {
-            logger.info('[%s] ' + chalk['yellow']('Screenshot') + ': %s', worker.string, screenshot.url);
+            logger.info('[%s] ' + chalk['yellow']('Screenshot') + ': %s', getTestBrowserInfo(worker), screenshot.url);
           }
 
           bsClient.terminateWorker(worker.id, function() {
             if (!workers[uuid]) {
               return;
             }
 
-            logger.debug('[%s] Terminated', worker.string);
+            logger.debug('[%s] Terminated', getTestBrowserInfo(worker));
 
             clearTimeout(workers[uuid].activityTimeout);
+            clearTimeout(workers[uuid].testActivityTimeout);
             delete workers[uuid];
 
             if (utils.objectSize(workers) === 0) {
@@ -199,7 +209,7 @@ exports.Server = function Server(bsClient, workers) {
                 config.status = 1;
               }
 
-              process.exit(config.status);
+              process.kill(process.pid, 'SIGTERM');
             }
           });
         });

lib/utils.js

@@ -26,7 +26,7 @@ var uuid = function uuidGenerator() {
 };
 
 var browserString = function browserString(config) {
-  return config.os + ' ' + config.os_version + ', ' + titleCase(config.browser || config.device) + ' ' + (config.browser_version || config.device);
+  return config.os + ' ' + config.os_version + ', ' + (config.browser == 'ie' ? 'IE' : titleCase(config.browser || config.device)) + ' ' + (config.browser_version || config.device);
 };
 
 var objectSize = function objectSize(obj) {
@@ -49,7 +49,7 @@ var alertBrowserStack = function alertBrowserStack(subject, content, params, fn)
     if (typeof params === 'function') {
     } else {
       fn = function() {
-        process.exit(1);
+        process.kill(process.pid, 'SIGINT');
       };
     }
   }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "browserstack-runner",
   "description": "A command line interface to run browser tests over BrowserStack",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "homepage": "https://github.com/browserstack/browserstack-runner",
   "repository": {
     "type": "git",