improve parsing of arguments

Author: delabiejochen

README.md

@@ -1,6 +1,5 @@
 # testingbot-tunnel-launcher
 
-[![Greenkeeper badge](https://badges.greenkeeper.io/testingbot/testingbot-tunnel-launcher.svg)](https://greenkeeper.io/)
 [![npm](https://img.shields.io/npm/v/testingbot-tunnel-launcher.svg?maxAge=2592000)](https://www.npmjs.com/package/testingbot-tunnel-launcher)
 [![dependencies Status](https://david-dm.org/testingbot/testingbot-tunnel-launcher/status.svg)](https://david-dm.org/testingbot/testingbot-tunnel-launcher)
 [![devDependencies Status](https://david-dm.org/testingbot/testingbot-tunnel-launcher/dev-status.svg)](https://david-dm.org/testingbot/testingbot-tunnel-launcher?type=dev)
@@ -71,7 +70,10 @@ var testingbotTunnel = require('testingbot-tunnel-launcher'),
     logfile: null,
 
     // Change the tunnel version - see versions on https://testingbot.com/support/other/tunnel
-    tunnelVersion: "1.19" // or 2.1 (Java 8)
+    tunnelVersion: "1.19", // or 2.1 (Java 8)
+
+    // Gives this tunnel a unique identifier
+    tunnelIdentifier: "myIdentifier"
   };
 
 testingbotTunnel(options, function(err, tunnel) {
@@ -98,6 +100,10 @@ npm test
 
 ## Changelog
 
+### v1.1.11
+- Add support for `tunnelIdentifier`
+- Improve parsing of arguments passed to the tunnel
+
 ### v1.1.11
 - Throw error when user does not have any minutes left
 

lib/tunnel-launcher.js

@@ -52,27 +52,16 @@ function downloadTunnel (url, tunnelLocation, callback) {
     })
 }
 
-function run (options, callback) {
-    if (!fs.existsSync(tunnelLocation)) {
-        return callback(new Error(`Tunnel jar file is not present in ${tunnelLocation}`))
-    }
-
-    const checkJava = spawn('java')
-    checkJava.on('error', err => {
-        return callback(new Error(`Java might not be installed, necessary to use testingbot-tunnel ${err.message}`))
-    })
-
-    const onReady = function () {
-        started = true
-        logger('Tunnel is ready')
-        callback(null, activeTunnel)
-    }
-
+function createArgs (options) {
     const args = []
 
     args.push('-jar')
     args.push(tunnelLocation)
 
+    const optionMapping = {
+        'tunnelIdentifier': 'tunnel-identifier'
+    }
+
     if (options.apiKey) {
         args.push(options.apiKey)
     }
@@ -86,25 +75,36 @@ function run (options, callback) {
             continue
         }
 
-        if (options[option]) {
-            args.push(`--${option}`)
+        const optionName = optionMapping[option] || option
+
+        if (options[option] && typeof (options[option]) === 'string') {
+            args.push(`--${optionName}`)
             args.push(options[option])
-        } else {
-            args.push(`--${option}`)
+        } else if (options[option]) {
+            args.push(`--${optionName}`)
         }
     }
 
-    const readyFile = path.join(os.tmpdir(), 'testingbot.ready')
-    try {
-        if (fs.statSync(readyFile).isFile()) {
-            logger('Tunnel Readyfile already exists, removing')
-            fs.unlinkSync(readyFile)
-        }
-    } catch (ignore) {}
+    return args
+}
 
-    args.push(`-f`)
-    args.push(readyFile)
+function run (options, callback) {
+    if (!fs.existsSync(tunnelLocation)) {
+        return callback(new Error(`Tunnel jar file is not present in ${tunnelLocation}`))
+    }
+
+    const checkJava = spawn('java')
+    checkJava.on('error', err => {
+        return callback(new Error(`Java might not be installed, necessary to use testingbot-tunnel ${err.message}`))
+    })
+
+    const onReady = function () {
+        started = true
+        logger('Tunnel is ready')
+        callback(null, activeTunnel)
+    }
 
+    const readyFile = path.join(os.tmpdir(), 'testingbot.ready')
     const readyFileChecker = setInterval(() => {
         fs.stat(readyFile, (error, stat) => {
             if (!error) {
@@ -114,6 +114,18 @@ function run (options, callback) {
         })
     }, 800)
 
+    const args = createArgs(options)
+
+    try {
+        if (fs.statSync(readyFile).isFile()) {
+            logger('Tunnel Readyfile already exists, removing')
+            fs.unlinkSync(readyFile)
+        }
+    } catch (ignore) {}
+
+    args.push(`-f`)
+    args.push(readyFile)
+
     if (options.verbose) {
         logger('Starting tunnel with options', args)
     }
@@ -199,3 +211,4 @@ function downloadAndRun (options, callback) {
 
 module.exports = downloadAndRun
 module.exports.kill = killTunnel
+module.exports.createArgs = createArgs

test/tunnel-launcher_test.js

@@ -27,4 +27,16 @@ describe('Tunnel Launcher', function() {
 		});
 	});
 
+	it('should correctly parse arguments', function(done) {
+		const args = tunnelLauncher.createArgs({ apiKey: 'fake', apiSecret: 'fake', tunnelIdentifier: 'my-tunnel' });
+		assert(args.indexOf('--tunnel-identifier') > -1);
+		assert(args.indexOf('my-tunnel') > -1);
+
+		const args2 = tunnelLauncher.createArgs({ apiKey: 'fake', apiSecret: 'fake', debug: true });
+		assert(args2.indexOf('--debug') > -1);
+
+		const args3 = tunnelLauncher.createArgs({ apiKey: 'fake', apiSecret: 'fake', debug: null });
+		assert.equal(args3.indexOf('--debug'), -1);
+		done();
+	});
 });