feat: establish the ssh tunnel automatically

Author: vojtajina

README.md

@@ -56,6 +56,7 @@ module.exports = function(config) {
 ### Global options
 - `username` your BS username (email), you can also use `BROWSER_STACK_USERNAME` env variable.
 - `accessKey` your BS access key (password), you can also use `BROWSER_STACK_ACCESS_KEY` env variable.
+- `startTunnel` do you wanna establish the BrowserStack tunnel ? (defaults to `true`)
 
 
 ### Per browser options

index.js

@@ -1,4 +1,49 @@
+var q = require('q');
 var api = require('browserstack');
+var BrowserStackTunnel = require('browserstacktunnel-wrapper');
+
+
+var createBrowserStackTunnel = function(logger, config, emitter) {
+  var log = logger.create('launcher.browserstack');
+  var bsConfig = config.browserStack;
+
+  if (bsConfig.startTunnel === false) {
+    return q();
+  }
+
+  log.debug('Establishing the tunnel on %s:%s', config.hostname, config.port);
+
+  var deferred = q.defer();
+  var tunnel = new BrowserStackTunnel({
+    key: process.env.BROWSER_STACK_ACCESS_KEY || bsConfig.accessKey,
+    hosts: [{
+      name: config.hostname,
+      port: config.port,
+      sslFlag: 0
+    }]
+  });
+
+  tunnel.start(function(error) {
+    if (error) {
+      log.error('Can not establish the tunnel.');
+      deferred.reject(error);
+    } else {
+      log.debug('Tunnel established.')
+      deferred.resolve();
+    }
+  });
+
+  emitter.on('exit', function(done) {
+    log.debug('Shutting down the tunnel.');
+    tunnel.stop(function(error) {
+      done();
+    });
+  });
+
+  return deferred.promise;
+};
+
+
 
 var createBrowserStackClient = function(/* config.browserStack */ config) {
   var env = process.env;
@@ -20,7 +65,9 @@ var formatError = function(error) {
 };
 
 
-var BrowserStackBrowser = function(id, emitter, /* browserStackClient */ client, args, logger) {
+var BrowserStackBrowser = function(id, emitter, args, logger,
+    /* browserStackTunnel */ tunnel, /* browserStackClient */ client) {
+
   var self = this;
   var workerId = null;
   var captured = false;
@@ -40,14 +87,18 @@ var BrowserStackBrowser = function(id, emitter, /* browserStackClient */ client,
       url: url + '?id=' + id
     };
 
-    client.createWorker(settings, function(error, worker) {
-      if (error) {
-        log.error('Can not start %s\n  %s', browserName, formatError(error));
-        return emitter.emit('browser_process_failure', self);
-      }
-
-      log.debug('Browser %s started with id %s', browserName, worker.id);
-      workerId = worker.id;
+    tunnel.then(function() {
+      client.createWorker(settings, function(error, worker) {
+        if (error) {
+          log.error('Can not start %s\n  %s', browserName, formatError(error));
+          return emitter.emit('browser_process_failure', self);
+        }
+
+        log.debug('Browser %s started with id %s', browserName, worker.id);
+        workerId = worker.id;
+      });
+    }, function() {
+        emitter.emit('browser_process_failure', self);
     });
   };
 
@@ -77,6 +128,7 @@ var BrowserStackBrowser = function(id, emitter, /* browserStackClient */ client,
 
 // PUBLISH DI MODULE
 module.exports = {
+  'browserStackTunnel': ['factory', createBrowserStackTunnel],
   'browserStackClient': ['factory', createBrowserStackClient],
   'launcher:BrowserStack': ['type', BrowserStackBrowser]
 };

package.json

@@ -18,7 +18,9 @@
   ],
   "author": "Vojta Jina <vojta.jina@gmail.com>",
   "dependencies": {
-    "browserstack": "~0.2.0"
+    "browserstack": "~0.2.0",
+    "browserstacktunnel-wrapper": "~1.0.1",
+    "q": "~0.9.6"
   },
   "peerDependencies": {
     "karma": ">=0.9"