Stdin on QnAMaker (#186)

* Removing Disk I/O operatios as mandatory for lu transform

* Lu Merger refactor

* Removing duplicated code from filter

* Adding stdin readin to convert commands

* Adding object processing ability to translate commands

* Changing ts files to js in parser to keep it consistent

* Adding Converter to parser index

* Stdin ability ebanled for QnAMaker

* Fixing issue with stdin payload

* Merging correctly conflicts

Author: munozemilio

packages/qnamaker/src/commands/qnamaker/create/kb.ts

@@ -16,29 +16,33 @@ export default class QnamakerCreateKb extends Command {
   static description = 'Creates a new knowledgebase'
 
   static flags: flags.Input<any> = {
-    in: flags.string({description: 'The CreateKbDTO object to send in the body of the request.', required: true}),
+    in: flags.string({description: 'File path to the CreateKbDTO object to send in the body of the request.'}),
     name: flags.string({description: 'Name of the kb you want to create. This will override the name of KB that might be present in the CreateKb DTO'}),
     save: flags.boolean({description: 'Save the kbId in config.'}),
+    quiet: flags.boolean({description: 'Save the kbId in config.'}),
     subscriptionKey: flags.string({description: 'Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource Management section for your Qna Maker cognitive service). Overrides the subscriptionkey value present in config'}),
     help: flags.help({char: 'h', description: 'qnamaker:create:kb command help'}),
   }
 
   async run() {
     const {flags} = this.parse(QnamakerCreateKb)
+    const stdin = await this.readStdin()
+    if (!stdin && !flags.in) {
+      throw new CLIError('No input. Please set file path with --in or pipe required data to the command')
+    }
 
-    let input: Inputs = await processInputs(flags, createKbJSON, this.config.configDir)
+    let input: Inputs = await processInputs(flags, createKbJSON, this.config.configDir, stdin)
 
     if (flags.name) {
       input.requestBody.name = flags.name
     }
 
-    if (!input.requestBody.name) {
-      if (!(flags.q || flags.quiet)) {
-        let answer = readlineSync.question('What would you like to name your new knowledgebase?')
-        if (answer && answer.length > 0) {
-          input.requestBody.name = answer.trim()
-        }
+    if (!input.requestBody.name && flags.quiet) {
+      let answer = readlineSync.question('What would you like to name your new knowledgebase?')
+      if (answer && answer.length > 0) {
+        input.requestBody.name = answer.trim()
       }
+
     }
     // hack to map incorrect export property from expected import.  Export uses qnaDocuments, create/update/replace qnaList :(
     if (input.requestBody.qnaDocuments && !input.requestBody.qnaList) {

packages/qnamaker/src/commands/qnamaker/replace/alterations.ts

@@ -7,14 +7,20 @@ export default class QnamakerReplaceAlterations extends Command {
   static description = 'Replaces word alterations (synonyms) for the KB with the give records.'
 
   static flags: flags.Input<any> = {
-    in: flags.string({description: 'The WordAlterationsDTO object to send in the body of the request', required: true}),
+    in: flags.string({description: 'File path to the WordAlterationsDTO object to send in the body of the request'}),
     subscriptionKey: flags.string({description: 'Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource Management section for your Qna Maker cognitive service). Overrides the subscriptionkey value present in config'}),
     help: flags.help({char: 'h', description: 'qnamaker:replace:alterations command help'}),
   }
 
   async run() {
     const {flags} = this.parse(QnamakerReplaceAlterations)
-    let input: Inputs = await processInputs(flags, replaceAlterationsJSON, this.config.configDir)
+    const stdin = await this.readStdin()
+
+    if (!stdin && !flags.in) {
+      throw new CLIError('No input. Please set file path with --in or pipe required data to the command')
+    }
+
+    let input: Inputs = await processInputs(flags, replaceAlterationsJSON, this.config.configDir, stdin)
     // hack to map incorrect export property from expected import.  Export uses qnaDocuments, create/update/replace qnaList :(
     if (input.requestBody.qnaDocuments && !input.requestBody.qnaList) {
       input.requestBody.qnaList = input.requestBody.qnaDocuments

packages/qnamaker/src/commands/qnamaker/replace/kb.ts

@@ -8,15 +8,20 @@ export default class QnamakerReplaceKb extends Command {
   static description = 'Replace a knowledgebase contents with new contents'
 
   static flags: flags.Input<any> = {
-    in: flags.string({description: 'The ReplaceKbDTO object to send in the body of the request', required: true}),
+    in: flags.string({description: 'File path to the ReplaceKbDTO object to send in the body of the request'}),
     kbId: flags.string({description: 'Knowledgebase id.'}),
     subscriptionKey: flags.string({description: 'Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource Management section for your Qna Maker cognitive service). Overrides the subscriptionkey value present in config'}),
     help: flags.help({char: 'h', description: 'qnamaker:replace:kb command help'}),
   }
 
   async run() {
     const {flags} = this.parse(QnamakerReplaceKb)
-    let input: Inputs = await processInputs(flags, replaceKbJSON, this.config.configDir)
+    const stdin = await this.readStdin()
+    if (!stdin && !flags.in) {
+      throw new CLIError('No input. Please set file path with --in or pipe required data to the command')
+    }
+
+    let input: Inputs = await processInputs(flags, replaceKbJSON, this.config.configDir, stdin)
     // hack to map incorrect export property from expected import.  Export uses qnaDocuments, create/update/replace qnaList :(
     if (input.requestBody.qnaDocuments && !input.requestBody.qnaList) {
       input.requestBody.qnaList = input.requestBody.qnaDocuments

packages/qnamaker/src/commands/qnamaker/train.ts

@@ -7,7 +7,7 @@ export default class QnamakerTrain extends Command {
   static description = 'Train call to add suggestions to the knowledgebase.'
 
   static flags: flags.Input<any> = {
-    in: flags.string({description: 'The FeedbackRecordDTO object to send in the body of the request.', required: true}),
+    in: flags.string({description: 'File path to the FeedbackRecordDTO object to send in the body of the request.'}),
     subscriptionKey: flags.string({description: 'Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource Management section for your Qna Maker cognitive service). Overrides the subscriptionkey value present in config'}),
     hostname: flags.string({description: 'Specifies the url for your private QnA service. Overrides the value present in config.'}),
     endpointKey: flags.string({description: 'Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal user settings page). Overrides the value present in config.'}),
@@ -17,7 +17,12 @@ export default class QnamakerTrain extends Command {
 
   async run() {
     const {flags} = this.parse(QnamakerTrain)
-    let input: Inputs = await processInputs(flags, trainJSON, this.config.configDir)
+    const stdin = await this.readStdin()
+
+    if (!stdin && !flags.in) {
+      throw new CLIError('No input. Please set file path with --in or pipe required data to the command')
+    }
+    let input: Inputs = await processInputs(flags, trainJSON, this.config.configDir, stdin)
     const result = await qnamaker(input.config, input.serviceManifest, flags, input.requestBody)
     if (result.error) {
       throw new CLIError(JSON.stringify(result.error, null, 4))

packages/qnamaker/src/commands/qnamaker/update/kb.ts

@@ -9,7 +9,7 @@ export default class QnamakerUpdateKb extends Command {
   static description = 'Add or delete QnA Pairs and / or URLs to an existing knowledge base'
 
   static flags: flags.Input<any> = {
-    in: flags.string({description: 'The UpdateKbOperationDTO object to send in the body of the request.', required: true}),
+    in: flags.string({description: 'The file path to the UpdateKbOperationDTO object to send in the body of the request.'}),
     kbId: flags.string({description: 'Knowledgebase id.'}),
     wait: flags.boolean({description: 'Wait for the operation to complete.'}),
     subscriptionKey: flags.string({description: 'Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource Management section for your Qna Maker cognitive service). Overrides the subscriptionkey value present in config'}),
@@ -18,7 +18,11 @@ export default class QnamakerUpdateKb extends Command {
 
   async run() {
     const {flags} = this.parse(QnamakerUpdateKb)
-    let input: Inputs = await processInputs(flags, updateKbJSON, this.config.configDir)
+    const stdin = await this.readStdin()
+    if (!stdin && !flags.in) {
+      throw new CLIError('No input. Please set file path with --in or pipe required data to the command')
+    }
+    let input: Inputs = await processInputs(flags, updateKbJSON, this.config.configDir, stdin)
     // hack to map incorrect export property from expected import.  Export uses qnaDocuments, create/update/replace qnaList :(
     if (input.requestBody.qnaDocuments && !input.requestBody.qnaList) {
       input.requestBody.qnaList = input.requestBody.qnaDocuments

packages/qnamaker/src/utils/qnamakerbase.ts

@@ -1,24 +1,24 @@
 import {CLIError} from '@microsoft/bf-cli-command'
-const stdin = require('get-stdin')
+const fs = require('fs-extra')
+const path = require('path')
 const qnaconfig = require('./../../utils/qnaconfig')
 const srvMan = require('./../../utils/servicemanifest')
 const {ServiceBase} = require('./../../utils/api/serviceBase')
 
-export async function processInputs(flags: any, payload: any, configfile: string) {
+export async function processInputs(flags: any, payload: any, configfile: string, stdin = '') {
   let result: Inputs = {}
   const config = await qnaconfig.composeConfig(flags, configfile)
-  let service = {}
 
   try {
-    if (flags.stdin) {
-      let json = await stdin()
-      service = await JSON.parse(json)
-    }
-    qnaconfig.buildConfig(flags, service, config)
+    qnaconfig.buildConfig(flags, config)
     ServiceBase.config = flags
     await qnaconfig.validateConfig(flags)
     const serviceManifest = srvMan.getServiceManifest(payload)
+    flags.in = stdin ? stdin : flags.in
     result.requestBody = await srvMan.validateArguments(serviceManifest, flags)
+    if (stdin || flags.in) {
+      result.requestBody = stdin ? JSON.parse(stdin) : await getFileInput(flags.in)
+    }
     result.config = config
     result.serviceManifest = serviceManifest
   } catch (e) {
@@ -28,6 +28,12 @@ export async function processInputs(flags: any, payload: any, configfile: string
   return result
 }
 
+async function getFileInput(file: string) {
+  // Let any errors fall through to the runProgram() promise
+  let body = await fs.readJSON(path.resolve(file))
+  return body
+}
+
 export interface Inputs {
   [key: string]: any
 }

packages/qnamaker/test/commands/qnamaker/create/kb.test.ts

@@ -118,4 +118,13 @@ describe('qnamaker:create:kb --save', () => {
     let config = await fs.readJSON(getConfigFile())
     expect(config.qnamaker.kbId).to.contain('8600c573-2acf-4466-97e8-999ad4cecbc2')
   })
+})
+
+describe('qnamaker:create:kb No input', () => {
+  test
+  .stderr()
+  .command(['qnamaker:create:kb'])
+  .it('Creates kb qnamaker:create:kb --in', ctx => {
+    expect(ctx.stderr).to.contain('No input. Please set file path with --in or pipe required data to the command')
+  })
 })

packages/qnamaker/test/commands/qnamaker/replace/alterations.test.ts

@@ -23,4 +23,11 @@ describe('qnamaker:replace:alterations', () => {
     .it('runs qnamaker:replace:alterations', ctx => {
       expect(ctx.stdout).to.empty
     })
+
+    test
+    .stderr()
+    .command(['qnamaker:replace:alterations'])
+    .it('runs qnamaker:replace:alterations', ctx => {
+      expect(ctx.stderr).to.contain('No input. Please set file path with --in or pipe required data to the command')
+    })
 })

packages/qnamaker/test/commands/qnamaker/replace/kb.test.ts

@@ -22,4 +22,13 @@ describe('qnamaker:replace:kb', () => {
     .it('runs qnamaker:replace:kb --kbId xxxxxxxxxx --in replace.json', ctx => {
       expect(ctx.stdout).to.equal('')
     })
+
+    test
+    .stderr()
+    .command(['qnamaker:replace:kb'])
+    .it('runs qnamaker:replace:kb', ctx => {
+      expect(ctx.stderr).to.contain('No input. Please set file path with --in or pipe required data to the command')
+    })
+
+    
 })

packages/qnamaker/test/commands/qnamaker/train.test.ts

@@ -1,5 +1,10 @@
 import {expect, test} from '@oclif/test'
 
 describe('qnamaker:train', () => {
-
+    test
+    .stderr()
+    .command(['qnamaker:train'])
+    .it('qnamaker:train no input passed', ctx => {
+      expect(ctx.stderr).to.contain('No input. Please set file path with --in or pipe required data to the command')
+    })
 })