Log to a file

Tests pending

Author: vedharish

lib/ZipBinary.js

@@ -1,25 +1,22 @@
-var path = require('path'),
-  https = require('https'),
+var https = require('https'),
   unzip = require('unzip'),
   fs = require('fs'),
-  log = require('./helper').log;
+  helper = require('./helper'),
+  log = helper.log;
 
-function ZipBinary(platform, arch, bin, ext) {
-  var self = this;
-  self.bin = (typeof(bin) == 'undefined' || bin == null || !bin.trim()) ? path.resolve(path.join(__dirname, '..', 'bin', arch ? path.join(platform, arch) : platform)) : bin;
-  self.path = path.resolve(path.join(self.bin, 'BrowserStackLocal' + (ext ? '.' + ext : '')));
-  self.command = self.path;
-  self.args = [];
+function ZipBinary(platform, arch) {
+  this.command = helper.getBinaryPath();
+  this.args = [];
 
-  self.update = function (callback) {
+  this.update = function (callback) {
     var extractStream = unzip.Extract({
-      path: self.bin
+      path: helper.getBasePath()
     });
     https.get('https://www.browserstack.com/browserstack-local/BrowserStackLocal-' + platform + (arch ? '-' + arch : '') + '.zip', function (response) {
       log.info('Downloading binary for ' + platform + (arch ? '-' + arch : '') + ' ...');
       extractStream.on('close', function () {
         log.info('Download complete');
-        fs.chmod(self.path, '0755', callback);
+        fs.chmod(helper.getBinaryPath(), '0755', callback);
       });
       response.pipe(extractStream);
     });

lib/browserStackTunnel.js

@@ -1,10 +1,14 @@
 var fs = require('fs'),
   childProcess = require('child_process'),
-  os = require('os'),
   ZipBinary = require('./ZipBinary'),
-  log = require('./helper').log;
+  helper = require('./helper'),
+  log = helper.log;
 
 function BrowserStackTunnel(options) {
+  if (options.path) {
+    helper.setBasePath(options.path);
+  }
+
   var params = [],
     startCallback = null,
     stopCallback = null,
@@ -20,22 +24,22 @@ function BrowserStackTunnel(options) {
     };
 
   var binary;
-  switch (os.platform()) {
+  switch (helper.getPlatform()) {
   case 'linux':
-    switch (os.arch()) {
+    switch (helper.getArch()) {
     case 'x64':
-      binary = new ZipBinary('linux', 'x64', options.path);
+      binary = new ZipBinary('linux', 'x64');
       break;
     case 'ia32':
-      binary = new ZipBinary('linux', 'ia32', options.path);
+      binary = new ZipBinary('linux', 'ia32');
       break;
     }
     break;
   case 'darwin':
-    binary = new ZipBinary('darwin', 'x64', options.path);
+    binary = new ZipBinary('darwin', 'x64');
     break;
   default:
-    binary = new ZipBinary('win32', null, options.path, 'exe');
+    binary = new ZipBinary('win32', null);
     break;
   }
 
@@ -51,7 +55,7 @@ function BrowserStackTunnel(options) {
   }
 
   if (options.verbose) {
-    params.push('-v');
+    params.push('-vvv');
   }
 
   if (options.force) {
@@ -96,6 +100,7 @@ function BrowserStackTunnel(options) {
   };
 
   this.updateState = function (data) {
+    helper.logBinaryOutput(data.toString());
     var state;
     this.stdoutData += data.toString();
     for (state in this.stateMatchers) {
@@ -163,7 +168,7 @@ function BrowserStackTunnel(options) {
 
   this.startTunnel = function () {
     var self = this;
-    if (!fs.existsSync(binary.path)) {
+    if (!fs.existsSync(helper.getBinaryPath())) {
       log.warn('Binary not present');
       binary.update(function () {
         self._startTunnel();

lib/helper.js

@@ -1,6 +1,52 @@
-var log = require('npmlog');
+var fs = require('fs'),
+  path = require('path'),
+  log = require('npmlog'),
+  os = require('os');
+
+const osHomedir = require('os-homedir');
+var basePath = osHomedir(),
+  appendLogs = true;
+
+exports.getPlatform = function() {
+  return os.platform();
+};
+exports.gerArch = function() {
+  return os.arch();
+};
+
+const localBinaryName = 'BrowserStackLocal' + ( exports.getPlatform() === 'win32' ? '.exe' : '' );
+const zipName = 'BrowserStackLocal.zip';
+const logFileName = 'local.log';
+
+exports.getBinaryPath = function() {
+  return path.resolve(path.join(basePath, localBinaryName));
+};
+exports.getZipPath = function() {
+  return path.resolve(path.join(basePath, zipName));
+};
+exports.setBasePath = function(path) {
+  basePath = path;
+};
+exports.getBasePath = function() {
+  return basePath;
+};
+
 if(process.env.NODE_ENV === 'testing') {
   log.level = 'silent';
+  appendLogs = false;
 }
-
 exports.log = log;
+
+var getLogFilePath = function() {
+  return path.resolve(path.join(basePath, logFileName));
+};
+exports.logBinaryOutput = function(log) {
+  if(appendLogs) {
+    fs.appendFile(getLogFilePath(), log, function (err) {
+      if(err) {
+        exports.log.warn('Error Ssaving log file to ' + getLogFilePath());
+        appendLogs = false;
+      }
+    });
+  }
+};

node-example.js

@@ -19,7 +19,7 @@ var options = {
   //  port: 8080,
   //  sslFlag: 0
   //}],
-  //path: 'bin',
+  path: 'bin',
   localIdentifier: identifier,
   verbose: true,
   //proxyUser: '',
@@ -34,11 +34,12 @@ var options = {
 local.start(options, function(error) {
   console.log('Is Running ' + local.isRunning());
   console.log('Started');
-  console.log('Is Running ' + local.isRunning());
+
   capabilities['browserstack.user'] = process.env.BROWSERSTACK_USERNAME;
-  console.log('Is Running ' + local.isRunning());
-  capabilities['browserstack.key'] = process.env.BROWSERSTACK_ACCESS_KEY
-    console.log('Is Running ' + local.isRunning());
+  capabilities['browserstack.key'] = process.env.BROWSERSTACK_ACCESS_KEY;
+  capabilities['browserstack.local'] = true;
+  capabilities['browserstack.localIdentifier'] = identifier;
+
   driver = new webdriver.Builder().usingServer('http://hub.browserstack.com/wd/hub').withCapabilities(capabilities).build();
   console.log('Is Running ' + local.isRunning());
   driver.get("http://localhost:3000").then(function() {

package.json

@@ -16,6 +16,7 @@
   "license": "MIT",
   "dependencies": {
     "npmlog": "2.0.2",
+    "os-homedir": "^1.0.1",
     "unzip": "0.1.11"
   },
   "devDependencies": {