@corellium/corellium-cli 1.0.3 → 1.0.6

package/README.md

@@ -5,9 +5,13 @@ Corellium CLI is a command line interface for Corellium's API. It allows you to
 ## Installation
 
 ```bash
-npm install -g @corellium/cli
+npm install -g @corellium/corellium-cli
 ```
 
+## Usage
+
+[Read the documentation](https://support.corellium.com/cli)
+
 ## Development
 
 1. Clone the repo
@@ -15,19 +19,3 @@ npm install -g @corellium/cli
 3. Link with `npm link`
 
 *Note*: if you are running it locally create `.env` file and put the following line there `NODE_TLS_REJECT_UNAUTHORIZED=0`
-
-## Example
-
-```bash
-# Enter your details here first
-$projectId="....."
-$apiToken="......"
-
-# Let there be virtual
-corellium login --apitoken $apiToken --endpoint https://app.corellium.com
-instanceId=$(corellium instance create iphone6 12.5.6 $projectId true)
-corellium agent apps --project $projectId --instance $instanceId
-corellium agent files --project $projectId --instance $instanceId
-corellium instance stop $instanceId true
-corellium instance delete $instanceId
-```

package/docs/OVERVIEW.md

@@ -41,7 +41,7 @@ corellium logout
 ## What's included
 
 ```text
-> correlium-cli
+> corellium
 Usage: corellium [OPTIONS]
 
 Commands:

package/jenkinsbuild/build.sh

@@ -39,7 +39,7 @@ function build() {
     # BEGIN inside build folder
     pushd "$repo_folder"
       cli_version=$(jq .version --raw-output < package.json)
-      corellium_cli_tarball="corellium-cli-$cli_version.tgz"
+      corellium_cli_tarball="corellium-corellium-cli-$cli_version.tgz"
 
       node --version
       npm ci --unsafe-perm --ignore-scripts

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@corellium/corellium-cli",
-    "version": "1.0.3",
+    "version": "1.0.6",
     "description": "Corellium CLI Tool",
     "scripts": {
         "corellium-cli": "node index.js",
@@ -13,7 +13,6 @@
     },
     "bundleDependencies": [
         "@corellium/client-api",
-        "@corellium/corellium-api",
         "ascii-art",
         "axios",
         "dotenv",
@@ -25,14 +24,15 @@
     ],
     "dependencies": {
         "@corellium/client-api": "^0.1.0",
-        "@corellium/corellium-api": "^1.4.1",
         "ascii-art": "^2.8.5",
         "axios": "^0.27.2",
         "dotenv": "^16.0.1",
         "generate-password": "^1.7.0",
         "multi-progress": "^4.0.0",
         "progress": "^2.0.3",
+        "prompts": "^2.4.2",
         "uuid": "^8.3.2",
+        "xhr2": "^0.2.0",
         "yargs": "^17.5.1"
     },
     "husky": {

package/src/TrialAccount.js

@@ -0,0 +1,76 @@
+const Client = require('./commands/Client')
+const util = require('./utils')
+const { handler: login } = require('./commands/login')
+
+class TrialAccount extends Client {
+  constructor (argv) {
+    super(argv)
+    this.userEmail = argv['user-email']
+    this.adminName = argv['admin-user-name']
+    this.userPassword = argv['user-password']
+    this.adminPassword = argv['admin-password']
+    this.endpoint = argv.endpoint
+    this.name = argv['customer-name']
+    this.plan = util.planOptions(argv.plan)
+    this.duration = argv['trial-duration']
+    this.individual = !!this.plan.licenseType.includes('individual')
+    this.enterpriseDomainName = argv['enterprise-domain']
+  }
+
+  async getCouponCode () {
+    const parameters = {
+      email: this.userEmail,
+      name: this.name,
+      aggregate: !!this.individual,
+      domain: this.individual ? null : `${this.endpoint.replace('https://app', `${this.enterpriseDomainName}`)}`,
+      plan: this.plan,
+      coupon: null,
+      trial: { duration: this.duration },
+      skipEmail: true
+    }
+    /* eslint-disable camelcase */
+    const response = await this._fetch('POST', 'v1/billing/invites', parameters)
+    const { coupon_code } = response
+    return coupon_code
+  }
+
+  async subscribeTrial (coupon_code) {
+    const subscribeParams = {
+      termsOfService: true,
+      subscriberInviteCode: coupon_code,
+      skipEmail: true,
+      password: this.userPassword
+    }
+    const response = await this._fetch('POST', 'v1/billing/trials/subscribe', subscribeParams)
+    const { domainId } = response
+    return {
+      domainId,
+      password: this.userPassword
+    }
+  }
+
+  async setupTrialUser () {
+    await login({
+      username: this.adminName,
+      password: this.adminPassword,
+      endpoint: this.endpoint
+    })
+    const coupon_code = await this.getCouponCode(this.userEmail, this.endpoint)
+    const {
+      domainId,
+      password
+    } = await this.subscribeTrial(coupon_code)
+    await login({
+      username: this.userEmail,
+      password,
+      endpoint: this.endpoint
+    })
+    return {
+      user: this.userEmail,
+      password,
+      domainId
+    }
+  }
+}
+
+module.exports = TrialAccount

package/src/commands/Client.js

@@ -7,8 +7,8 @@ const { readProfile } = require('../profile')
 class Client {
   constructor (argv) {
     this.argv = Object.assign({}, argv)
-    this.project = argv.project
-    this.instance = argv.instance
+    this.project = argv.project || argv.projectId
+    this.instance = argv.instance || argv.instanceId
     this._profile = readProfile()
   }
 

package/src/commands/agent/Agent.js

@@ -1,5 +1,4 @@
-const CorelliumAPI = require('../CorelliumAPI')
-const { getAxios } = require('../../utils')
+const Client = require('../Client')
 
 /**
  * @typedef {object} AppsResult
@@ -9,21 +8,19 @@ const { getAxios } = require('../../utils')
 /**
  * Agent class
  */
-class AgentCLI extends CorelliumAPI {
+class AgentCLI extends Client {
+  agentBasePath = () => `v1/instances/${this.instance}/agent/v1`
+
+  ready = async () => await this._fetch('GET', `${this.agentBasePath()}/app/ready/`, {})
+
   /**
    * List files on device
    * @returns {Promise<Array<{object}>>}
    */
   listFiles = async () => {
-    this.setToken()
-    await this.getProject()
-    await this.getInstance()
-    await this._instance.waitForAgentReady()
-    const filesUrl = `${this._profile.endpoint}/api/v1/instances/${this.instanceId}/agent/v1/file/device/`
-    const axios = await getAxios()
-    const result = (await axios.get(filesUrl)).data || []
+    const response = (await this._fetch('GET', `${this.agentBasePath()}/file/device/`, {}))
     // Trim whitespace from file names
-    return result.entries.map(f => { return { ...f, name: f.name.trim() } })
+    return response.entries.map(f => { return { ...f, name: f.name.trim() } })
   }
 
   /**
@@ -32,14 +29,8 @@ class AgentCLI extends CorelliumAPI {
    */
   listApps = async (options) => {
     const { loadIcons } = options
-    this.setToken()
-    await this.getProject()
-    await this.getInstance()
-    await this._instance.waitForAgentReady()
-    const appsUrl = `${this._profile.endpoint}/api/v1/instances/${this.instanceId}/agent/v1/app/apps?loadIcons=${loadIcons ? 1 : 0}`
-    const axios = await getAxios()
-    const result = (await axios.get(appsUrl)).data
-    return result ? result.apps : []
+    const response = (await this._fetch('GET', `${this.agentBasePath()}/app/apps?loadIcons=${loadIcons ? 1 : 0}`, {}))
+    return response ? response.apps : []
   }
 }
 

package/src/commands/agent/apps.js

@@ -5,7 +5,8 @@ const { getErrorMessage } = require('../../error')
 const log = require('../../logging')
 
 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/agent/file.js

@@ -5,7 +5,8 @@ const { getErrorMessage } = require('../../error')
 const log = require('../../logging')
 
 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/agent/index.js

@@ -1,4 +1,5 @@
 const subcommands = [
+  require('./ready'),
   require('./file'),
   require('./apps')
 ]

package/src/commands/agent/ready.js

@@ -0,0 +1,43 @@
+const AgentCLI = require('./Agent')
+const { validateNonEmpty } = require('../../utils')
+const { getErrorMessage } = require('../../error')
+const log = require('../../logging')
+
+async function builder (yargs) {
+  yargs.option('verbose', {
+    alias: 'v',
+    type: 'boolean',
+    describe: 'Console will receive verbose error output'
+  }).option('project', {
+    type: 'input',
+    describe: 'Project ID',
+    demandOption: true,
+    string: true,
+    validateNonEmpty
+  }).option('instance', {
+    type: 'input',
+    describe: 'Instance ID',
+    demandOption: true,
+    string: true,
+    validateNonEmpty
+  })
+}
+
+async function handler (argv) {
+  try {
+    const agent = new AgentCLI(argv)
+    const status = await agent.ready()
+    log.plain(JSON.stringify(status))
+  } catch (err) {
+    const errorMessage = getErrorMessage(err)
+    log.error(`Query agent ready status failed: ${errorMessage}`)
+    if (argv.detailedErrors) { log.error(err) }
+  }
+}
+
+module.exports = {
+  builder,
+  handler,
+  command: 'ready',
+  describe: 'Query agent ready status'
+}

package/src/commands/extensions/delete.js

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

package/src/commands/extensions/list.js

@@ -4,7 +4,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'
   }).option('format', {

package/src/commands/extensions/load.js

@@ -11,7 +11,8 @@ async function builder (yargs) {
     type: 'string',
     describe: 'One or more extension file paths',
     demandOption: true
-  }).option('detailed-errors', {
+  }).option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   })

package/src/commands/extensions/validate.js

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

package/src/commands/firmware/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/firmware/load.js

@@ -11,7 +11,8 @@ async function builder (yargs) {
     type: 'string',
     describe: 'One or more firmware file paths',
     demandOption: true
-  }).option('detailed-errors', {
+  }).option('verbose', {
+    alias: 'v',
     type: 'boolean',
     describe: 'Console will receive verbose error output'
   })

package/src/commands/images/create.js

@@ -15,7 +15,8 @@ async function builder (yargs) {
       string: true,
       choices: ['json', 'csv']
     })
-    .option('detailed-errors', {
+    .option('verbose', {
+      alias: 'v',
       type: 'boolean',
       describe: 'Console will receive verbose error output'
     })

package/src/commands/images/delete.js

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

package/src/commands/images/list.js

@@ -4,7 +4,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/instances/Instance.js

@@ -0,0 +1,27 @@
+const Client = require('../Client')
+
+/**
+ * Instance class
+ */
+class InstanceCLI extends Client {
+  instanceBasePath = () => `v1/instances/${this.instance}`
+
+  /**
+   * Upgrade iOS version on instance
+   * @returns {Promise<any>}
+   */
+  upgrade = async (options) => {
+    const { os, osbuild } = options
+    return await this._fetch('POST', `${this.instanceBasePath()}/upgrade`, { os, osbuild })
+  }
+
+  /**
+   * Fetch instance information
+   * @returns {Promise<any>}
+   */
+  info = async () => {
+    return await this._fetch('GET', `${this.instanceBasePath()}`, {})
+  }
+}
+
+module.exports = InstanceCLI

package/src/commands/instances/create.js

@@ -3,7 +3,8 @@ const { getApi, waitForState } = require('../../utils')
 
 async function builder (yargs) {
   yargs
-    .option('detailed-errors', {
+    .option('verbose', {
+      alias: 'v',
       type: 'boolean',
       describe: 'Console will receive verbose error output'
     })
@@ -28,6 +29,11 @@ async function builder (yargs) {
       describe: 'Project ID to associate with instance',
       demandOption: true
     })
+    .option('name', {
+      type: 'string',
+      describe: 'Optional name of instance',
+      demandOption: false
+    })
     .option('wait', {
       type: 'boolean',
       describe: 'Wait for the instance to be ready',
@@ -39,10 +45,11 @@ async function handler (argv) {
   const flavor = argv.flavor
   const os = argv.os
   const project = argv.project
+  const name = argv.name
   const api = await getApi()
 
   try {
-    const instance = await api.v1CreateInstance({ flavor, os, project })
+    const instance = await api.v1CreateInstance({ flavor, os, project, name })
     // Wait 360 attempts for the instance to be created (30 minutes)
     if (argv.wait) {
       await waitForState(instance.id, api.v1GetInstance.bind(api), 'on', 360)
@@ -50,7 +57,7 @@ async function handler (argv) {
     console.log(instance.id)
   } catch (error) {
     const errorMessage = getErrorMessage(error)
-    console.error(`Failed to create image: ${errorMessage}`)
+    console.error(`Failed to create instance: ${errorMessage}`)
 
     if (argv.detailedErrors) {
       console.log(error)
@@ -61,6 +68,6 @@ async function handler (argv) {
 module.exports = {
   builder,
   handler,
-  command: 'create <flavor> <os> <project> [wait]',
+  command: 'create <flavor> <os> <project> [name] [wait]',
   describe: 'Create instance and associate with a project'
 }

package/src/commands/instances/delete.js

@@ -1,16 +1,23 @@
 const { getErrorMessage } = require('../../error')
 const asciiArt = require('ascii-art')
-const { getApi } = require('../../utils')
+const { getApi, sleep } = require('../../utils')
 
 async function builder (yargs) {
   yargs.positional('instanceId', {
     type: 'string',
     describe: 'Instance id',
     demandOption: true
-  }).option('detailed-errors', {
-    type: 'boolean',
-    describe: 'Console will receive verbose error output'
   })
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output'
+    })
+    .option('wait', {
+      type: 'boolean',
+      describe: 'Wait for the instance delete to complete',
+      demandOption: false
+    })
 }
 
 async function handler (argv) {
@@ -18,6 +25,14 @@ async function handler (argv) {
   const instanceId = argv.instanceId
   try {
     await api.v1DeleteInstance(instanceId)
+    if (argv.wait) {
+      let remaining
+      do {
+        await sleep(1000)
+        const instances = await api.v1GetInstances()
+        remaining = instances.find((i) => i.id === instanceId)
+      } while (remaining)
+    }
     console.log(
       asciiArt.style(`Successfully deleted instance ${instanceId}`, 'green', true)
     )
@@ -34,6 +49,6 @@ async function handler (argv) {
 module.exports = {
   builder,
   handler,
-  command: 'delete <instanceId>',
+  command: 'delete <instanceId> [wait]',
   describe: 'Delete instance'
 }

package/src/commands/instances/index.js

@@ -3,7 +3,8 @@ const subcommands = [
   require('./list'),
   require('./delete'),
   require('./stop'),
-  require('./start')
+  require('./start'),
+  require('./upgrade')
 ]
 
 let _yargs

package/src/commands/instances/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('project', {
@@ -20,13 +21,18 @@ async function builder (yargs) {
 async function handler (argv) {
   const api = await getApi()
   try {
-    const instances = await api.v1GetInstances(argv.project)
-    if (!instances.length) {
-      throw new Error('Found no matching Instances')
+    let instances
+    if (argv.project) {
+      instances = await api.v1GetProjectInstances(argv.project, {})
+    } else {
+      instances = await api.v1GetInstances()
+    }
+    if (!instances.length && argv.format !== 'json') {
+      console.error('Found no matching Instances')
     }
     await displayTable(argv.format, instances, [
       'id', 'flavor', 'type', 'state', 'os'
-    ], [{ column: 3, width: 5 }, { column: 2, width: 4 }])
+    ], [{ column: 3, width: 5 }, { column: 2, width: 4 }, { column: 1, width: 6 }])
   } catch (error) {
     const errorMessage = getErrorMessage(error)
     console.error(`List failed: ${errorMessage}`)

package/src/commands/instances/start.js

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

package/src/commands/instances/stop.js

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