Adding luis:application:import cmd (#367)

* Adding luis:application:import cmd

* Rewriting if else

* Bring stdin reading back into the command

* Remove no longer needed var dec

* Refactor / show error if no input / add unit test for that

Author: JSpru

packages/luis/src/commands/luis/application/import.ts

@@ -0,0 +1,52 @@
+/*!
+ * 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 LuisApplicationImport extends Command {
+  static description = 'Imports an application to LUIS'
+
+  static examples = [`
+    $ bf luis:application:import --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --name {NAME} --in {PATH_TO_JSON}
+    $ echo {SERIALIZED_JSON} | bf luis:application:import --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --name {NAME}
+  `]
+
+  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)'}),
+    name: flags.string({description: 'LUIS application name'}),
+    in: flags.string({char: 'i', description: 'File path containing LUIS application contents'})
+  }
+
+  async run() {
+    const {flags} = this.parse(LuisApplicationImport)
+    const flagLabels = Object.keys(LuisApplicationImport.flags)
+    const configDir = this.config.configDir
+    const stdin = await this.readStdin()
+
+    let {endpoint, subscriptionKey, name, inVal} = await utils.processInputs(flags, flagLabels, configDir)
+
+    const requiredProps = {endpoint, subscriptionKey, name}
+    utils.validateRequiredProps(requiredProps)
+
+    inVal = inVal ? inVal.trim() : flags.in
+
+    const appJSON = stdin ? stdin : await utils.getInputFromFile(inVal)
+    if (!appJSON) throw new CLIError('No import data found - please provide input through stdin or the --in flag')
+
+    const client = utils.getLUISClient(subscriptionKey, endpoint)
+
+    try {
+      const newAppId = await client.apps.importMethod(JSON.parse(appJSON), undefined)
+      this.log(`App successfully imported with id ${newAppId}.`)
+    } catch (err) {
+      throw new CLIError(`Failed to import app: ${err}`)
+    }
+  }
+
+}

packages/luis/src/utils/index.ts

@@ -18,6 +18,17 @@ const filterConfig = (config: any, prefix: string) => {
     }, {})
 }
 
+const getInputFromFile = async (path: string): Promise<string> => {
+  if (path) {
+    try {
+      return await utils.readTextFile(path)
+    } catch (error) {
+      throw new CLIError(`Failed to read app JSON: ${error}`)
+    }
+  }
+  return ''
+}
+
 const getUserConfig = async (configPath: string) => {
   if (fs.existsSync(path.join(configPath, 'config.json'))) {
     return fs.readJSON(path.join(configPath, 'config.json'), {throws: false})
@@ -55,6 +66,10 @@ const processInputs = async (flags: any, flagLabels: string[], configDir: string
   flagLabels
     .filter(flag => flag !== 'help')
     .map((flag: string) => {
+      if (flag === 'in') {
+        // rename property since 'in' is a reserved keyword in Javascript
+        input[`${flag}Val`] = flags[flag]
+      }
       input[flag] = flags[flag] || (config ? config[configPrefix + flag] : null)
     })
   return input
@@ -84,6 +99,7 @@ const writeToFile = async (outputLocation: string, content: any, force: boolean)
   return validatedPath
 }
 
+module.exports.getInputFromFile = getInputFromFile
 module.exports.getLUISClient = getLUISClient
 module.exports.getUserConfig = getUserConfig
 module.exports.processInputs = processInputs

packages/luis/test/commands/luis/application/create.test.ts

@@ -59,4 +59,4 @@ describe('luis:application:create', () => {
     expect(ctx.stderr).to.contain('Access denied due to invalid subscription key or wrong API endpoint.')
   })
 
-})
+})

packages/luis/test/commands/luis/application/import.test.ts

@@ -0,0 +1,81 @@
+import {expect, test} from '@oclif/test'
+import * as cp from 'child_process';
+const sinon = require('sinon')
+const uuidv1 = require('uuid/v1')
+const utils = require('../../../../src/utils/index')
+
+describe('luis:application:import', () => {
+
+  beforeEach(() => {
+    sinon.stub(utils, 'processInputs').returnsArg(0)
+    
+  })
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test
+  .stdout()
+  .command(['luis:application:import', '--help'])
+  .it('should print the help contents when --help is passed as an argument', ctx => {
+    expect(ctx.stdout).to.contain('Imports an application to LUIS')
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:application:import', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--subscriptionKey', uuidv1()])
+  .it('displays an error if any required input parameters are missing', ctx => {
+    expect(ctx.stderr).to.contain(`Required input property 'name' missing.`)
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:application:import', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--name', 'sample_app'])
+  .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
+  .post(uri => uri.includes('apps'))
+  .reply(201, '99999')
+  )
+  .stdout()
+  .stderr()
+  .command(['luis:application:import', '--name', 'Sample', '--in', './test/fixtures/sample-app.json', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--subscriptionKey', uuidv1()])
+  .it('imports a luis app from a file and returns the app\'s id', ctx => {
+    expect(ctx.stdout).to.contain('App successfully imported with id 99999')
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:application:import', '--name', 'Sample', '--in', './test/fixtures/xyz.json', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--subscriptionKey', uuidv1()])
+  .it('displays an error message if the import file cannot be found', ctx => {
+    expect(ctx.stderr).to.contain('Failed to read app JSON')
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:application:import', '--name', 'Sample', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--subscriptionKey', uuidv1()])
+  .it('displays an error message if no input data detected', ctx => {
+    expect(ctx.stderr).to.contain('No import data found - please provide input through stdin or the --in flag')
+  })
+
+  test
+  .stdin('{"luis_schema_version": "4.0.0","versionId": "0.1","name": "sampleapp","desc": "test description","culture": "en-us","tokenizerVersion": "1.0.0","intents": [{"name": "None"}],"entities": [],"composites": [],"closedLists": [],"patternAnyEntities": [],"regex_entities": [],"prebuiltEntities": [],"model_features": [],"regex_features": [],"patterns": [],"utterances": [],"settings": []}')
+  .stdout()
+  .stderr()
+  .command(['luis:application:import', '--name', 'sampleapp', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--subscriptionKey', uuidv1()])
+  .it('imports a luis app from stdin and returns the app\'s id', ctx => {
+    process.stdin.setEncoding('utf8')
+    process.stdin.once('data', data => {
+      expect(ctx.stderr).to.contain('App successfully imported with id 99999')
+    })
+  })
+
+})

packages/luis/test/fixtures/sample-app.json

@@ -0,0 +1,24 @@
+{
+  "luis_schema_version": "4.0.0",
+  "versionId": "0.1",
+  "name": "sample_app",
+  "desc": "test description",
+  "culture": "en-us",
+  "tokenizerVersion": "1.0.0",
+  "intents": [
+    {
+      "name": "None"
+    }
+  ],
+  "entities": [],
+  "composites": [],
+  "closedLists": [],
+  "patternAnyEntities": [],
+  "regex_entities": [],
+  "prebuiltEntities": [],
+  "model_features": [],
+  "regex_features": [],
+  "patterns": [],
+  "utterances": [],
+  "settings": []
+}