@corellium/corellium-cli 1.0.3 → 1.0.4

package/README.md

@@ -8,6 +8,10 @@ Corellium CLI is a command line interface for Corellium's API. It allows you to
 npm install -g @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/example/WebPlayerSample.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 const path = require('path')
-const asciiArt = require('../node_modules/ascii-art')
+const asciiArt = require('ascii-art')
 const { exec } = require('child_process')
 const { promisify } = require('util')
 const execp = promisify(exec)
@@ -15,7 +15,8 @@ const project = process.env.PROJECT
 const flavor = process.env.FLAVOR
 const version = process.env.VERSION
 const apitoken = process.env.APIKEY // Admin's API token
-const expiration = 15 * 60 // seconds (15 minutes), Set < 15 mins to test automatic token renewal
+const expiration = 24 * 60 * 60 // 24 hours (in seconds)
+const maxAgentTimeout = 120 // seconds
 let projectId, instanceId
 
 const frontendFeatureSet = {
@@ -44,6 +45,12 @@ const features = JSON.stringify(JSON.stringify(frontendFeatureSet))
 
 const execOptions = { cwd: path.join(__dirname, '../.') }
 
+const now = () => new Date().getTime()
+
+const sleep = (milliseconds) => {
+  return new Promise((resolve) => setTimeout(resolve, milliseconds))
+}
+
 /**
  * Return a timestamp as delta T formatted -> mm:ss.msec
  * @return {string}
@@ -52,8 +59,8 @@ const INFO_COLOR = 'green'
 const CMD_COLOR = 'magenta'
 const ERROR_COLOR = 'red'
 const TIMESTAMP_COLOR = 'cyan'
-const startTime = new Date().getTime()
-const ts = () => asciiArt.style(new Date((new Date().getTime() - startTime)).toISOString().slice(14, 23) + ':', TIMESTAMP_COLOR, true)
+const startTime = now()
+const ts = () => asciiArt.style(new Date((now() - startTime)).toISOString().slice(14, 23) + ':', TIMESTAMP_COLOR, true)
 /**
  * Logging with timestamp
  * @param args
@@ -82,10 +89,12 @@ const logError = (...args) => {
 /**
  * Execute a command on the local host
  * @param {string} cmd
+ * @param {object} options
  * @return {Promise<{stdout, stderr}>}
  */
-async function execLocal (cmd) {
-  logInfo(asciiArt.style('[CorelliumCLI] ' + cmd, CMD_COLOR, true))
+async function execLocal (cmd, options = { quiet: false }) {
+  const { quiet } = options
+  if (!quiet) { logInfo(asciiArt.style('[CorelliumCLI] ' + cmd, CMD_COLOR, true)) }
   let { stdout, stderr } = await execp(cmd, execOptions)
   stdout = stdout && stdout.trim()
   stderr = stderr && stderr.trim()
@@ -106,8 +115,8 @@ const parse = (data) => { try { return JSON.parse(data) } catch (_e) { return da
  */
 const listSessions = async (sessionId) => {
   const session = sessionId ? ` --session ${sessionId}` : ''
-  const { stdout } = await execLocal(`node index.js webplayer list --project ${projectId}${session} --format json`)
-  const sessions = parse(stdout)
+  const { stdout: result } = await execLocal(`node index.js webplayer list --project ${projectId}${session} --format json`)
+  const sessions = parse(result)
   if (Array.isArray(sessions)) {
     logResult('Existing WebPlayers:', sessions.map(s => s.identifier))
   } else {
@@ -135,11 +144,13 @@ const findProject = async (id) => {
  */
 const createInstance = async () => {
   const { stdout: result } = await execLocal(`node index.js instance create ${flavor} ${version} ${projectId} --format json`)
-  logResult(`"${result}"`)
+  // logResult(`"${result}"`)
   try {
     const instances = parse(result)
     if (Array.isArray(instances)) {
       return instances[0]
+    } else if (typeof instances === 'string') {
+      return [instances]
     }
   } catch (err) {
     console.error(err)
@@ -154,23 +165,18 @@ const findInstance = async (id) => {
   if (Array.isArray(instances)) {
     const inst = instances.find(i => i.id === id || i.name === id || i.flavor === id)
     if (inst) {
-      logInfo(`Found instance ${inst.id} - ${inst.name || inst.flavor}`)
+      logInfo(`Found instance ${instanceId} - ${inst.name || inst.flavor} - State: ${inst.state}`)
       return inst
     }
-    return await createInstance()
   }
 }
 
 const startInstance = async () => {
+  logInfo(`startInstance: ${instanceId}`)
   let { stdout: result } = await execLocal(`node index.js instance list --project ${projectId} --format json`)
   // logResult(`"${result}"`)
-  const instances = parse(result)
-  if (Array.isArray(instances)) {
-    const inst = instances.find(i => i.id === instanceId)
-    if (!inst) {
-      throw new Error(`Could not find instance ${instanceId}`)
-    }
-    logInfo(`Found instance ${instanceId} - ${inst.name || inst.flavor}`)
+  const inst = await findInstance(instanceId)
+  if (inst) {
     if (inst.state === 'on') {
       logInfo(`${inst.name || inst.flavor} is ON`)
     } else {
@@ -179,10 +185,50 @@ const startInstance = async () => {
       logInfo(result)
     }
   }
-  // Kind of a lie, but this is a good place for this msg because...
-  // if the instance has just started, the agent can take an uncomfortable
-  // amount of time to become available.
-  logInfo('Waiting for an agent to become available...')
+}
+
+const _stopInstance = async () => {
+  logInfo(`stopInstance: ${instanceId}`)
+  let { stdout: result } = await execLocal(`node index.js instance list --project ${projectId} --format json`)
+  // logResult(`"${result}"`)
+  const inst = await findInstance(instanceId)
+  if (inst) {
+    if (inst.state === 'on') {
+      logInfo(`${inst.name || inst.flavor} is ON. Turning off ${inst.name || inst.flavor}...`);
+      ({ stdout: result } = await execLocal(`node index.js instance stop ${instanceId}`))
+      logInfo(result)
+    } else {
+      logInfo(`${inst.name || inst.flavor} is already OFF.`)
+    }
+  }
+}
+
+const waitForAgentReady = async (timeout) => {
+  logInfo(`Waiting up to ${timeout / 1000} seconds for an agent to become available...`)
+  const options = { quiet: false } // Used to toggle verbosity so we only show one polling command
+  const startTime = now()
+  const timeoutTime = startTime + timeout
+  let agentObtained
+  let dots = '\r'
+  do {
+    let { stdout: result } = await execLocal(`node index.js agent ready --project ${projectId} --instance ${instanceId}`, options)
+    // logResult(`"${result}"`)
+    options.quiet = true
+    dots = dots + '.'
+    process.stdout.write(dots)
+    if (typeof result !== 'string' || result.length === 0) { result = '{"ready": false}' }
+    try {
+      const status = parse(result)
+      agentObtained = status.ready
+      // eslint-disable-next-line no-empty
+    } catch (_err) {}
+    if (!agentObtained) await sleep(2000)
+  } while (!agentObtained && (now() < timeoutTime))
+  if (now() >= timeoutTime) {
+    throw new Error(`Timed out waiting for agent to become available on instance ${instanceId}`)
+  }
+  process.stdout.write('\r')
+  logResult(`Agent available after ${Math.trunc((now() - startTime) / 1000)} seconds`)
 }
 
 // Log in as administrator
@@ -210,15 +256,15 @@ const adminLogin = async () => {
 
   // Locate project
   const i = await findInstance(flavor)
-  if (i) instanceId = i.id
-  if (!instanceId) throw new Error('Missing instanceId')
+  instanceId = i ? i.id : (await createInstance())[0]
+  if (!instanceId) throw new Error('Unable to get an instance')
 
   // Show existing sessions
   logInfo('Show all sessions')
   await listSessions()
 
   // Create a Web Player session and extract the new session ID
-  let { stdout: result } = await execLocal(`node index.js webplayer create --project ${projectId} --features ${features} --expiresIn ${expiration}`)
+  let { stdout: result } = await execLocal(`node index.js webplayer create --project ${projectId} --instance ${instanceId} --features ${features} --expiresIn ${expiration}`)
   const parsed = parse(result)
   if (!Array.isArray(parsed)) { throw new Error('Web Player creation failed') }
   const { identifier: sessionId } = parsed[0]
@@ -236,28 +282,38 @@ const adminLogin = async () => {
   logResult(result)
 
   // Device must be ON before using agent
-  await startInstance();
+  await startInstance()
 
-  // List files
-  ({ stdout: result } = await execLocal(`node index.js agent files --project ${projectId} --instance ${instanceId}`))
-  logResult('\n', result);
+  try {
+    // Wait for an agent to become available
+    await waitForAgentReady(maxAgentTimeout * 1000);
 
-  // List apps
-  ({ stdout: result } = await execLocal(`node index.js agent apps --project ${projectId} --instance ${instanceId}`))
-  logResult('\n', result)
+    // List files
+    ({ stdout: result } = await execLocal(`node index.js agent files --project ${projectId} --instance ${instanceId}`))
+    logResult('\n', result);
+
+    // List apps
+    ({ stdout: result } = await execLocal(`node index.js agent apps --project ${projectId} --instance ${instanceId}`))
+    logResult('\n', result)
+  } catch (err) {
+    logError(err)
+  }
+
+  // Turn off instance
+  // await stopInstance()
 
   // Re-login in as administrator since the session has been destroyed
-  await adminLogin();
+  await adminLogin()
 
   // Destroy the Web Player session
-  ({ stdout: result } = await execLocal(`node index.js webplayer destroy --project ${projectId} --session ${sessionId}`))
-  logResult(result)
+  // ({ stdout: result } = await execLocal(`node index.js webplayer destroy --project ${projectId} --session ${sessionId}`))
+  // logResult(result)
 
   await listSessions()
 })()
   .then(() => {
     logInfo('-=DONE=-\n\n')
   })
-  .catch(e => {
-    logError(e)
+  .catch(err => {
+    logError(err)
   })

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/node_modules/@babel/cli/node_modules/commander/package.json

@@ -1,76 +1,45 @@
 {
-  "_args": [
-    [
-      "commander@4.1.1",
-      "/Users/haydenbleasel/GitHub/corellium-cli"
-    ]
-  ],
-  "_from": "commander@4.1.1",
-  "_id": "commander@4.1.1",
-  "_inBundle": false,
-  "_integrity": "sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==",
-  "_location": "/@babel/cli/commander",
-  "_phantomChildren": {},
-  "_requested": {
-    "type": "version",
-    "registry": true,
-    "raw": "commander@4.1.1",
-    "name": "commander",
-    "escapedName": "commander",
-    "rawSpec": "4.1.1",
-    "saveSpec": null,
-    "fetchSpec": "4.1.1"
-  },
-  "_requiredBy": [
-    "/@babel/cli"
-  ],
-  "_resolved": "https://registry.npmjs.org/commander/-/commander-4.1.1.tgz",
-  "_spec": "4.1.1",
-  "_where": "/Users/haydenbleasel/GitHub/corellium-cli",
-  "author": {
-    "name": "TJ Holowaychuk",
-    "email": "tj@vision-media.ca"
-  },
-  "bugs": {
-    "url": "https://github.com/tj/commander.js/issues"
-  },
-  "dependencies": {},
+  "name": "commander",
+  "version": "4.1.1",
   "description": "the complete solution for node.js command-line programs",
-  "devDependencies": {
-    "@types/jest": "^24.0.23",
-    "@types/node": "^12.12.11",
-    "eslint": "^6.7.0",
-    "eslint-plugin-jest": "^22.21.0",
-    "jest": "^24.8.0",
-    "standard": "^14.3.1",
-    "typescript": "^3.7.2"
-  },
-  "engines": {
-    "node": ">= 6"
-  },
-  "files": [
-    "index.js",
-    "typings/index.d.ts"
-  ],
-  "homepage": "https://github.com/tj/commander.js#readme",
   "keywords": [
     "commander",
     "command",
     "option",
     "parser"
   ],
+  "author": "TJ Holowaychuk <tj@vision-media.ca>",
   "license": "MIT",
-  "main": "index",
-  "name": "commander",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/tj/commander.js.git"
+    "url": "https://github.com/tj/commander.js.git"
   },
   "scripts": {
     "lint": "eslint index.js \"tests/**/*.js\"",
     "test": "jest && npm run test-typings",
     "test-typings": "tsc -p tsconfig.json"
   },
+  "main": "index",
+  "files": [
+    "index.js",
+    "typings/index.d.ts"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "@types/jest": "^24.0.23",
+    "@types/node": "^12.12.11",
+    "eslint": "^6.7.0",
+    "eslint-plugin-jest": "^22.21.0",
+    "jest": "^24.8.0",
+    "standard": "^14.3.1",
+    "typescript": "^3.7.2"
+  },
   "typings": "typings/index.d.ts",
-  "version": "4.1.1"
-}
+  "engines": {
+    "node": ">= 6"
+  }
+
+,"_resolved": "https://registry.npmjs.org/commander/-/commander-4.1.1.tgz"
+,"_integrity": "sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA=="
+,"_from": "commander@4.1.1"
+}

package/node_modules/@babel/cli/node_modules/make-dir/package.json

@@ -1,94 +1,63 @@
 {
-  "_args": [
-    [
-      "make-dir@2.1.0",
-      "/Users/haydenbleasel/GitHub/corellium-cli"
-    ]
-  ],
-  "_from": "make-dir@2.1.0",
-  "_id": "make-dir@2.1.0",
-  "_inBundle": false,
-  "_integrity": "sha512-LS9X+dc8KLxXCb8dni79fLIIUA5VyZoyjSMCwTluaXA0o27cCK0bhXkpgw+sTXVpPy/lSO57ilRixqk0vDmtRA==",
-  "_location": "/@babel/cli/make-dir",
-  "_phantomChildren": {},
-  "_requested": {
-    "type": "version",
-    "registry": true,
-    "raw": "make-dir@2.1.0",
-    "name": "make-dir",
-    "escapedName": "make-dir",
-    "rawSpec": "2.1.0",
-    "saveSpec": null,
-    "fetchSpec": "2.1.0"
-  },
-  "_requiredBy": [
-    "/@babel/cli"
-  ],
-  "_resolved": "https://registry.npmjs.org/make-dir/-/make-dir-2.1.0.tgz",
-  "_spec": "2.1.0",
-  "_where": "/Users/haydenbleasel/GitHub/corellium-cli",
-  "author": {
-    "name": "Sindre Sorhus",
-    "email": "sindresorhus@gmail.com",
-    "url": "sindresorhus.com"
-  },
-  "bugs": {
-    "url": "https://github.com/sindresorhus/make-dir/issues"
-  },
-  "dependencies": {
-    "pify": "^4.0.1",
-    "semver": "^5.6.0"
-  },
-  "description": "Make a directory and its parents if needed - Think `mkdir -p`",
-  "devDependencies": {
-    "@types/graceful-fs": "^4.1.3",
-    "@types/node": "^11.10.4",
-    "ava": "^1.2.0",
-    "codecov": "^3.0.0",
-    "graceful-fs": "^4.1.11",
-    "nyc": "^13.1.0",
-    "path-type": "^3.0.0",
-    "tempy": "^0.2.1",
-    "tsd-check": "^0.3.0",
-    "xo": "^0.24.0"
-  },
-  "engines": {
-    "node": ">=6"
-  },
-  "files": [
-    "index.js",
-    "index.d.ts"
-  ],
-  "homepage": "https://github.com/sindresorhus/make-dir#readme",
-  "keywords": [
-    "mkdir",
-    "mkdirp",
-    "make",
-    "directories",
-    "dir",
-    "dirs",
-    "folders",
-    "directory",
-    "folder",
-    "path",
-    "parent",
-    "parents",
-    "intermediate",
-    "recursively",
-    "recursive",
-    "create",
-    "fs",
-    "filesystem",
-    "file-system"
-  ],
-  "license": "MIT",
-  "name": "make-dir",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sindresorhus/make-dir.git"
-  },
-  "scripts": {
-    "test": "xo && nyc ava && tsd-check"
-  },
-  "version": "2.1.0"
-}
+	"name": "make-dir",
+	"version": "2.1.0",
+	"description": "Make a directory and its parents if needed - Think `mkdir -p`",
+	"license": "MIT",
+	"repository": "sindresorhus/make-dir",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "sindresorhus@gmail.com",
+		"url": "sindresorhus.com"
+	},
+	"engines": {
+		"node": ">=6"
+	},
+	"scripts": {
+		"test": "xo && nyc ava && tsd-check"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"keywords": [
+		"mkdir",
+		"mkdirp",
+		"make",
+		"directories",
+		"dir",
+		"dirs",
+		"folders",
+		"directory",
+		"folder",
+		"path",
+		"parent",
+		"parents",
+		"intermediate",
+		"recursively",
+		"recursive",
+		"create",
+		"fs",
+		"filesystem",
+		"file-system"
+	],
+	"dependencies": {
+		"pify": "^4.0.1",
+		"semver": "^5.6.0"
+	},
+	"devDependencies": {
+		"@types/graceful-fs": "^4.1.3",
+		"@types/node": "^11.10.4",
+		"ava": "^1.2.0",
+		"codecov": "^3.0.0",
+		"graceful-fs": "^4.1.11",
+		"nyc": "^13.1.0",
+		"path-type": "^3.0.0",
+		"tempy": "^0.2.1",
+		"tsd-check": "^0.3.0",
+		"xo": "^0.24.0"
+	}
+
+,"_resolved": "https://registry.npmjs.org/make-dir/-/make-dir-2.1.0.tgz"
+,"_integrity": "sha512-LS9X+dc8KLxXCb8dni79fLIIUA5VyZoyjSMCwTluaXA0o27cCK0bhXkpgw+sTXVpPy/lSO57ilRixqk0vDmtRA=="
+,"_from": "make-dir@2.1.0"
+}