@corellium/corellium-cli 1.0.8 → 1.1.0

package/.gitlab-ci.yml

@@ -19,3 +19,11 @@ test:
     # - mysqladmin -u root -ppassword -P 3306 -h mariadb status
 
     - npm ci
+    - npm run test:ci
+  artifacts:
+    paths:
+      - coverage/
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/cobertura-coverage.xml

package/.nycrc

@@ -0,0 +1,16 @@
+{
+    "check-coverage": false,
+    "report-dir": "./coverage",
+    "reporter": ["cobertura", "lcov", "text"],
+    "branches": 60,
+    "lines": 60,
+    "functions": 60,
+    "statements": 60,
+    "temp-dir": "/tmp",
+    "watermarks": {
+        "lines": [60, 80],
+        "functions": [60, 80],
+        "branches": [60, 80],
+        "statements": [60, 80]
+    }
+}

package/index.js

@@ -8,6 +8,7 @@ require('dotenv').config()
 async function run () {
   return yargs(hideBin(process.argv))
     .command(commands)
+    .scriptName('corellium')
     .usage('Usage: corellium [OPTIONS]')
     .demandCommand(1, '') // empty string overrides yargs nag message about specifying a command
     .strict() // strict handling of commands and arguments

package/package.json

@@ -1,12 +1,13 @@
 {
     "name": "@corellium/corellium-cli",
-    "version": "1.0.8",
+    "version": "1.1.0",
     "description": "Corellium CLI Tool",
     "scripts": {
         "corellium": "node index.js",
         "lint": "eslint .",
         "lint-staged": "lint-staged",
-        "lint:fix": "eslint --fix ."
+        "lint:fix": "eslint --fix .",
+        "test:ci": "npx nyc report"
     },
     "bin": {
         "corellium": "index.sh"

package/sonar-project.properties

@@ -0,0 +1,2 @@
+sonar.projectKey=middleware_corellium-cli_AYbC7e_Y2VKo8EJiY-py
+sonar.qualitygate.wait=true

package/src/commands/instances/Instance.js

@@ -15,6 +15,14 @@ class InstanceCLI extends Client {
     return await this._fetch('POST', `${this.instanceBasePath()}/upgrade`, { os, osbuild })
   }
 
+  /**
+   * Restore backup to instance
+   * @returns {Promise<any>}
+   */
+  restoreBackup = async () => {
+    return await this._fetch('POST', `${this.instanceBasePath()}/restoreBackup`)
+  }
+
   /**
    * Fetch instance information
    * @returns {Promise<any>}

package/src/commands/instances/index.js

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

package/src/commands/instances/restoreBackup.js

@@ -0,0 +1,77 @@
+const log = require('../../logging')
+const InstanceCLI = require('./Instance')
+const { readProfile } = require('../../profile')
+const { v4: uuidv4 } = require('uuid')
+const { basename } = require('path')
+const MultiProgress = require('multi-progress')
+const { uploadWithProgress } = require('../../upload')
+const { waitForTaskState } = require('../../utils')
+
+async function builder (yargs) {
+  yargs
+    .positional('instanceId', {
+      type: 'string',
+      describe: 'Instance id',
+      demandOption: true
+    })
+    .positional('zipFile', {
+      type: 'string',
+      describe: 'Path to backup zip file',
+      demandOption: true
+    })
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+      demandOption: false
+    })
+}
+
+async function handler (argv) {
+  const profile = readProfile()
+  const { instanceId, zipFile } = argv
+  const name = basename(zipFile)
+  const image = uuidv4()
+  const url = profile.endpoint +
+    '/api/v1/instances' +
+    '/' +
+    encodeURIComponent(instanceId) +
+    '/' +
+    'image-upload/backup' +
+    '/' +
+    encodeURIComponent(image) +
+    '/' +
+    encodeURIComponent(name)
+
+  const multi = new MultiProgress(process.stderr)
+
+  try {
+    await uploadWithProgress(url, profile.token, zipFile, multi, {
+      'x-corellium-image-encapsulated': 'false'
+    })
+    console.log(`Backup uploaded ${image}`)
+
+    const instance = new InstanceCLI(argv)
+    await instance.restoreBackup()
+
+    await waitForTaskState(instanceId, instance.info.bind(instance), 'restoring-backup')
+    console.log('Restoring in progress')
+    await waitForTaskState(instanceId, instance.info.bind(instance), 'none')
+
+    log.info(`Restored backup ${zipFile} to ${argv.instanceId}`)
+  } catch (err) {
+    const errorMessage = err.message
+    log.error(`Restore backup failed: ${errorMessage}`)
+    if (err.response && err.response.data && err.response.data.error) {
+      log.error(err.response.data.error)
+    }
+    if (argv.verbose) { log.error(err) }
+  }
+}
+
+module.exports = {
+  builder,
+  handler,
+  command: 'restore-backup <instanceId> <zipFile> [--verbose]',
+  describe: 'Restore iOS backup to instance'
+}

package/src/commands/instances/rotate.js

@@ -0,0 +1,47 @@
+const { getErrorMessage } = require('../../error')
+const asciiArt = require('ascii-art')
+
+const Client = require('../Client')
+async function builder (yargs) {
+  yargs.positional('instanceId', {
+    type: 'string',
+    describe: 'Instance id',
+    demandOption: true
+  })
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output'
+    })
+    .option('orientation', {
+      alias: 'o',
+      type: 'number',
+      describe: 'Orientation type'
+    })
+}
+
+async function handler (argv) {
+  const client = new Client(argv)
+  const instanceId = argv.instanceId
+  const orientation = argv.orientation || 4
+  try {
+    await client._fetch('POST', `v1/instances/${instanceId}/rotate`, { orientation })
+    console.log(
+      asciiArt.style(`Successfully rotated instance ${instanceId}`, 'green', true)
+    )
+  } catch (error) {
+    const errorMessage = getErrorMessage(error)
+    console.error(`Failed to rotate ${instanceId}: ${errorMessage}`)
+
+    if (argv.detailedErrors) {
+      console.log(error)
+    }
+  }
+}
+
+module.exports = {
+  builder,
+  handler,
+  command: 'rotate <instanceId> [orientation]',
+  describe: 'Rotate instance'
+}

package/src/commands/webplayer/{WebPlayer.js → Webplayer.js}

@@ -4,9 +4,9 @@ const {
 } = require('../../profile')
 
 /**
- * WebPlayer class
+ * Webplayer class
  */
-class WebPlayer extends Client {
+class Webplayer extends Client {
   constructor (argv) {
     super(argv)
     const { features, permissions, expiresIn } = this.argv
@@ -16,7 +16,7 @@ class WebPlayer extends Client {
   }
 
   /**
-   * Create a Web Player session
+   * Create a Webplayer session
    * @returns {Promise<Array<object>>}
    */
   createSession = async () => this._fetch('POST', 'v1/webplayer', {
@@ -28,14 +28,14 @@ class WebPlayer extends Client {
   })
 
   /**
-   * Destroy a Web Player session
+   * Destroy a Webplayer session
    * @param {string} sessionId
    * @returns {Promise<{object}>}
    */
   destroySession = async (sessionId) => this._fetch('DELETE', `v1/webplayer/${sessionId}`, {})
 
   /**
-   * List Web Player sessions
+   * List Webplayer sessions
    * @returns {Promise<Array<object>>}
    */
   listSessions = async (sessionId) => {
@@ -44,7 +44,7 @@ class WebPlayer extends Client {
   }
 
   /**
-   * Log into WebPlayer session by activating WebPlayer credentials
+   * Log into Webplayer session by activating Webplayer credentials
    * @param {string} sessionId
    * @returns {Promise<void>}
    */
@@ -54,4 +54,4 @@ class WebPlayer extends Client {
   }
 }
 
-module.exports = WebPlayer
+module.exports = Webplayer

package/src/commands/webplayer/create.js

@@ -1,4 +1,4 @@
-const WebPlayer = require('./WebPlayer')
+const Webplayer = require('./Webplayer')
 const log = require('../../logging')
 const { displayTable } = require('../../table')
 const { validateNonEmpty } = require('../../utils')
@@ -49,13 +49,13 @@ async function builder (yargs) {
 
 async function handler (argv) {
   try {
-    const webplayer = new WebPlayer(argv)
+    const webplayer = new Webplayer(argv)
     const session = await webplayer.createSession()
-    // log.info('Created web player session')
+    // log.info('Created Webplayer session')
     await displayTable(argv.format || 'json', [session], ['identifier', 'token', 'expiration', 'features'])
   } catch (err) {
     const errorMessage = getErrorMessage(err)
-    log.error(`Create web player session failed: ${errorMessage}`)
+    log.error(`Create Webplayer session failed: ${errorMessage}`)
     if (argv.detailedErrors) { log.error(err) }
   }
 }
@@ -64,5 +64,5 @@ module.exports = {
   builder,
   handler,
   command: 'create',
-  describe: 'Create a web player session returning the URL and token'
+  describe: 'Create a Webplayer session returning the URL and token'
 }

package/src/commands/webplayer/destroy.js

@@ -1,4 +1,4 @@
-const WebPlayer = require('./WebPlayer')
+const Webplayer = require('./Webplayer')
 const log = require('../../logging')
 const { validateNonEmpty } = require('../../utils')
 const { getErrorMessage } = require('../../error')
@@ -16,7 +16,7 @@ async function builder (yargs) {
     validateNonEmpty
   }).option('session', {
     type: 'input',
-    describe: 'WebPlayer Session ID',
+    describe: 'Webplayer Session ID',
     demandOption: true,
     string: true,
     validateNonEmpty
@@ -26,12 +26,12 @@ async function builder (yargs) {
 async function handler (argv) {
   const { session: sessionId } = argv
   try {
-    const webplayer = new WebPlayer(argv)
+    const webplayer = new Webplayer(argv)
     await webplayer.destroySession(sessionId)
-    log.info(`Destroyed web player session ${sessionId}`)
+    log.info(`Destroyed Webplayer session ${sessionId}`)
   } catch (err) {
     const errorMessage = getErrorMessage(err)
-    log.error(`Destroy web player session ${sessionId} failed: ${errorMessage}`)
+    log.error(`Destroy Webplayer session ${sessionId} failed: ${errorMessage}`)
     if (argv.detailedErrors) { log.error(err) }
   }
 }
@@ -40,5 +40,5 @@ module.exports = {
   builder,
   handler,
   command: 'destroy',
-  describe: 'Destroy a web player session'
+  describe: 'Destroy a Webplayer session'
 }

package/src/commands/webplayer/index.js

@@ -11,5 +11,5 @@ module.exports = {
   builder: yargs => (_yargs = yargs) && yargs.command(subcommands).scriptName(''),
   handler: argv => !argv[1] && _yargs.showHelp(),
   command: 'webplayer',
-  describe: 'Web Player related commands'
+  describe: 'Webplayer related commands'
 }

package/src/commands/webplayer/list.js

@@ -1,4 +1,4 @@
-const WebPlayer = require('./WebPlayer')
+const Webplayer = require('./Webplayer')
 const log = require('../../logging')
 const { displayTable } = require('../../table')
 const { validateNonEmpty } = require('../../utils')
@@ -17,7 +17,7 @@ async function builder (yargs) {
     validateNonEmpty
   }).option('session', {
     type: 'input',
-    describe: 'Web Player Session ID',
+    describe: 'Webplayer Session ID',
     demandOption: false,
     string: true
   }).option('format', {
@@ -30,7 +30,7 @@ async function builder (yargs) {
 
 async function handler (argv) {
   try {
-    const webplayer = new WebPlayer(argv)
+    const webplayer = new Webplayer(argv)
     const result = await webplayer.listSessions(argv.session)
     if (!result.length && argv.format !== 'json') {
       console.error('Found no matching Webplayer sessions')
@@ -63,5 +63,5 @@ module.exports = {
   builder,
   handler,
   command: 'list',
-  describe: 'List web player sessions for a project'
+  describe: 'List Webplayer sessions for a project'
 }

package/src/commands/webplayer/login.js

@@ -1,4 +1,4 @@
-const WebPlayer = require('./WebPlayer')
+const Webplayer = require('./Webplayer')
 const log = require('../../logging')
 const { validateNonEmpty } = require('../../utils')
 const { getErrorMessage } = require('../../error')
@@ -16,7 +16,7 @@ async function builder (yargs) {
     validateNonEmpty
   }).option('session', {
     type: 'input',
-    describe: 'WebPlayer Session ID',
+    describe: 'Webplayer Session ID',
     demandOption: true,
     string: true,
     validateNonEmpty
@@ -26,12 +26,12 @@ async function builder (yargs) {
 async function handler (argv) {
   const { session: sessionId } = argv
   try {
-    const webplayer = new WebPlayer(argv)
+    const webplayer = new Webplayer(argv)
     await webplayer.login(sessionId)
-    log.info(`Login to Web Player session ${sessionId} successful`)
+    log.info(`Login to Webplayer session ${sessionId} successful`)
   } catch (err) {
     const errorMessage = getErrorMessage(err)
-    log.error(`Login to Web Player session ${sessionId} failed: ${errorMessage}`)
+    log.error(`Login to Webplayer session ${sessionId} failed: ${errorMessage}`)
     if (argv.detailedErrors) {
       log.error(err)
     }
@@ -42,5 +42,5 @@ module.exports = {
   builder,
   handler,
   command: 'login',
-  describe: 'Log CLI into a web player session'
+  describe: 'Log CLI into a Webplayer session'
 }

package/src/upload.js

@@ -19,13 +19,14 @@ class File {
   }
 }
 
-async function uploadFile (token, url, filePath, progress) {
+async function uploadFile (token, url, filePath, progress, headers) {
   return new Promise((resolve, reject) => {
     const r = new Resumable({
       target: url,
       headers: {
         authorization: token,
-        'x-corellium-image-encoding': 'plain'
+        'x-corellium-image-encoding': 'plain',
+        ...headers
       },
       uploadMethod: 'PUT',
       chunkSize: 5 * 1024 * 1024,
@@ -64,7 +65,7 @@ async function uploadFile (token, url, filePath, progress) {
   })
 }
 
-async function uploadWithProgress (url, token, file, multi) {
+async function uploadWithProgress (url, token, file, multi, headers) {
   const fileName = basename(file)
 
   const bar = multi.newBar(` loading ${fileName} [:bar] :percent`, {
@@ -82,7 +83,8 @@ async function uploadWithProgress (url, token, file, multi) {
       (progress) => {
         const ticks = Math.ceil(100 * progress)
         bar.tick(ticks)
-      }
+      },
+      headers
     )
     return res
   } catch (error) {

package/src/utils.js

@@ -63,6 +63,23 @@ const waitForState = async (instanceId, fn, state, attempts = 20, reporterFn = n
   }
 }
 
+const waitForTaskState = async (instanceId, fn, taskState, attempts = 20) => {
+  let response = await fn(instanceId)
+
+  while (response.taskState !== taskState) {
+    if (response.state === 'error') {
+      throw new Error(response.error)
+    }
+
+    if (attempts <= 0) {
+      throw new Error(`Timed out waiting for taskState ${taskState}`)
+    }
+    --attempts
+    await sleep(waitForIntervalMilliSec)
+    response = await fn(instanceId)
+  }
+}
+
 async function getApi () {
   const profile = readProfile()
   const api = new CorelliumClient.CorelliumApi()
@@ -145,6 +162,7 @@ module.exports = {
   planOptions,
   makePassword,
   waitForState,
+  waitForTaskState,
   getApi,
   getAxios,
   validateNonEmpty,