Adding version unit tests (#410)

* Adding version unit tests

* Remove success mssg from version export and update test

Author: JSpru

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

@@ -51,7 +51,6 @@ export default class LuisVersionExport extends Command {
         this.log(`File successfully written: ${writtenFilePath}`)
       } else {
         await utils.writeToConsole(appJSON)
-        this.log('App successfully exported\n')
       }
     } catch (error) {
       throw new CLIError(error)

packages/luis/test/commands/luis/version/clone.test.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, 'processInputs').returnsArg(0)
+  })
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test
+  .stdout()
+  .command(['luis:version:clone', '--help'])
+  .it('should print the help contents when --help is passed as an argument', (ctx: any) => {
+    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'])
+  .it('displays an error if any required input parameters are missing', (ctx: any) => {
+    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'])
+  .it('displays an error if any required input parameters are missing', (ctx: any) => {
+    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'])
+  .it('clones a luis app and returns the new version number', (ctx: any) => {
+    expect(ctx.stdout).to.contain('App successfully cloned.')
+  })
+
+})

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

@@ -0,0 +1,58 @@
+import {expect, test} from '@oclif/test'
+const sinon = require('sinon')
+const uuidv1 = require('uuid/v1')
+const utils = require('../../../../src/utils/index')
+
+describe('luis:version:delete', () => {
+
+  beforeEach(() => {
+    sinon.stub(utils, 'processInputs').returnsArg(0)
+  })
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test
+  .stdout()
+  .command(['luis:version:delete', '--help'])
+  .it('should print the help contents when --help is passed as an argument', ctx => {
+    expect(ctx.stdout).to.contain('Deletes a LUIS application version')
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:version:delete', '--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 'appId' missing.`)
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:version:delete', '--appId', uuidv1(), '--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 'versionId' missing.`)
+  })
+
+  test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .delete(uri => uri.includes('version'))
+  .reply(200)
+  )
+  .stdout()
+  .command(['luis:version:delete', '--appId', uuidv1(), '--versionId', '0.2', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--subscriptionKey', uuidv1()])
+  .it('deletes a luis app and displays a success message', ctx => {
+    expect(ctx.stdout).to.contain('Successfully deleted version')
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:version:delete', '--appId', uuidv1(), '--versionId', '0.2', '--endpoint', 'undefined', '--subscriptionKey', uuidv1()])
+  .it('fails to delete an app and displays an error message if the endpoint is undefined', ctx => {
+    expect(ctx.stderr).to.contain('Failed to delete app version')
+  })
+
+})

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

@@ -0,0 +1,109 @@
+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:export', () => {
+
+  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:export', '--help'])
+  .it('should print the help contents when --help is passed as an argument', ctx => {
+    expect(ctx.stdout).to.contain('Exports a LUIS application to JSON format')
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:version:export', '--versionId', '0.1', '--subscriptionKey', uuidv1(), '--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 'appId' missing.`)
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:version:export', '--appId', uuidv1(), '--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 'versionId' missing.`)
+  })
+
+  test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .get(uri => uri.includes('export'))
+  .reply(200, {name: 'testname'})
+  )
+  .stdout()
+  .command(['luis:version:export', '--appId', uuidv1(), '--versionId', '0.1', '--subscriptionKey', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com'])
+  .it('exports a luis app and displays the export contents in the console', ctx => {
+    expect(ctx.stdout).to.contain('testname')
+  })
+
+  test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .get(uri => uri.includes('export'))
+  .reply(200, {name: 'testname'})
+  )
+  .stdout()
+  .command(['luis:version:export', '--appId', uuidv1(), '--out', './testout/test.json', '--versionId', '0.1', '--subscriptionKey', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com'])
+  .it('exports a luis app, displays a success message in the console and the export contents to the specified file', ctx => {
+    expect(ctx.stdout).to.contain('File successfully written:')
+  })
+
+  test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .get(uri => uri.includes('export'))
+  .reply(200, {name: 'testname'})
+  )
+  .stdout()
+  .stderr()
+  .command(['luis:version:export', '--appId', uuidv1(), '--out', 'xyz', '--versionId', '0.1', '--subscriptionKey', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com'])
+  .it('exports a luis app and displays a success message and the export contents in the console (since the target path provided is invalid)', ctx => {
+    expect(ctx.stderr).to.contain('Target directory path doesn\'t exist:')
+  })
+
+  test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .get(uri => uri.includes('export'))
+  .reply(200, {name: 'testname'})
+  )
+  .stdout()
+  .stderr()
+  .command(['luis:version:export', '--appId', uuidv1(), '--out', './testout/test.json', '--force', '--versionId', '0.1', '--subscriptionKey', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com'])
+  .it('exports a luis app, displays a success message in the console and the export contents to the specified file, overwriting the existing file of the same name', ctx => {
+    expect(ctx.stdout).to.contain('File successfully written')
+  })
+
+  test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .get(uri => uri.includes('export'))
+  .reply(200, {name: 'testname'})
+  )
+  .stdout()
+  .command(['luis:version:export', '--appId', uuidv1(), '--out', './testout/test.json', '--versionId', '0.1', '--subscriptionKey', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com'])
+  .it('exports a luis app, displays a success message in the console and the export contents to the specified file, incrementing the filename', ctx => {
+    expect(ctx.stdout).to.contain('File successfully written')
+    expect(ctx.stdout).to.contain('test(1).json')
+  })
+
+})

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

@@ -0,0 +1,92 @@
+import {expect, test} from '@oclif/test'
+const sinon = require('sinon')
+const uuidv1 = require('uuid/v1')
+const utils = require('../../../../src/utils/index')
+
+describe('luis:version:import', () => {
+
+  beforeEach(() => {
+    sinon.stub(utils, 'processInputs').returnsArg(0)
+    
+  })
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test
+  .stdout()
+  .command(['luis:version:import', '--help'])
+  .it('should print the help contents when --help is passed as an argument', ctx => {
+    expect(ctx.stdout).to.contain('Imports a new version into a LUIS application from JSON or LU content.')
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:version: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 'appId' missing.`)
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:version:import', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--appId', uuidv1()])
+  .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, '0.9')
+  )
+  .stdout()
+  .stderr()
+  .command(['luis:version:import', '--appId', uuidv1(), '--in', './test/fixtures/sample-app-version.json', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--subscriptionKey', uuidv1(), '--appId', uuidv1()])
+  .it('imports a luis app version from a file and returns the app\'s new version id', ctx => {
+    expect(ctx.stdout).to.contain('App version successfully imported as version 0.9')
+  })
+
+  test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .post(uri => uri.includes('apps'))
+  .reply(201, '0.7')
+  )
+  .stdout()
+  .stderr()
+  .command(['luis:version:import', '--versionId', '0.7', '--appId', uuidv1(), '--in', './test/fixtures/sample-app-version.json', '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--subscriptionKey', uuidv1(), '--appId', uuidv1()])
+  .it('imports a luis app version from a file and returns the app\'s new version id, as specified by the versionId flag', ctx => {
+    expect(ctx.stdout).to.contain('App version successfully imported as version 0.7')
+  })
+
+  test
+  .stdout()
+  .stderr()
+  .command(['luis:version:import', '--appId', uuidv1(), '--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:version:import', '--appId', uuidv1(), '--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.9","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:version:import', '--appId', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--subscriptionKey', uuidv1()])
+  .it('imports a luis app version from stdin and returns the app\'s id', ctx => {
+    process.stdin.setEncoding('utf8')
+    process.stdin.once('data', data => {
+      expect(ctx.stderr).to.contain('App version successfully imported as version 0.9')
+    })
+  })
+
+})