@corellium/corellium-cli 1.0.3 → 1.0.6

package/src/commands/instances/upgrade.js

@@ -0,0 +1,90 @@
+const log = require('../../logging')
+const InstanceCLI = require('./Instance')
+const { getErrorMessage } = require('../../error')
+const { waitForState, waitForIntervalMilliSec } = require('../../utils')
+
+const waitForMinutes = 15
+
+async function builder (yargs) {
+  yargs
+    .positional('instanceId', {
+      type: 'string',
+      describe: 'Instance id',
+      demandOption: true
+    })
+    .positional('os', {
+      type: 'string',
+      describe: 'Operating system semantic version (example: \'16.1\' or \'16.1.4\'',
+      demandOption: true
+    })
+    .option('osbuild', {
+      type: 'string',
+      describe: 'Use a specific build (example: \'16H20\')',
+      demandOption: false
+    })
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+      demandOption: false
+    })
+    .option('format', {
+      type: 'input',
+      describe: 'Output format (default is table) e.g. json',
+      string: true,
+      choices: ['json', 'csv'],
+      demandOption: false
+    })
+    .option('wait', {
+      type: 'boolean',
+      describe: 'Wait for the instance to be ready',
+      demandOption: false
+    })
+}
+
+async function handler (argv) {
+  try {
+    const { os, osbuild } = argv
+    const instance = new InstanceCLI(argv)
+    await instance.upgrade({ os, osbuild })
+    if (argv.wait) {
+      const reporter = argv.verbose
+        ? (info) => {
+            if (argv.verbose) {
+              let restoreStatus = ''
+              if (info.restoreStatus && info.restoreStatus.stage) {
+                restoreStatus = ` -> ${info.restoreStatus.stage}` + (info.restoreStatus.progress ? `(${parseInt(info.restoreStatus.progress)}%)` : '')
+              }
+              const report = ` - ${info.state}${restoreStatus}`
+              if (lastReport !== report) {
+                log.info(report)
+              }
+              lastReport = report
+            }
+          }
+        : () => { /* nop */ }
+      let lastReport = ''
+      // First wait up to 10 seconds for the update to begin
+      let attempts = 10000 / waitForIntervalMilliSec
+      await waitForState(argv.instance, instance.info.bind(instance), 'updating', attempts)
+      // Then wait up to "waitForMinutes" for the instance to upgrade its OS version or error out
+      // Using on-prem cluster ci-1, the upgrade from iOS 16.0 to 16.1 has been taking about 8-1/2 minutes
+      // 180 * 5 seconds = 15 minutes
+      log.info(`Waiting up to ${waitForMinutes} minutes for upgrade to complete...`)
+      attempts = (waitForMinutes * 60 * 1000) / waitForIntervalMilliSec
+      await waitForState(argv.instance, instance.info.bind(instance), 'on', attempts, reporter)
+    }
+    log.info(`Successfully upgraded instance ${argv.instanceId} to ${os}`)
+  } catch (err) {
+    const errorMessage = getErrorMessage(err)
+    log.error(`Upgrade iOS version failed: ${errorMessage}`)
+    if (argv.detailedErrors) { log.error(err) }
+  }
+}
+
+module.exports = {
+  builder,
+  handler,
+  command: 'upgrade <instanceId> <os> [--osbuild <buildid>] [--wait] [--format <\'json\' | \'csv\'>] [--verbose]',
+  describe: 'Upgrade iOS version for instance'
+}

package/src/commands/login.js

@@ -10,9 +10,11 @@ const {
 } = require('../utils')
 const https = require('https')
 const axios = require('axios').default
+const prompts = require('prompts')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('endpoint', {
@@ -44,7 +46,17 @@ async function builder (yargs) {
 }
 
 async function handler (argv) {
-  const { username, password, apitoken, endpoint } = argv
+  const { username, apitoken, endpoint } = argv
+  let { password } = argv
+
+  if (username && !password) {
+    password = (await prompts({
+      message: 'Enter your password',
+      name: 'password',
+      type: 'text',
+      style: 'invisible'
+    })).password
+  }
 
   // We need a special agent just for login because we can't assume profile has been written yet
   const CACert = await getCACert({ endpoint })

package/src/commands/logout.js

@@ -2,7 +2,8 @@ const asciiArt = require('ascii-art')
 const { deleteProfile } = require('../profile')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   })

package/src/commands/projects/create.js

@@ -3,7 +3,8 @@ const { displayTable } = require('../../table')
 const { getAxios } = require('../../utils')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   })

package/src/commands/projects/delete.js

@@ -7,7 +7,8 @@ async function builder (yargs) {
     type: 'string',
     describe: 'Project ID',
     demandOption: true
-  }).option('detailed-errors', {
+  }).option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   })

package/src/commands/projects/list.js

@@ -3,7 +3,8 @@ const { displayTable } = require('../../table')
 const { getApi } = require('../../utils')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('format', {

package/src/commands/signup.js

@@ -1,5 +1,7 @@
-const TrialAccount = require('../subscriberInvite')
+const TrialAccount = require('../TrialAccount')
 const { makePassword, validateNonEmpty } = require('../utils')
+const { getErrorMessage } = require('../error')
+const log = require('../logging')
 
 async function builder (yargs) {
   yargs.options({
@@ -86,10 +88,17 @@ async function builder (yargs) {
 }
 
 async function handler (argv) {
-  const trialAccount = new TrialAccount(argv)
-
-  const credentials = await trialAccount.setupTrialUser()
-  console.log(credentials)
+  try {
+    const trialAccount = new TrialAccount(argv)
+    const credentials = await trialAccount.setupTrialUser()
+    console.log(credentials)
+  } catch (err) {
+    const errorMessage = getErrorMessage(err)
+    log.error(`Create subscriber invite account: ${errorMessage}`)
+    if (argv.detailedErrors) {
+      log.error(err)
+    }
+  }
 }
 
 module.exports = {

package/src/commands/webplayer/WebPlayer.js

@@ -21,6 +21,7 @@ class WebPlayer extends Client {
    */
   createSession = async () => this._fetch('POST', 'v1/webplayer', {
     projectId: this.project,
+    instanceId: this.instance,
     features: this.features,
     permissions: this.permissions ? this.permissions : null,
     expiresIn: this.expiresIn
@@ -45,7 +46,7 @@ class WebPlayer extends Client {
   /**
    * Log into WebPlayer session by activating WebPlayer credentials
    * @param {string} sessionId
-   * @returns {Promise<Corellium>}
+   * @returns {Promise<void>}
    */
   login = async (sessionId) => {
     const { token, expiration } = (await this.listSessions()).filter(s => s.identifier === sessionId).shift()

package/src/commands/webplayer/create.js

@@ -5,7 +5,8 @@ const { validateNonEmpty } = require('../../utils')
 const { getErrorMessage } = require('../../error')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('project', {
@@ -14,6 +15,12 @@ async function builder (yargs) {
     demandOption: true,
     string: true,
     validateNonEmpty
+  }).option('instance', {
+    type: 'input',
+    describe: 'Instance ID',
+    demandOption: true,
+    string: true,
+    validateNonEmpty
   }).option('features', {
     type: 'input',
     describe: 'Enabled Feature Set',

package/src/commands/webplayer/destroy.js

@@ -4,7 +4,8 @@ const { validateNonEmpty } = require('../../utils')
 const { getErrorMessage } = require('../../error')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('project', {

package/src/commands/webplayer/list.js

@@ -5,7 +5,8 @@ const { validateNonEmpty } = require('../../utils')
 const { getErrorMessage } = require('../../error')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('project', {
@@ -31,23 +32,24 @@ async function handler (argv) {
   try {
     const webplayer = new WebPlayer(argv)
     const result = await webplayer.listSessions(argv.session)
-    if (result) {
-      const sessions = (await webplayer.listSessions()).map(s => {
-        const {
-          identifier,
-          token,
-          expiration,
-          features
-        } = s
-        return {
-          identifier,
-          token,
-          expiration,
-          features
-        }
-      })
-      await displayTable(argv.format, sessions, ['identifier', 'token', 'expiration', 'features'])
+    if (!result.length && argv.format !== 'json') {
+      console.error('Found no matching Webplayer sessions')
     }
+    const sessions = (await webplayer.listSessions(argv.session)).map(s => {
+      const {
+        identifier,
+        token,
+        expiration,
+        features
+      } = s
+      return {
+        identifier,
+        token,
+        expiration,
+        features
+      }
+    })
+    await displayTable(argv.format, sessions, ['identifier', 'token', 'expiration', 'features'])
   } catch (err) {
     const errorMessage = getErrorMessage(err)
     log.error(`List sessions failed: ${errorMessage}`)

package/src/commands/webplayer/login.js

@@ -4,7 +4,8 @@ const { validateNonEmpty } = require('../../utils')
 const { getErrorMessage } = require('../../error')
 
 async function builder (yargs) {
-  yargs.option('detailed-errors', {
+  yargs.option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   }).option('project', {

package/src/error.js

@@ -1,7 +1,20 @@
 
+function getUserErrorMessage (body) {
+  const keys = ['errorID', 'error']
+  if (body && body.errorID === 'UserError') {
+    const err = Object.keys(body)
+      .filter(key => !keys.includes(key))
+      .reduce((obj, key) => {
+        obj[key] = body[key]
+        return obj
+      }, {})
+    return JSON.stringify(err)
+  }
+  return ''
+}
 function getErrorMessage (error) {
   return (error.body && error.body.error)
-    ? error.body.error
+    ? `${error.body.error} ${getUserErrorMessage(error.body)}`
     : (error.error && error.error.message)
         ? error.error.message
         : error

package/src/logging.js

@@ -21,7 +21,7 @@ const log = {
     args[0] = '\r' + args[0]
     args.unshift(asciiArt.style('', ERROR_COLOR))
     args.push(asciiArt.style('', ERROR_COLOR, true))
-    console.log.bind(console, ...args)()
+    console.error.bind(console, ...args)()
   }
 }
 

package/src/profile.js

@@ -11,19 +11,22 @@ const profilePath = profileDir + path.sep + 'profile.json'
 const trialPath = profileDir + path.sep + 'trial.json'
 
 async function updateProfile (options) {
+  const currentProfile = {}
   try {
-    // Load existing
-    const currentProfile = require(profilePath)
-    // Write any new options, updating existing keys
-    await fsp.writeFile(profilePath, JSON.stringify({ ...currentProfile, ...options }))
-  } catch (e) {
-    if (e.code === 'MODULE_NOT_FOUND') {
-      // require failed, make the new folder and file
+    // Load existing profile
+    Object.assign(currentProfile, JSON.parse(await fsp.readFile(profilePath, { encoding: 'utf8' })))
+  } catch (err) {
+    if (err instanceof SyntaxError || err.code === 'ENOENT') {
+      // reading json profile failed, make the new folder and file
       await fsp.mkdir(profileDir, { recursive: true })
-      await fsp.writeFile(profilePath, JSON.stringify(options))
+    } else {
+      // rethrow unhandled exceptions
+      throw err
     }
-    throw e // rethrow
   }
+
+  // Write any new options, updating existing keys
+  await fsp.writeFile(profilePath, JSON.stringify({ ...currentProfile, ...options }))
 }
 
 function writeTrialConfig (config) {