Ported CLI from commander to yargs because yargs suits our large CLI better and is easier to develop with. Split commands into separate files since the file was getting annoyingly long.

lib/cli/provider/index.js

@@ -0,0 +1,192 @@
+module.exports.command = 'provider [serial..]'
+
+module.exports.describe = 'Start a provider unit.'
+
+module.exports.builder = function(yargs) {
+  var os = require('os')
+  var ip = require('my-local-ip')
+
+  return yargs
+    .strict()
+    .env('STF_PROVIDER')
+    .option('adb-host', {
+      describe: 'The ADB server host.'
+    , type: 'string'
+    , default: '127.0.0.1'
+    })
+    .option('adb-port', {
+      describe: 'The ADB server port.'
+    , type: 'number'
+    , default: 5037
+    })
+    .option('allow-remote', {
+      alias: 'R'
+    , describe: 'Whether to allow remote devices in STF. Highly ' +
+        'unrecommended due to almost unbelievable slowness on the ADB side ' +
+        'and duplicate device issues when used locally while having a ' +
+        'cable connected at the same time.'
+    , type: 'boolean'
+    })
+    .option('boot-complete-timeout', {
+      describe: 'How long to wait for boot to complete during device setup.'
+    , type: 'number'
+    , default: 60000
+    })
+    .option('cleanup', {
+      describe: 'Attempt to reset the device between uses by uninstalling' +
+        'apps, resetting accounts and clearing caches. Does not do a perfect ' +
+        'job currently. Negate with --no-cleanup.'
+    , type: 'boolean'
+    , default: true
+    })
+    .option('connect-push', {
+      alias: 'p'
+    , describe: 'Device-side ZeroMQ PULL endpoint to connect to.'
+    , array: true
+    , demand: true
+    })
+    .option('connect-sub', {
+      alias: 's'
+    , describe: 'Device-side ZeroMQ PUB endpoint to connect to.'
+    , array: true
+    , demand: true
+    })
+    .option('connect-url-pattern', {
+      describe: 'The URL pattern to use for `adb connect`.'
+    , type: 'string'
+    , default: '${publicIp}:${publicPort}'
+    })
+    .option('group-timeout', {
+      alias: 't'
+    , describe: 'Timeout in seconds for automatic release of inactive devices.'
+    , type: 'number'
+    , default: 900
+    })
+    .option('heartbeat-interval', {
+      describe: 'Send interval in milliseconds for heartbeat messages.'
+    , type: 'number'
+    , default: 10000
+    })
+    .option('lock-rotation', {
+      describe: 'Whether to lock rotation when devices are being used. ' +
+        'Otherwise changing device orientation may not always work due to ' +
+        'sensitive sensors quickly or immediately reverting it back to the ' +
+        'physical orientation.'
+    , type: 'boolean'
+    })
+    .option('max-port', {
+      describe: 'Highest port number for device workers to use.'
+    , type: 'number'
+    , default: 7700
+    })
+    .option('min-port', {
+      describe: 'Lowest port number for device workers to use.'
+    , type: 'number'
+    , default: 7400
+    })
+    .option('mute-master', {
+      describe: 'Whether to mute master volume when devices are being used.'
+    , type: 'boolean'
+    })
+    .option('name', {
+      alias: 'n'
+    , describe: 'An easily identifiable name for the UI and/or log output.'
+    , type: 'string'
+    , default: os.hostname()
+    })
+    .option('public-ip', {
+      describe: 'The IP or hostname to use in URLs.'
+    , type: 'string'
+    , default: ip()
+    })
+    .option('screen-jpeg-quality', {
+      describe: 'The JPG quality to use for the screen.'
+    , type: 'number'
+    , default: process.env.SCREEN_JPEG_QUALITY || 80
+    })
+    .option('screen-ws-url-pattern', {
+      describe: 'The URL pattern to use for the screen WebSocket.'
+    , type: 'string'
+    , default: 'ws://${publicIp}:${publicPort}'
+    })
+    .option('storage-url', {
+      alias: 'r'
+    , describe: 'The URL to the storage unit.'
+    , type: 'string'
+    , demand: true
+    })
+    .option('vnc-initial-size', {
+      describe: 'The initial size to use for the experimental VNC server.'
+    , type: 'string'
+    , default: '600x800'
+    , coerce: function(val) {
+        return val.split('x').map(Number)
+      }
+    })
+    .epilog('Each option can be be overwritten with an environment variable ' +
+      'by converting the option to uppercase, replacing dashes with ' +
+      'underscores and prefixing it with `STF_PROVIDER_` (e.g. ' +
+      '`STF_PROVIDER_NAME`).')
+}
+
+module.exports.handler = function(argv) {
+  var path = require('path')
+  var cli = path.resolve(__dirname, '..')
+
+  function range(from, to) {
+    var items = []
+    for (var i = from; i <= to; ++i) {
+      items.push(i)
+    }
+    return items
+  }
+
+  return require('../../units/provider')({
+    name: argv.name
+  , killTimeout: 10000
+  , ports: range(argv.minPort, argv.maxPort)
+  , filter: function(device) {
+      return argv.serial.length === 0 || argv.serial.indexOf(device.id) !== -1
+    }
+  , allowRemote: argv.allowRemote
+  , fork: function(device, ports) {
+      var fork = require('child_process').fork
+
+      var args = [
+        'device', device.id
+      , '--provider', argv.name
+      , '--screen-port', ports.shift()
+      , '--connect-port', ports.shift()
+      , '--vnc-port', ports.shift()
+      , '--public-ip', argv.publicIp
+      , '--group-timeout', argv.groupTimeout
+      , '--storage-url', argv.storageUrl
+      , '--adb-host', argv.adbHost
+      , '--adb-port', argv.adbPort
+      , '--screen-ws-url-pattern', argv.screenWsUrlPattern
+      , '--screen-jpeg-quality', argv.screenJpegQuality
+      , '--connect-url-pattern', argv.connectUrlPattern
+      , '--heartbeat-interval', argv.heartbeatInterval
+      , '--boot-complete-timeout', argv.bootCompleteTimeout
+      , '--vnc-initial-size', argv.vncInitialSize.join('x')
+      ]
+      .concat(argv.connectSub.reduce(function(all, val) {
+        return all.concat(['--connect-sub', val])
+      }, []))
+      .concat(argv.connectPush.reduce(function(all, val) {
+        return all.concat(['--connect-push', val])
+      }, []))
+      .concat(argv.muteMaster ? ['--mute-master'] : [])
+      .concat(argv.lockRotation ? ['--lock-rotation'] : [])
+      .concat(!argv.cleanup ? ['--no-cleanup'] : [])
+
+      return fork(cli, args)
+    }
+  , endpoints: {
+      sub: argv.connectSub
+    , push: argv.connectPush
+    }
+  , adbHost: argv.adbHost
+  , adbPort: argv.adbPort
+  })
+}