Adding luis:version:list cmd (#375)

Author: JSpru

packages/luis/src/commands/luis/version/list.ts

@@ -0,0 +1,59 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import {CLIError, Command, flags} from '@microsoft/bf-cli-command'
+
+const utils = require('../../../utils/index')
+
+export default class LuisVersionList extends Command {
+  static description = 'Lists application version data'
+
+  static examples = [`
+    $ bf luis:version:list --appId {APPLICATION_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --take 3
+    $ bf luis:version:list --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --out {PATH_TO_JSON_FILE}
+  `]
+
+  static flags = {
+    help: flags.help({char: 'h'}),
+    endpoint: flags.string({description: 'LUIS endpoint hostname'}),
+    subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
+    appId: flags.string({description: 'LUIS application Id'}),
+    out: flags.string({char: 'o', description: 'Path to the directory where the exported file will be placed.'}),
+    skip: flags.string({description: 'The number of entries to skip. The default is 0 (no skips)'}),
+    take: flags.string({description: 'The number of etnries to return. The maximum page size is 500. The default is 100.'}),
+    force: flags.boolean({char: 'f', description: 'If --out flag is provided with the path to an existing file, overwrites that file', default: false}),
+  }
+
+  async run() {
+    const {flags} = this.parse(LuisVersionList)
+    const flagLabels = Object.keys(LuisVersionList.flags)
+    const configDir = this.config.configDir
+    const options: any = {}
+
+    let {endpoint, subscriptionKey, appId, force, out, skip, take} = await utils.processInputs(flags, flagLabels, configDir)
+
+    const requiredProps = {endpoint, subscriptionKey}
+    utils.validateRequiredProps(requiredProps)
+
+    const client = utils.getLUISClient(subscriptionKey, endpoint)
+
+    if (skip) options.skip = parseInt(skip, 10)
+    if (take) options.take = parseInt(take, 10)
+
+    try {
+      const versionList = await client.versions.list(appId, options)
+      if (out) {
+        const writtenFilePath: string = await utils.writeToFile(out, versionList, force)
+        this.log(`\nList successfully written to file: ${writtenFilePath}`)
+      } else {
+        await utils.writeToConsole(versionList)
+        this.log('\nList successfully output to console')
+      }
+    } catch (err) {
+      throw new CLIError(`Failed to export versions list: ${err}`)
+    }
+  }
+
+}

packages/luis/src/utils/index.ts

@@ -47,6 +47,15 @@ const getLUISClient = (subscriptionKey: string, endpoint: string) => {
   return luisClient
 }
 
+const isDirectory = (path: string): boolean => {
+  try {
+    const stats = fs.statSync(path)
+    return stats.isDirectory()
+  } catch {
+    return false
+  }
+}
+
 const filterByAllowedConfigValues = (configObj: any, prefix: string) => {
   const allowedConfigValues = [`${prefix}appId`, `${prefix}region`, `${prefix}subscriptionKey`, `${prefix}versionId`]
   const filtered = Object.keys(configObj)
@@ -89,9 +98,11 @@ const writeToConsole = (outputContents: string) => {
 }
 
 const writeToFile = async (outputLocation: string, content: any, force: boolean) => {
-  const validatedPath = utils.validatePath(outputLocation, '', force)
+  const isDir = isDirectory(outputLocation)
+  let writeFile = isDir ? path.join(outputLocation, 'export.json') : outputLocation
+  const validatedPath = utils.validatePath(writeFile, '', force)
   try {
-    await fs.ensureFile(outputLocation)
+    await fs.ensureFile(writeFile)
     await fs.writeJson(validatedPath, content, {spaces: 2})
   } catch (error) {
     throw new CLIError(error)

packages/luis/test/commands/luis/version/list.test.ts

@@ -0,0 +1,90 @@
+import {expect, test} from '@oclif/test'
+const sinon = require('sinon')
+const uuidv1 = require('uuid/v1')
+const utils = require('../../../../src/utils/index')
+const fs = require('fs-extra')
+import * as rimraf from 'rimraf'
+
+describe('luis:version:list', () => {
+
+  before(() => { 
+    fs.mkdirSync('./testout');
+  });
+
+  after(() => {
+    rimraf('./testout', (err) => {
+      if (err) console.log(err);
+    })
+  });
+
+  beforeEach(() => {
+    sinon.stub(utils, 'processInputs').returnsArg(0)
+  })
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test
+  .stdout()
+  .command(['luis:version:list', '--help'])
+  .it('should print the help contents when --help is passed as an argument', ctx => {
+    expect(ctx.stdout).to.contain('Lists application version data')
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:version:list', '--endpoint', 'https://westus.api.cognitive.microsoft.com'])
+  .it('displays an error if any required input parameters are missing', ctx => {
+    expect(ctx.stderr).to.contain(`Required input property 'subscriptionKey' missing.`)
+  })
+
+  test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .get(uri => uri.includes('apps'))
+  .reply(200, {name: 'version'})
+  )
+  .stdout()
+  .command(['luis:version:list', '--appId', uuidv1(), '--subscriptionKey', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com'])
+  .it('displays a list of application versions', ctx => {
+    expect(ctx.stdout).to.contain('List successfully output to console')
+  })
+
+  test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .get(uri => uri.includes('apps'))
+  .reply(200, {name: 'version'})
+  )
+  .stdout()
+  .command(['luis:version:list', '--out', './testout/test.json', '--subscriptionKey', uuidv1(), '--appId', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com'])
+  .it('export a list of application versions to the specified file', ctx => {
+    expect(ctx.stdout).to.contain('List successfully written to file')
+    expect(ctx.stdout).to.contain('test.json')
+  })
+
+  test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .get(uri => uri.includes('apps'))
+  .reply(200, {name: 'version'})
+  )
+  .stdout()
+  .command(['luis:version:list', '--out', './testout', '--subscriptionKey', uuidv1(), '--appId', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com'])
+  .it('export a list of application versions to the specified directory, using a default file name', ctx => {
+    expect(ctx.stdout).to.contain('List successfully written to file')
+    expect(ctx.stdout).to.contain('export.json')
+  })
+
+  test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .get(uri => uri.includes('apps'))
+  .reply(200, {name: 'version'})
+  )
+  .stdout()
+  .stderr()
+  .command(['luis:version:list', '--out', 'xyz', '--subscriptionKey', uuidv1(),'--appId', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com'])
+  .it('displays a list of application versions and a success message in the console (since the target path provided is invalid)', ctx => {
+    expect(ctx.stderr).to.contain('Target directory path doesn\'t exist:')
+  })
+
+})