Merge branch 'master' into fix-security-vulnerability-in-local-nodejs-repo

Author: ss3681755

README.md

@@ -45,6 +45,7 @@ To enable verbose logging -
 ```js
 bs_local_args = { 'key': '<browserstack-accesskey>', 'verbose': 'true' }
 ```
+Note - Possible values for 'verbose' modifier are '1', '2', '3' and 'true'
 
 #### Folder Testing
 To test local folder rather internal server, provide path to folder as value of this option -
@@ -82,6 +83,27 @@ To use a proxy for local testing -
 bs_local_args = { 'key': '<browserstack-accesskey>', 'proxyHost': '127.0.0.1', 'proxyPort': '8000', 'proxyUser': 'user', 'proxyPass': 'password' }
 ```
 
+#### Local Proxy
+To use local proxy in local testing -
+
+* localProxyHost: Hostname/IP of proxy, remaining proxy options are ignored if this option is absent
+* localProxyPort: Port for the proxy, defaults to 8081 when -localProxyHost is used
+* localProxyUser: Username for connecting to proxy (Basic Auth Only)
+* localProxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified
+
+```
+bs_local_args = { 'key': '<browserstack-accesskey>', 'localProxyHost': '127.0.0.1', 'localProxyPort': '8000', 'localProxyUser': 'user', 'localProxyPass': 'password' }
+```
+
+#### PAC (Proxy Auto-Configuration)
+To use PAC (Proxy Auto-Configuration) in local testing -
+
+* pac-file: PAC (Proxy Auto-Configuration) file’s absolute path
+
+```
+bs_local_args = { 'key': '<browserstack-accesskey>', 'pac-file': '<pac_file_abs_path>' }
+```
+
 #### Local Identifier
 If doing simultaneous multiple local testing connections, set this uniquely for different processes -
 ```js

index.d.ts

@@ -0,0 +1,27 @@
+declare module 'browserstack-local' {
+  interface Options {
+    key: string
+    verbose: boolean
+    force: boolean
+    only: string
+    onlyAutomate: boolean
+    forceLocal: boolean
+    localIdentifier: string
+    folder: string
+    proxyHost: string
+    proxyPort: string
+    proxyUser: string
+    proxyPass: string
+    forceProxy: boolean
+    logFile: string
+    parallelRuns: string
+    binarypath: string
+    [key: string]: string | boolean
+  }
+
+  class Local {
+    start(options: Partial<Options>, callback: () => void): void
+    isRunning(): boolean
+    stop(callback: () => void): void
+  }
+}

lib/Local.js

@@ -1,4 +1,5 @@
 var childProcess = require('child_process'),
+  os = require('os'),
   fs = require('fs'),
   path = require('path'),
   running = require('is-running'),
@@ -7,11 +8,17 @@ var childProcess = require('child_process'),
   psTree = require('ps-tree');
 
 function Local(){
+  this.sanitizePath = function(rawPath) {
+    var doubleQuoteIfRequired = this.windows && !rawPath.match(/"[^"]+"/) ? '"' : '';
+    return doubleQuoteIfRequired + rawPath + doubleQuoteIfRequired;
+  };
+
+  this.windows = os.platform().match(/mswin|msys|mingw|cygwin|bccwin|wince|emc|win32/i);
   this.pid = undefined;
   this.isProcessRunning = false;
   this.retriesLeft = 5;
   this.key = process.env.BROWSERSTACK_ACCESS_KEY;
-  this.logfile = path.join(process.cwd(), 'local.log');
+  this.logfile = this.sanitizePath(path.join(process.cwd(), 'local.log'));
   this.opcode = 'start';
   this.exitCallback;
 
@@ -124,7 +131,7 @@ function Local(){
       case 'folder':
         if(value){
           this.folderFlag = '-f';
-          this.folderPath = value;
+          this.folderPath = this.sanitizePath(value);
         }
         break;
 
@@ -157,7 +164,7 @@ function Local(){
       case 'logfile':
       case 'logFile':
         if(value)
-          this.logfile = value;
+          this.logfile = this.sanitizePath(value);
         break;
 
       case 'parallelRuns':
@@ -167,7 +174,7 @@ function Local(){
 
       case 'binarypath':
         if(value)
-          this.binaryPath = value;
+          this.binaryPath = this.sanitizePath(value);
         break;
 
       default:

package.json

@@ -1,9 +1,10 @@
 {
   "name": "browserstack-local",
-  "version": "1.3.8",
+  "version": "1.4.23,
   "description": "Nodejs bindings for BrowserStack Local",
   "engine": "^0.10.44",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "pretest": "./node_modules/.bin/eslint lib/* index.js",
     "test": "./node_modules/.bin/mocha"
@@ -20,7 +21,6 @@
     "https-proxy-agent": "^2.2.3",
     "is-running": "^2.0.0",
     "ps-tree": "=1.1.1",
-    "sinon": "^1.17.6",
     "temp-fs": "^0.9.9"
   },
   "devDependencies": {
@@ -29,7 +29,8 @@
     "mocha": "2.4.5",
     "mocks": "0.0.15",
     "proxy": "^0.2.4",
-    "rimraf": "^2.5.4"
+    "rimraf": "^2.5.4",
+    "sinon": "^1.17.6"
   },
   "bugs": "https://github.com/browserstack/browserstack-local-nodejs/issues",
   "homepage": "https://github.com/browserstack/browserstack-local-nodejs",