Create bf luis plugin commands (#337)

* bf-luis-cli plugin initial commit

* Adding clone cmd

* Deleting files

* Get values from config if not present in flags

* Add unit tests with HTTP mock

* Lint fixes

* Update readme

* Move endpoint monkey patch into shared utils file so we only have to remove it once later

* Convert utils filte to TS, lint fixes, read config dir refactor

* Regenerate readme

* Eliminate redundant var

* Lint fix

* Remove duplicate content from readme

* Update readme

* Remove outer try catch

Author: JSpru

packages/luis/README.md

@@ -12,41 +12,27 @@
 * [Usage](#usage)
 * [Commands](#commands)
 <!-- tocstop -->
-# Usage
-<!-- usage -->
-```sh-session
-$ npm install -g @microsoft/bf-luis-cli
-$ oclif-example COMMAND
-running command...
-$ oclif-example (-v|--version|version)
-@microsoft/bf-luis-cli/0.0.0 win32-x64 node-v10.16.3
-$ oclif-example --help [COMMAND]
-USAGE
-  $ oclif-example COMMAND
-...
-```
-<!-- usagestop -->
+
 # Commands
 <!-- commands -->
-* [`oclif-example hello [FILE]`](#oclif-example-hello-file)
+* [`bf luis:version:clone`](#bf-luisversionclone)
 
-## `oclif-example hello [FILE]`
+## `bf luis:version:clone`
 
-describe the command here
+Creates a new version equivalent to the current snapshot of the selected application version.
 
 ```
 USAGE
-  $ oclif-example hello [FILE]
+  $ bf luis:version:clone --appId {APP_ID} --versionId {VERSION_ID} --targetVersionId {TARGET_VERSION_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
 
 OPTIONS
-  -f, --force
-  -h, --help       show CLI help
-  -n, --name=name  name to print
-
-EXAMPLE
-  $ oclif-example hello
-  hello world from ./src/hello.ts!
+  -h, --help          show CLI help
+  --appId             LUIS application Id
+  --versionId         LUIS version Id
+  --targetVersionId   LUIS target version Id
+  --endpoint          LUIS endpoint hostname
+  --subscriptionKey   LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)
 ```
 
-_See code: [src\commands\hello.ts](https://github.com/packages/bf-luis-cli/blob/v0.0.0/src\commands\hello.ts)_
+_See code: [src\commands\luis\version\clone.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/version/clone/index.ts)_
 <!-- commandsstop -->

packages/luis/package.json

@@ -3,9 +3,12 @@
   "version": "0.0.0",
   "bugs": "https://github.com/packages/bf-luis-cli/issues",
   "dependencies": {
+    "@microsoft/bf-cli-command": "1.0.0",
     "@oclif/command": "^1.5.19",
     "@oclif/config": "^1.13.3",
+    "@types/sinon": "^7.5.0",
     "azure-cognitiveservices-luis-authoring": "2.1.1",
+    "fs-extra": "^8.1.0",
     "ms-rest": "2.5.3",
     "tslib": "^1.10.0"
   },
@@ -22,9 +25,11 @@
     "mocha": "^5.2.0",
     "nyc": "^14.1.1",
     "rimraf": "^3.0.0",
+    "sinon": "^7.5.0",
     "ts-node": "^8.4.1",
     "tslint": "^5.20.1",
-    "typescript": "^3.7.2"
+    "typescript": "^3.7.2",
+    "uuid": "^3.3.3"
   },
   "engines": {
     "node": ">=8.0.0"
@@ -42,7 +47,7 @@
   "license": "MIT",
   "oclif": {
     "commands": "./lib/commands",
-    "bin": "oclif-example",
+    "bin": "bf",
     "devPlugins": [
       "@oclif/plugin-help"
     ]

packages/luis/src/commands/hello.ts

@@ -0,0 +1,53 @@
+/*!
+ * 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 LuisVersionClone extends Command {
+  static description = 'Creates a new version equivalent to the current snapshot of the selected application version.'
+
+  static examples = [`
+    $ bf luis:version:clone --appId {APP_ID} --versionId {VERSION_ID} --targetVersionId {TARGET_VERSION_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
+  `]
+
+  static flags = {
+    help: flags.help({char: 'h'}),
+    appId: flags.string({description: 'LUIS application Id'}),
+    versionId: flags.string({description: 'LUIS version Id'}),
+    targetVersionId: flags.string({description: 'LUIS target version Id'}),
+    endpoint: flags.string({description: 'LUIS endpoint hostname'}),
+    subscriptionKey: flags.string({description: 'LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)'}),
+  }
+
+  async run() {
+    const {flags} = this.parse(LuisVersionClone)
+    const configDir = this.config.configDir
+
+    const appId = flags.appId || await utils.getPropFromConfig('appId', configDir)
+    const endpoint = flags.endpoint || await utils.getPropFromConfig('endpoint', configDir)
+    const subscriptionKey = flags.subscriptionKey || await utils.getPropFromConfig('subscriptionKey', configDir)
+    const versionId = flags.versionId || await utils.getPropFromConfig('versionId', configDir)
+    const targetVersionId = flags.targetVersionId || await utils.getPropFromConfig('targetVersionId', configDir)
+
+    const requiredProps = {appId, endpoint, subscriptionKey, versionId, targetVersionId}
+    utils.validateRequiredProps(requiredProps)
+
+    const client = utils.getLUISClient(subscriptionKey, endpoint)
+    const options = {
+      versionCloneObject: {
+        version: targetVersionId
+      }
+    }
+
+    try {
+      const latestVersion = await client.versions.clone(appId, versionId, options)
+      this.log(`App successfully cloned. Latest version is now: ${latestVersion}`)
+    } catch (err) {
+      throw new CLIError(`Failed to clone app: ${err}`)
+    }
+  }
+}

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

@@ -0,0 +1,48 @@
+
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import {CLIError} from '@microsoft/bf-cli-command'
+const path = require('path')
+const fs = require('fs-extra')
+const msRest = require('ms-rest')
+const {LUISAuthoringClient} = require('azure-cognitiveservices-luis-authoring')
+
+const getUserConfig = async (configPath: string) => {
+  if (fs.existsSync(path.join(configPath, 'config.json'))) {
+    return fs.readJSON(path.join(configPath, 'config.json'), {throws: false})
+  }
+}
+
+const getLUISClient = (subscriptionKey: string, endpoint: string) => {
+  const token = {
+    inHeader: {
+      'Ocp-Apim-Subscription-Key': subscriptionKey
+    }
+  }
+  const creds = new msRest.ApiKeyCredentials(token)
+  const luisClient = new LUISAuthoringClient(creds, endpoint)
+  luisClient.baseUri = 'https://westus.api.cognitive.microsoft.com/luis/authoring/v3.0-preview/'
+  return luisClient
+}
+
+const getPropFromConfig = async (prop: string, configDir: string) => {
+  const config = await getUserConfig(configDir)
+  if (config && config[prop]) {
+    return config[prop]
+  }
+}
+
+const validateRequiredProps = (configObj: any) => {
+  Object.keys(configObj).forEach(key => {
+    if (!configObj[key]) {
+      throw new CLIError(`Required input property '${key}' missing. Please pass it in as a flag or set it in the config file.`)
+    }
+  })
+}
+
+module.exports.getLUISClient = getLUISClient
+module.exports.getPropFromConfig = getPropFromConfig
+module.exports.validateRequiredProps = validateRequiredProps

packages/luis/src/utils/index.ts

@@ -0,0 +1,50 @@
+import {expect, test} from '@oclif/test'
+const sinon = require('sinon')
+const uuidv1 = require('uuid/v1')
+const utils = require('../../../../src/utils/index')
+
+describe('luis:version:clone', () => {
+
+  beforeEach(() => {
+    sinon.stub(utils, 'getPropFromConfig').callsFake(() => null)
+  })
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test
+  .stdout()
+  .command(['luis:version:clone', '--help'])
+  .it('should print the help contents when --help is passed as an argument', ctx => {
+    expect(ctx.stdout).to.contain('Creates a new version equivalent to the current snapshot of the selected application version.')
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:version:clone', '--versionId', '0.1', '--targetVersionId', '0.2', '--subscriptionKey', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com/luis/authoring/v3.0-preview/'])
+  .it('displays an error if any required input parameters are missing', ctx => {
+    expect(ctx.stderr).to.contain(`Required input property 'appId' missing.`)
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:version:clone', '--appId', uuidv1(), '--versionId', '0.1', '--targetVersionId', '0.2', '--endpoint', 'https://westus.api.cognitive.microsoft.com/luis/authoring/v3.0-preview/'])
+  .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('clone'))
+  .reply(201, '0.2')
+  )
+  .stdout()
+  .command(['luis:version:clone', '--appId', uuidv1(), '--versionId', '0.1', '--targetVersionId', '0.2', '--subscriptionKey', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com/luis/authoring/v3.0-preview/'])
+  .it('clones a luis app and returns the new version number', ctx => {
+    expect(ctx.stdout).to.contain('App successfully cloned.')
+  })
+
+})