Add luis:application:publish cmd (#376)

Author: JSpru

packages/luis/src/commands/luis/application/publish.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 LuisApplicationPublish extends Command {
+  static description = 'Publishes a specific version of the application'
+
+  static examples = [`
+    $ bf luis:application:publish --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --versionId {INITIAL_VERSION_ID} --appId {APP_ID} --staging {BOOLEAN}
+  `]
+
+  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 applicaton id'}),
+    versionId: flags.string({description: 'LUIS application initial version Id'}),
+    staging: flags.string({description: 'Publishes application version to Staging slot, otherwise publish to production (default: false)'}),
+    direct: flags.string({description: 'Available only in direct version query. Do not publish to staging or production (default: false)'})
+  }
+
+  async run() {
+    const {flags} = this.parse(LuisApplicationPublish)
+    const flagLabels = Object.keys(LuisApplicationPublish.flags)
+    const configDir = this.config.configDir
+
+    const {
+      endpoint,
+      subscriptionKey,
+      appId,
+      versionId,
+      staging,
+      direct
+    } = await utils.processInputs(flags, flagLabels, configDir)
+
+    const requiredProps = {endpoint, subscriptionKey, appId, versionId}
+    utils.validateRequiredProps(requiredProps)
+
+    const client = utils.getLUISClient(subscriptionKey, endpoint)
+
+    const applicationCreateObject = {
+      versionId,
+      isStaging: (staging === 'true'),
+      directVersionPublish: (direct === 'true')
+    }
+
+    try {
+      const publishedAppData = await client.apps.publish(appId, applicationCreateObject)
+      this.log(`App successfully published.\n${JSON.stringify(publishedAppData)}`)
+    } catch (err) {
+      throw new CLIError(`Failed to publish app: ${err}`)
+    }
+  }
+}

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

@@ -0,0 +1,71 @@
+import {expect, test} from '@oclif/test'
+const sinon = require('sinon')
+const uuidv1 = require('uuid/v1')
+const utils = require('../../../../src/utils/index')
+
+describe('luis:application:publish', () => {
+
+  before(() => {
+    const newAppId = uuidv1()
+  })
+
+  beforeEach(() => {
+    sinon.stub(utils, 'processInputs').returnsArg(0)
+  })
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test
+  .stdout()
+  .command(['luis:application:publish', '--help'])
+  .it('should print the help contents when --help is passed as an argument', ctx => {
+    expect(ctx.stdout).to.contain('Publishes a specific version of the application')
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:application:publish', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--subscriptionKey', uuidv1(), '--appId', uuidv1()])
+  .it('displays an error if any required input parameters are missing', ctx => {
+    expect(ctx.stderr).to.contain(`Required input property 'versionId' missing.`)
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:application:publish', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--appId', uuidv1(), '--versionId', '0.01'])
+  .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('publish'))
+  .reply(201, {"versionId":"0.1","isStaging":true,"endpointUrl":"https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/4e3d6aec-f79e-4688-b686-feaf6dc2feee","region":"westus","endpointRegion":"westus","failedRegions":"","publishedDateTime":"2019-11-21T21:54:30Z"})
+  )
+  .stdout()
+  .command(['luis:application:publish', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--appId', uuidv1(), '--subscriptionKey', uuidv1(), '--versionId', '0.01'])
+  .it('publishes a luis app and displays the published app data', ctx => {
+    expect(ctx.stdout).to.contain('versionId')
+    expect(ctx.stdout).to.contain('isStaging')
+    expect(ctx.stdout).to.contain('endpointUrl')
+    expect(ctx.stdout).to.contain('publishedDateTime')
+  })
+
+  test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .post(uri => uri.includes('publish'))
+  .reply(201, {"versionId":"0.1","isStaging":true,"endpointUrl":"https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/4e3d6aec-f79e-4688-b686-feaf6dc2feee","region":"westus","endpointRegion":"westus","failedRegions":"","publishedDateTime":"2019-11-21T21:54:30Z"})
+  )
+  .stdout()
+  .command(['luis:application:publish', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--appId', uuidv1(), '--subscriptionKey', uuidv1(), '--versionId', '0.01', '--staging', 'true', '--direct', 'false' ])
+  .it('publishes a luis app with optional flags and displays the published app data', ctx => {
+    expect(ctx.stdout).to.contain('versionId')
+    expect(ctx.stdout).to.contain('isStaging')
+    expect(ctx.stdout).to.contain('endpointUrl')
+    expect(ctx.stdout).to.contain('publishedDateTime')
+  })
+
+})