Merge branch 'master' into pr/6

Author: dhimil

README.md

@@ -27,7 +27,7 @@ If nothing is provided as `preset` **default** is used.
 ### Parameters
 
  - *username*: BrowserStack username
-   (Alternatively: use `BROWSERSTACK_UESRNAME` environment variable)
+   (Alternatively: use `BROWSERSTACK_USERNAME` environment variable)
 
  - *key*: BrowserStack key
    (Alternatively: use `BROWSERSTACK_KEY` environment variable)
@@ -92,6 +92,21 @@ A sample configuration file:
     }
 
 
+### Enviroment variables
+
+* `BROWSERSTACK_USER`:
+BrowserStack user name.
+
+* `BROWSERSTACK_KEY`:
+BrowserStack key.
+
+* `TUNNEL_ID`:
+Identifier for the current instance of the tunnel process. In `TRAVIS` setup `TRAVIS_JOB_ID` will be the default identifier.
+
+* `BROWSERSTACK_JSON`:
+Path to the browserstack.json file. If null, `browserstack.json` in the root directory will be used.
+
+
 ### Secure Information
 
 To prevent checking in the BrowserStack `username` and `key` in your

bin/runner.js

@@ -57,7 +57,7 @@ var cleanUp = function cleanUp () {
 process.on('exit', cleanUp);
 process.on('SIGINT', cleanUp);
 
-console.log("Launching server..");
+console.log("Launching server on port:", serverPort);
 
 var server = new Server(client, workers);
 server.listen(parseInt(serverPort, 10));
@@ -87,6 +87,10 @@ function launchBrowser(browser) {
     browser.build = config.build;
   }
 
+  if(config.tunnelIdentifier) {
+    browser["tunnel_identifier"] = config.tunnelIdentifier;
+  }
+
   client.createWorker(browser, function (err, worker) {
     if (err || typeof worker !== 'object') {
       utils.alertBrowserStack("Failed to launch worker",
@@ -135,7 +139,8 @@ function launchBrowser(browser) {
 }
 
 if (config.browsers && config.browsers.length > 0) {
-  tunnel = new Tunnel(config.key, serverPort, function () {
+  tunnel = new Tunnel(config.key, serverPort, config.tunnelIdentifier, function () {
+    console.log("Launching BrowserStack workers");
     config.browsers.forEach(function(browser) {
       if (browser.browser_version === "latest") {
         console.log("[%s] Finding version.", utils.browserString(browser));

lib/config.js

@@ -2,15 +2,20 @@ var path = require('path'),
     fs = require('fs');
 var pwd = process.cwd();
 
+config_path = process.env.BROWSERSTACK_JSON || 'browserstack.json';
+config_path = path.resolve(path.relative(process.cwd(), config_path));
+console.log("Using config:", config_path);
+
 try {
-  var config = require(process.cwd() + '/browserstack');
+  var config = require(config_path);
 } catch (e) {
   if (e.code == 'MODULE_NOT_FOUND') {
-    console.error('Configuration file `browserstack.json` is missing.');
+    console.log('Configuration file `browserstack.json` is missing.');
   } else {
-    throw(e);
+    console.log('Invalid configuration in `browserstack.json` file');
+    console.log(e.message);
+    console.log(e.stack);
   }
-
   process.exit(1);
 }
 
@@ -61,6 +66,8 @@ if (!fs.existsSync(config.test_path)){
   process.exit(1);
 }
 
+config.tunnelIdentifier = process.env.TUNNEL_ID || process.env.TRAVIS_JOB_ID || process.env.TRAVIS_BUILD_ID;
+
 for (key in config) {
   if (config.hasOwnProperty(key)) {
     exports[key] = config[key];

lib/server.js

@@ -130,6 +130,11 @@ exports.Server = function Server(bsClient, workers) {
       status += query.failed;
 
       if (worker) {
+        bsClient.takeScreenshot(worker.id,function(error,screenshot){
+          if(!error && screenshot.url){
+              console.log('[%s] Screenshot: %s', worker.string, screenshot.url);           
+          }
+
         bsClient.terminateWorker(worker.id, function () {
           if (!workers[uuid]) {
             return;
@@ -150,6 +155,7 @@ exports.Server = function Server(bsClient, workers) {
             process.exit(status);
           }
         });
+      });
       }
 
       response.end();

lib/tunnel.js

@@ -1,28 +1,32 @@
 var exec = require('child_process').exec,
     fs = require('fs'),
     http = require('http'),
-    tunnelJar = '/tmp/BrowserStackTunnel.jar',
-    utils = require('./utils');
+    tunnelJar = __dirname + '/BrowserStackTunnel.jar',
+    utils = require('./utils'),
+    config = require('./config');
 
-var Tunnel = function Tunnel (key, port, callback, err) {
+var Tunnel = function Tunnel (key, port, tunnelIdentifier, callback, err) {
   var that = {};
 
   function tunnelLauncher () {
     var tunnelCommand = 'java -jar ' + tunnelJar + ' ';
+    if (config.debug)
+      tunnelCommand += ' -v ';
     tunnelCommand += key + ' ';
     tunnelCommand += 'localhost' + ',';
     tunnelCommand += port.toString() + ',';
     tunnelCommand += '0';
-    tunnelCommand += ' -force -onlyAutomate';
+    tunnelCommand += (typeof tunnelIdentifier === 'undefined')? ' -force -onlyAutomate' : ' -tunnelIdentifier ' + tunnelIdentifier;
 
     if (typeof callback !== 'function') {
       callback = function () {};
     }
 
-    console.log("Launching tunnel..");
+    console.log("Launching tunnel");
     var subProcess = exec(tunnelCommand, function (error, stdout, stderr) {
+      console.error(stderr);
       if (stdout.indexOf('Error') >= 0) {
-        console.log("..Failed");
+        console.log("Tunnel launching failed");
         console.log(stdout);
         process.exit(1);
       }
@@ -48,7 +52,7 @@ var Tunnel = function Tunnel (key, port, callback, err) {
 
       if (data.indexOf(runMatcher) >= 0) {
         running = true;
-        console.log("..Done");
+        console.log("Tunnel launched");
         callback();
       }
     });
@@ -58,22 +62,21 @@ var Tunnel = function Tunnel (key, port, callback, err) {
 
   fs.exists(tunnelJar, function (exists) {
     if (exists) {
-      tunnelLauncher();
-    } else {
-      console.log('Downloading tunnel to `%s`', tunnelJar);
+      fs.unlinkSync(tunnelJar);
+    }
+    console.log('Downloading tunnel jar to `%s`', tunnelJar);
 
-      var file = fs.createWriteStream(tunnelJar);
-      var request = http.get(
-        "http://www.browserstack.com/BrowserStackTunnel.jar",
-        function(response) {
-          response.pipe(file);
+    var file = fs.createWriteStream(tunnelJar);
+    var request = http.get(
+      "http://www.browserstack.com/BrowserStackTunnel.jar",
+      function(response) {
+        response.pipe(file);
 
-          response.on('end', function () {
-            tunnelLauncher();
-          });
-        }
-      );
-    }
+        response.on('end', function () {
+          tunnelLauncher();
+        });
+      }
+    );
   });
 
   return that;

package.json

@@ -1,14 +1,14 @@
 {
   "name": "browserstack-runner",
   "description": "A command line interface to run browser tests over BrowserStack",
-  "version": "0.0.11",
+  "version": "0.0.15",
   "homepage": "https://github.com/browserstack/browserstack-runner",
   "repository": {
     "type": "git",
     "url": "git://github.com/browserstack/browserstack-runner.git"
   },
   "dependencies": {
-    "browserstack": "git://github.com/browserstack/node-browserstack.git"
+    "browserstack": "1.0.1"
   },
   "bin": {
     "browserstack-runner": "bin/cli.js"