Readme and follow logfile and binaryPath

Author: vedharish

README.md

@@ -0,0 +1,48 @@
+# browserstack-local-nodejs
+
+## Setup
+
+```
+npm install browserstack
+```
+
+## API
+
+### Constructor
+
+* `new BrowserStack::Local`: creates an instance of Local
+
+### Methods
+
+* `start(options, callback)`: starts Local instance with options. The options available are detailed below.
+* `stop(callback)`: stops the Local instance
+* `isRunning()`: checks if Local instance is running and returns a corresponding boolean value
+
+The first and only argument to any callback function will be an error object.
+
+### Options
+
+* `key`: BrowserStack Access Key
+* `v`: Provides verbose logging
+* `f`: If you want to test local folder rather internal server, provide path to folder as value of this option
+* `force`: Kill other running Browserstack Local
+* `only`: Restricts Local Testing access to specified local servers and/or folders
+* `forcelocal`: Route all traffic via local machine
+* `onlyAutomate`: Disable Live Testing and Screenshots, just test Automate
+* `proxyHost`: Hostname/IP of proxy, remaining proxy options are ignored if this option is absent
+* `proxyPort`: Port for the proxy, defaults to 3128 when -proxyHost is used
+* `proxyUser`: Username for connecting to proxy (Basic Auth Only)
+* `proxyPass`: Password for USERNAME, will be ignored if USERNAME is empty or not specified
+* `localIdentifier`: If doing simultaneous multiple local testing connections, set this uniquely for different processes
+* `hosts`: List of hosts and ports where Local must be enabled for eg. localhost,3000,1,localhost,3001,0
+* `logfile`: Path to file where Local logs be saved to
+* `binaryPath`: Optional path to Local binary
+
+
+## Tests
+
+To run the test suite run - `npm test`.
+
+## Example
+
+To run the example run - `node node-example.js`.

lib/ZipBinary.js

@@ -1,6 +1,7 @@
 var https = require('https'),
   unzip = require('unzip'),
-  fs = require('fs');
+  fs = require('fs'),
+  path = require('path');
 
 function ZipBinary(helper) {
   var log = helper.log;
@@ -13,34 +14,44 @@ function ZipBinary(helper) {
     platform = 'win32';
     arch = null;
   }
+  const binaryName = 'BrowserStackLocal' + (platform === 'win32' ? '.exe' : '');
 
   this.args = [];
 
-  var ensurePath = function () {
+  var ensurePath = function (shouldFail) {
+    var checkPath = '';
     try {
-      fs.accessSync(helper.getBasePath(), fs.R_OK | fs.W_OK);
+      checkPath = path.join(helper.getBinaryPath(), '..');
+      fs.accessSync(checkPath, fs.R_OK | fs.W_OK);
     } catch(error) {
-      log.warn('Cannot read/write to ' + helper.getBasePath());
+      log.warn('Cannot read/write to ' + checkPath);
       helper.fallbackBase();
       return ensurePath();
     }
 
     try {
-      fs.accessSync(helper.getBinaryPath(), fs.F_OK);
+      checkPath = helper.getBinaryPath();
+      fs.accessSync(checkPath, fs.F_OK);
     } catch(error) {
-      log.warn('Binary file is not present at ' + helper.getBinaryPath());
-      return true;
+      if (shouldFail) {
+        log.warn('Download failed to ' + checkPath);
+        helper.fallbackBase();
+        return ensurePath();
+      } else {
+        log.warn('Binary file is not present at ' + checkPath);
+        return true;
+      }
     }
 
     try {
-      fs.accessSync(helper.getBinaryPath(), fs.R_OK | fs.W_OK | fs.X_OK);
+      fs.accessSync(checkPath, fs.R_OK | fs.W_OK | fs.X_OK);
     } catch(error) {
       try {
-        log.warn('Adding execute permissions to ' + helper.getBinaryPath());
-        fs.chmodSync(helper.getBinaryPath(), '0755');
-        fs.accessSync(helper.getBinaryPath(), fs.X_OK);
+        log.warn('Adding execute permissions to ' + checkPath);
+        fs.chmodSync(checkPath, '0755');
+        fs.accessSync(checkPath, fs.X_OK);
       } catch(error) {
-        log.warn('Cannot add execute permissions to ' + helper.getBasePath());
+        log.warn('Cannot add execute permissions to ' + checkPath);
         helper.fallbackBase();
         return ensurePath();
       }
@@ -49,16 +60,23 @@ function ZipBinary(helper) {
     return false;
   };
 
-  this.update = function (callback) {
-    if(ensurePath()) {
+  this.update = function (callback, shouldFail) {
+    var self = this;
+    var binaryPath = helper.getBinaryPath();
+    var binaryDir = path.join(binaryPath, '..');
+    if(ensurePath(shouldFail)) {
       var extractStream = unzip.Extract({
-        path: helper.getBasePath()
+        path: binaryDir
       });
       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(helper.getBinaryPath(), '0755', callback);
+          fs.rename(path.join(binaryDir, binaryName), binaryPath, function() {
+            fs.chmod(binaryPath, '0755', function() {
+              self.update.apply(self, [ callback, true ]);
+            });
+          });
         });
         response.pipe(extractStream);
       });

lib/browserStackTunnel.js

@@ -1,4 +1,5 @@
 var childProcess = require('child_process'),
+  fs = require('fs'),
   ZipBinary = require('./ZipBinary'),
   Helper = require('./helper'),
   Tail = require('tail').Tail;
@@ -7,8 +8,11 @@ function BrowserStackTunnel(options) {
   var helper = new Helper.helper();
   var log = helper.log;
 
-  if (options.path) {
-    helper.setBasePath(options.path);
+  if (options.binaryPath) {
+    helper.setBinaryPath(options.binaryPath);
+  }
+  if (options.logfile) {
+    helper.setLogFilePath(options.logfile);
   }
 
   var params = [],
@@ -47,6 +51,10 @@ function BrowserStackTunnel(options) {
     params.push('-vvv');
   }
 
+  if (options.f) {
+    options.folder = options.f;
+  }
+
   if (options.force) {
     params.push('-force');
   }
@@ -55,6 +63,10 @@ function BrowserStackTunnel(options) {
     params.push('-forcelocal');
   }
 
+  if (options.only) {
+    params.push('-only');
+  }
+
   if (options.onlyAutomate) {
     params.push('-onlyAutomate');
   }
@@ -155,14 +167,29 @@ function BrowserStackTunnel(options) {
     var logFilePath = helper.getLogFilePath();
     params.push('-logFile', logFilePath);
 
+    // Ensure log file is present
+    fs.open(logFilePath, 'wx', function() {});
+
     log.info('Local Binary is located at ' + binaryPath);
-    log.info('Local started with args: ' + JSON.stringify(params));
+    log.info('Log file is located at ' + logFilePath);
 
-    this.tail = new Tail(logFilePath);
+    try {
+      this.tail = new Tail(logFilePath);
+    } catch(e) {
+      throw new Error('Cannot access log file path - ' + logFilePath);
+    }
     this.tail.on('line', this.updateState.bind(this));
     this.tail.on('error', this.updateState.bind(this));
 
-    this.tunnel = childProcess.spawn(binaryPath, binary.args.concat([options.key]).concat(params));
+    var binaryArguments = '';
+    if (options.folder) {
+      binaryArguments = binary.args.concat(['-f', options.key, options.folder]).concat(params);
+    } else {
+      binaryArguments = binary.args.concat([options.key]).concat(params);
+    }
+    log.info('Local started with args: ' + JSON.stringify(binaryArguments).replace(options.key, '<access_key>'));
+    this.tunnel = childProcess.spawn(binaryPath, binaryArguments);
+    this.tunnel.stdout.on('data', this.updateState.bind(this));
     this.tunnel.stderr.on('data', this.updateState.bind(this));
     this.tunnel.on('error', this.killTunnel.bind(this));
     this.tunnel.on('exit', this.exit.bind(this));
@@ -176,6 +203,9 @@ function BrowserStackTunnel(options) {
       try {
         self._startTunnel();
       } catch(e) {
+        if (e.message.toLowerCase().match(/cannot access log file path/)) {
+          throw new Error('Cannot Access log file path. Please check write permissions.');
+        }
         log.warn('The downloaded binary might be corrupt. Retrying download');
         binary.update(function () {
           self._startTunnel();

lib/helper.js

@@ -25,17 +25,32 @@ function helper() {
   const localBinaryName = 'BrowserStackLocal' + ( this.getPlatform() === 'win32' ? '.exe' : '' );
   const logFileName = 'local.log';
 
+  if(process.env.NODE_ENV === 'testing') {
+    log.level = 'silent';
+  }
+  this.log = log;
+
+  var logFilePath = null;
+  var binaryPath = null;
+
   this.getBinaryPath = function() {
+    if (binaryPath) {
+      return binaryPath;
+    }
     return path.resolve(path.join(basePath, localBinaryName));
   };
-  this.setBasePath = function(path) {
+  this.setBinaryPath = function(path) {
     currentBaseIndex = -1;
-    basePath = path;
+    binaryPath = path;
+  };
+  this.setLogFilePath = function(path) {
+    logFilePath = path;
   };
   this.getBasePath = function() {
     return basePath;
   };
   this.fallbackBase = function() {
+    binaryPath = null;
     currentBaseIndex += 1;
     if (basePaths.length <= currentBaseIndex) {
       var pathString = (this.getPlatform() === 'win32') ? 'C:\\Users\\Admin\\Desktop' : '/Users/user/home/';
@@ -44,14 +59,11 @@ function helper() {
     basePath = basePaths[currentBaseIndex];
     log.warn('Falling Back to ' + basePath);
   };
-
-  if(process.env.NODE_ENV === 'testing') {
-    log.level = 'silent';
-  }
-  this.log = log;
-
   this.getLogFilePath = function() {
-    return path.resolve(path.join(basePath, logFileName));
+    if (logFilePath) {
+      return logFilePath;
+    }
+    return path.resolve(path.join(basePaths[1], logFileName));
   };
 }
 

node-example.js

@@ -19,7 +19,9 @@ var options = {
   //  port: 8080,
   //  sslFlag: 0
   //}],
-  path: 'var',
+  //f: __dirname,
+  binaryPath: '/var/BrowserStackLocal',
+  logfile: '/var/log/local.log',
   localIdentifier: identifier,
   verbose: true,
   //proxyUser: '',