Merge branch 'master' into qunitlogging

Author: nakula

README.md

@@ -38,6 +38,8 @@ If nothing is provided as `preset` **default** is used.
  - *test_framework*: Specify test framework which will execute the tests.
     We support qunit, jasmine and mocha.
 
+ - *timeout*: Specify worker timeout with BrowserStack.
+
  - *browsers*: A list of browsers on which tests are to be run.
 
 A sample configuration file:

bin/runner.js

@@ -5,7 +5,7 @@ var BrowserStack = require('browserstack'),
     utils = require('../lib/utils');
     Server = require('../lib/server').Server;
     config = require('../lib/config');
-    Tunnel = require('../lib/tunnel').Tunnel;
+    Tunnel = require('../lib/local').Tunnel;
 
 var serverPort = 8888;
 var tunnel;
@@ -88,6 +88,14 @@ function launchBrowser(browser, url) {
     browser["tunnel_identifier"] = config.tunnelIdentifier;
   }
 
+  var timeout = parseInt(config.timeout);
+  if(! isNaN(timeout)) {
+    browser.timeout = timeout;
+  } else {
+    timeout = 300;
+  }
+  var activityTimeout = timeout - 10;
+
   client.createWorker(browser, function (err, worker) {
     if (err || typeof worker !== 'object') {
       console.log("Error from BrowserStack: ", err);
@@ -117,19 +125,28 @@ function launchBrowser(browser, url) {
           worker.activityTimeout = setTimeout(function () {
             if (!worker.acknowledged) {
               var subject = "Worker inactive for too long: " + worker.string;
-              var content = "Worker details:\n" + JSON.stringify(worker, null, 4);
-
-              utils.alertBrowserStack(subject, content);
+              var content = "Worker details:\n" + JSON.stringify(worker.config, null, 4);
+              client.takeScreenshot(worker.id, function(error, screenshot) {
+                if (!error && screenshot.url) {
+                  console.log('[%s] Screenshot: %s', worker.string, screenshot.url);
+                }
+                utils.alertBrowserStack(subject, content);
+              });
             }
-          }, 60 * 1000);
+          }, activityTimeout * 1000);
 
           setTimeout(function () {
             if (workers[key]) {
               var subject = "Tests timed out on: " + worker.string;
-              var content = "Worker details:\n" + JSON.stringify(worker, null, 4);
-              utils.alertBrowserStack(subject, content);
+              var content = "Worker details:\n" + JSON.stringify(worker.config, null, 4);
+              client.takeScreenshot(worker.id, function(error, screenshot) {
+                if (!error && screenshot.url) {
+                  console.log('[%s] Screenshot: %s', worker.string, screenshot.url);
+                }
+                utils.alertBrowserStack(subject, content);
+              });
             }
-          }, (config.timeout || 300) * 1000);
+          }, (activityTimeout * 1000));
         }
       });
     }, 2000);
@@ -145,7 +162,7 @@ var launchBrowsers = function(config, browser) {
       });
     } else {
       var url = 'http://localhost:' + serverPort.toString() + '/' + config.test_path;
-      launchBrowser(browser,url);              
+      launchBrowser(browser,url);
     }
   }, 100);
 }

lib/tunnel.js renamed to lib/local.js

@@ -1,32 +1,34 @@
 var exec = require('child_process').exec,
     fs = require('fs'),
     http = require('http'),
-    tunnelJar = __dirname + '/BrowserStackTunnel.jar',
+    windows = (process.platform.match(/win/) != null),
+    localBinary = __dirname + (windows ? '/BrowserStackTunnel.jar' : '/BrowserStackLocal'),
     utils = require('./utils'),
     config = require('./config');
 
-var Tunnel = function Tunnel (key, port, tunnelIdentifier, callback, err) {
+var Tunnel = function Tunnel (key, port, uniqueIdentifier, callback, err) {
   var that = {};
 
   function tunnelLauncher () {
-    var tunnelCommand = 'java -jar ' + tunnelJar + ' ';
+    var tunnelCommand = (windows ? 'java -jar ' : '') + localBinary + ' ';
     if (config.debug)
       tunnelCommand += ' -v ';
     tunnelCommand += key + ' ';
     tunnelCommand += 'localhost' + ',';
     tunnelCommand += port.toString() + ',';
     tunnelCommand += '0';
-    tunnelCommand += (typeof tunnelIdentifier === 'undefined')? ' -force -onlyAutomate' : ' -tunnelIdentifier ' + tunnelIdentifier;
+    tunnelCommand += (typeof uniqueIdentifier === 'undefined')? ' -force -onlyAutomate' : ' -tunnelIdentifier ' + uniqueIdentifier;
 
     if (typeof callback !== 'function') {
       callback = function () {};
     }
 
-    console.log("Launching tunnel");
+    console.log("[%s] Launching tunnel", new Date());
     var subProcess = exec(tunnelCommand, function (error, stdout, stderr) {
       console.log(stderr);
+      console.log(error);
       if (stdout.indexOf('Error') >= 0) {
-        console.log("Tunnel launching failed");
+        console.log("[%s] Tunnel launching failed", new Date());
         console.log(stdout);
         process.exit(1);
       }
@@ -38,8 +40,7 @@ var Tunnel = function Tunnel (key, port, tunnelIdentifier, callback, err) {
 
     setTimeout(function () {
       if (!running) {
-        utils.alertBrowserStack("Tunnel launch timeout",
-                                'Stdout:\n' + data);
+        utils.alertBrowserStack("Tunnel launch timeout", 'Stdout:\n' + data);
       }
     }, 30 * 1000);
 
@@ -52,28 +53,31 @@ var Tunnel = function Tunnel (key, port, tunnelIdentifier, callback, err) {
 
       if (data.indexOf(runMatcher) >= 0) {
         running = true;
-        console.log("Tunnel launched");
+        console.log("[%s] Tunnel launched", new Date());
         callback();
       }
     });
 
     that.process = subProcess;
   }
 
-  fs.exists(tunnelJar, function (exists) {
+  fs.exists(localBinary, function (exists) {
     if (exists) {
-      fs.unlinkSync(tunnelJar);
+      fs.unlinkSync(localBinary);
+      // tunnelLauncher();
+      // return;
     }
-    console.log('Downloading tunnel jar to `%s`', tunnelJar);
+    console.log('Downloading BrowserStack Local to `%s`', localBinary);
 
-    var file = fs.createWriteStream(tunnelJar);
+    var file = fs.createWriteStream(localBinary);
     var request = http.get(
-      "http://www.browserstack.com/BrowserStackTunnel.jar",
+      (windows ? "http://www.browserstack.com/BrowserStackTunnel.jar" : ("http://s3.amazonaws.com/browserStack/browserstack-local/BrowserStackLocal-" + process.platform + "-" + process.arch)),
       function(response) {
         response.pipe(file);
 
         response.on('end', function () {
-          tunnelLauncher();
+          fs.chmodSync(localBinary, 0700);
+          setTimeout(function() {tunnelLauncher();}, 100);
         });
       }
     );

lib/server.js

@@ -138,30 +138,30 @@ exports.Server = function Server(bsClient, workers) {
       if (worker) {
         bsClient.takeScreenshot(worker.id,function(error,screenshot){
           if(!error && screenshot.url){
-              console.log('[%s] Screenshot: %s', worker.string, screenshot.url);           
+            console.log('[%s] Screenshot: %s', worker.string, screenshot.url);
           }
 
-        bsClient.terminateWorker(worker.id, function () {
-          if (!workers[uuid]) {
-            return;
-          }
+          bsClient.terminateWorker(worker.id, function () {
+            if (!workers[uuid]) {
+              return;
+            }
 
-          console.log('[%s] Terminated', worker.string);
+            console.log('[%s] Terminated', worker.string);
 
-          clearTimeout(workers[uuid].activityTimeout);
-          delete workers[uuid];
+            clearTimeout(workers[uuid].activityTimeout);
+            delete workers[uuid];
 
-          if (utils.objectSize(workers) === 0) {
-            console.log("All tests done, failures: %d.", status);
+            if (utils.objectSize(workers) === 0) {
+              console.log("All tests done, failures: %d.", status);
 
-            if (status > 0) {
-              status = 1;
-            }
+              if (status > 0) {
+                status = 1;
+              }
 
-            process.exit(status);
-          }
+              process.exit(status);
+            }
+          });
         });
-      });
       }
 
       response.end();

lib/utils.js

@@ -35,7 +35,7 @@ var alertBrowserStack = function alertBrowserStack (subject, content, params, fn
   var urlObject = url.parse(endpoint);
 
   var context = config.alert_context || "Runner alert";
-  console.log("[%s] %s", context, subject);
+  console.log("[%s] [%s] %s", new Date(), context, subject);
 
   if (typeof fn !== 'function') {
     if (typeof params === 'function') {

package.json

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