resolve luis build issues (#804)

* luis build do not write dialogs if no --out specified

* qnamaker:build do not write .dialog if no --out is specified

* fix suffix issue in luis build

* revert qnamaker changes in this PR and add to another

* fix typo

Co-authored-by: Emilio Munoz <[email protected]>

Author: feich-ms

packages/luis/README.md

@@ -339,13 +339,13 @@ USAGE
   $ bf luis:build
 
 OPTIONS
-  -f, --force                      If --dialog flag is provided, overwrites relevant dialog file
+  -f, --force                      If --out flag is provided, overwrites relevant dialog file
   -h, --help                       show CLI help
   -i, --in=in                      Lu file or folder
 
-  -o, --out=out                    Output file or folder name. If not specified, current directory will be used as
-                                   output
-
+  -o, --out=out                    Output folder name to write out .dialog files. If not specified, application
+                                   ids will be output to console
+                                   
   --authoringKey=authoringKey      LUIS authoring key
 
   --botName=botName                Bot name
@@ -354,11 +354,10 @@ OPTIONS
 
   --deleteOldVersion               Delete old version of LUIS application after building new one.
 
-  --dialog=dialog                  [default: multiLanguage] Write out .dialog files whose recognizer type
-                                   [multiLanguage|crosstrained] is specified by --dialog
+  --dialog=dialog                  [default: multiLanguage] Dialog recognizer type [multiLanguage|crosstrained]
 
   --fallbackLocale=fallbackLocale  Locale to be used at the fallback if no locale specific recognizer is found. Only
-                                   valid if --dialog is set
+                                   valid if --out is set
 
   --log                            write out log messages to console
 

packages/luis/src/commands/luis/build.ts

@@ -32,12 +32,12 @@ export default class LuisBuild extends Command {
     authoringKey: flags.string({description: 'LUIS authoring key'}),
     botName: flags.string({description: 'Bot name'}),
     region: flags.string({description: 'LUIS authoring region [westus|westeurope|australiaeast]', default: 'westus'}),
-    out: flags.string({char: 'o', description: 'Output file or folder name. If not specified, current directory will be used as output'}),
+    out: flags.string({char: 'o', description: 'Output folder name to write out .dialog files. If not specified, application ids will be output to console'}),
     defaultCulture: flags.string({description: 'Culture code for the content. Infer from .lu if available. Defaults to en-us'}),
-    fallbackLocale: flags.string({description: 'Locale to be used at the fallback if no locale specific recognizer is found. Only valid if --dialog is set'}),
+    fallbackLocale: flags.string({description: 'Locale to be used at the fallback if no locale specific recognizer is found. Only valid if --out is set'}),
     suffix: flags.string({description: 'Environment name as a suffix identifier to include in LUIS app name. Defaults to current logged in user alias'}),
-    dialog: flags.string({description: 'Write out .dialog files whose recognizer type [multiLanguage|crosstrained] is specified by --dialog', default: 'multiLanguage'}),
-    force: flags.boolean({char: 'f', description: 'If --dialog flag is provided, overwrites relevant dialog file', default: false}),
+    dialog: flags.string({description: 'Dialog recognizer type [multiLanguage|crosstrained]', default: 'multiLanguage'}),
+    force: flags.boolean({char: 'f', description: 'If --out flag is provided, overwrites relevant dialog file', default: false}),
     luConfig: flags.string({description: 'Path to config for lu build which can contain switches for arguments'}),
     deleteOldVersion: flags.boolean({description: 'Delete old version of LUIS application after building new one.'}),
     log: flags.boolean({description: 'write out log messages to console', default: false}),
@@ -139,13 +139,12 @@ export default class LuisBuild extends Command {
 
       // update or create and then train and publish luis applications based on loaded resources
       if (log) this.log('Handling applications...')
-      const dialogContents = await builder.build(luContents, recognizers, authoringKey, endpoint, botName, flags.suffix, fallbackLocale, deleteOldVersion, multiRecognizers, settings)
+      const dialogContents = await builder.build(luContents, recognizers, authoringKey, endpoint, botName, suffix, fallbackLocale, deleteOldVersion, multiRecognizers, settings)
 
       // write dialog assets based on config
-      if (dialog) {
-        const writeDone = await builder.writeDialogAssets(dialogContents, force, out, dialog, luConfig)
-        const dialogFilePath = (flags.stdin || !inVal) ? process.cwd() : inVal.endsWith(fileExtEnum.LUFile) ? path.dirname(path.resolve(inVal)) : path.resolve(inVal)
-        const outputFolder = out ? path.resolve(out) : dialogFilePath
+      if (out) {
+        const outputFolder = path.resolve(out)
+        const writeDone = await builder.writeDialogAssets(dialogContents, force, outputFolder, dialog, luConfig)
         if (writeDone) {
           this.log(`Successfully wrote .dialog files to ${outputFolder}\n`)
         } else {

packages/luis/test/commands/luis/build.test.ts

@@ -73,9 +73,7 @@ describe('luis:build cli parameters test', () => {
 })
 
 describe('luis:build create a new application successfully', () => {
-  before(async function () {
-    await fs.ensureDir(path.join(__dirname, './../../../results/'))
-
+  before(function () {
     nock('https://westus.api.cognitive.microsoft.com')
       .get(uri => uri.includes('apps'))
       .reply(200, [{
@@ -115,13 +113,9 @@ describe('luis:build create a new application successfully', () => {
       })
   })
 
-  after(async function () {
-    await fs.remove(path.join(__dirname, './../../../results/'))
-  })
-
   test
     .stdout()
-    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/sandwich//lufiles/sandwich.en-us.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--log', '--suffix', 'development', '--out', './results'])
+    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/sandwich//lufiles/sandwich.en-us.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--log', '--suffix', 'development'])
     .it('should create a new application successfully', ctx => {
       expect(ctx.stdout).to.contain('Handling applications...')
       expect(ctx.stdout).to.contain('Creating LUIS.ai application')
@@ -134,9 +128,7 @@ describe('luis:build create a new application successfully', () => {
 
 describe('luis:build update application succeed when utterances changed', () => {
   const existingLuisApp = require('./../../fixtures/testcases/lubuild/sandwich/luis/test(development)-sandwich.utteranceChanged.en-us.lu.json')
-  before(async function () {
-    await fs.ensureDir(path.join(__dirname, './../../../results/'))
-
+  before(function () {
     nock('https://westus.api.cognitive.microsoft.com')
       .get(uri => uri.includes('apps'))
       .reply(200, [{
@@ -186,13 +178,9 @@ describe('luis:build update application succeed when utterances changed', () =>
       })
   })
 
-  after(async function () {
-    await fs.remove(path.join(__dirname, './../../../results/'))
-  })
-
   test
     .stdout()
-    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/sandwich/lufiles/sandwich.en-us.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--log', '--suffix', 'development', '--out', './results'])
+    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/sandwich/lufiles/sandwich.en-us.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--log', '--suffix', 'development'])
     .it('should update a luis application when utterances changed', ctx => {
       expect(ctx.stdout).to.contain('Handling applications...')
       expect(ctx.stdout).to.contain('creating version=0.2')
@@ -205,9 +193,7 @@ describe('luis:build update application succeed when utterances changed', () =>
 
 describe('luis:build update application succeed when utterances added', () => {
   const existingLuisApp = require('./../../fixtures/testcases/lubuild/sandwich/luis/test(development)-sandwich.utteranceAdded.en-us.lu.json')
-  before(async function () {
-    await fs.ensureDir(path.join(__dirname, './../../../results/'))
-
+  before(function () {
     nock('https://westus.api.cognitive.microsoft.com')
       .get(uri => uri.includes('apps'))
       .reply(200, [{
@@ -257,13 +243,9 @@ describe('luis:build update application succeed when utterances added', () => {
       })
   })
 
-  after(async function () {
-    await fs.remove(path.join(__dirname, './../../../results/'))
-  })
-
   test
     .stdout()
-    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/sandwich/lufiles/sandwich.en-us.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--log', '--suffix', 'development', '--out', './results'])
+    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/sandwich/lufiles/sandwich.en-us.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--log', '--suffix', 'development'])
     .it('should update a luis application when utterances added', ctx => {
       expect(ctx.stdout).to.contain('Handling applications...')
       expect(ctx.stdout).to.contain('creating version=0.2')
@@ -276,9 +258,7 @@ describe('luis:build update application succeed when utterances added', () => {
 
 describe('luis:build not update application if no changes', () => {
   const existingLuisApp = require('./../../fixtures/testcases/lubuild/sandwich/luis/test(development)-sandwich.en-us.lu.json')
-  before(async function () {
-    await fs.ensureDir(path.join(__dirname, './../../../results/'))
-
+  before(function () {
     nock('https://westus.api.cognitive.microsoft.com')
       .get(uri => uri.includes('apps'))
       .reply(200, [{
@@ -299,13 +279,9 @@ describe('luis:build not update application if no changes', () => {
       .reply(200, existingLuisApp)
   })
 
-  after(async function () {
-    await fs.remove(path.join(__dirname, './../../../results/'))
-  })
-
   test
     .stdout()
-    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/sandwich/lufiles/sandwich.en-us.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--log', '--suffix', 'development', '--out', './results'])
+    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/sandwich/lufiles/sandwich.en-us.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--log', '--suffix', 'development'])
     .it('should not update a luis application when there are no changes for the coming lu file', ctx => {
       expect(ctx.stdout).to.contain('Handling applications...')
       expect(ctx.stdout).to.contain('no changes')
@@ -343,7 +319,7 @@ describe('luis:build write dialog assets successfully if --dialog set to multiLa
 
   test
     .stdout()
-    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/sandwich/lufiles/sandwich.en-us.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--dialog', 'multiLanguage', '--out', './results', '--log', '--suffix', 'development'])
+    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/sandwich/lufiles/sandwich.en-us.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--out', './results', '--log', '--suffix', 'development'])
     .it('should write dialog assets successfully when --dialog set to multiLanguage', async ctx => {
       expect(await compareFiles('./../../../results/luis.settings.development.westus.json', './../../fixtures/testcases/lubuild/sandwich/config/luis.settings.development.westus.json')).to.be.true
       expect(await compareFiles('./../../../results/sandwich.en-us.lu.dialog', './../../fixtures/testcases/lubuild/sandwich/dialogs/sandwich.en-us.lu.dialog')).to.be.true
@@ -642,9 +618,7 @@ describe('luis:build update dialog assets successfully when dialog assets exist'
 
 describe('luis:build not update application if only cases of utterances or patterns are changed', () => {
   const existingLuisApp = require('./../../fixtures/testcases/lubuild/case-insensitive/luis/test(development)-case-insensitive.en-us.lu.json')
-  before(async function () {
-    await fs.ensureDir(path.join(__dirname, './../../../results/'))
-
+  before(function () {
     nock('https://westus.api.cognitive.microsoft.com')
       .get(uri => uri.includes('apps'))
       .reply(200, [{
@@ -665,13 +639,9 @@ describe('luis:build not update application if only cases of utterances or patte
       .reply(200, existingLuisApp)
   })
 
-  after(async function () {
-    await fs.remove(path.join(__dirname, './../../../results/'))
-  })
-
   test
     .stdout()
-    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/case-insensitive/lufiles/case-insensitive.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--log', '--suffix', 'development', '--out', './results'])
+    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/case-insensitive/lufiles/case-insensitive.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--log', '--suffix', 'development'])
     .it('should not update a luis application when only cases of utterances or patterns are different for the coming lu file', ctx => {
       expect(ctx.stdout).to.contain('Handling applications...')
       expect(ctx.stdout).to.contain('no changes')
@@ -755,7 +725,6 @@ describe('luis:build update application succeed with parameters set from luconfi
     .stdout()
     .command(['luis:build', '--authoringKey', uuidv1(), '--luConfig', './test/fixtures/testcases/lubuild/luconfig/lufiles/luconfig.json', '--log', '--suffix', 'development'])
     .it('should update a luis application when utterances changed', async ctx => {
-      console.log(ctx)
       expect(ctx.stdout).to.contain('Handling applications...')
       expect(ctx.stdout).to.contain('creating version=0.2')
       expect(ctx.stdout).to.contain('deleting old version=0.1')
@@ -771,9 +740,7 @@ describe('luis:build update application succeed with parameters set from luconfi
 })
 
 describe('luis:build create a new application successfully with locale set to it-it', () => {
-  before(async function () {
-    await fs.ensureDir(path.join(__dirname, './../../../results/'))
-
+  before(function () {
     nock('https://westus.api.cognitive.microsoft.com')
       .get(uri => uri.includes('apps'))
       .reply(200, [{
@@ -813,13 +780,9 @@ describe('luis:build create a new application successfully with locale set to it
       })
   })
 
-  after(async function () {
-    await fs.remove(path.join(__dirname, './../../../results/'))
-  })
-
   test
     .stdout()
-    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/file-with-personName/personName.en-us.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--log', '--suffix', 'development', '--out', './results', '--defaultCulture', 'it-it'])
+    .command(['luis:build', '--in', './test/fixtures/testcases/lubuild/file-with-personName/personName.en-us.lu', '--authoringKey', uuidv1(), '--botName', 'test', '--log', '--suffix', 'development', '--defaultCulture', 'it-it'])
     .it('should create a new application successfully for prebuilt entity personName with locale set to it-it', ctx => {
       expect(ctx.stdout).to.contain('Handling applications...')
       expect(ctx.stdout).to.contain('Creating LUIS.ai application')