botium-core 1.12.5 → 1.12.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "botium-core",
-  "version": "1.12.5",
+  "version": "1.12.6",
   "description": "The Selenium for Chatbots",
   "main": "index.js",
   "module": "dist/botium-es.js",

package/src/scripting/Convo.js

@@ -535,7 +535,7 @@ class Convo {
       if (container.caps[Capabilities.SCRIPTING_ENABLE_SKIP_ASSERT_ERRORS]) {
         const transcriptStepErrs = transcript.steps.filter(s => s.err).map(s => s.err)
         if (transcriptStepErrs && transcriptStepErrs.length > 0) {
-          transcript.err = botiumErrorFromList([transcriptStepErrs, transcript.err].filter(e => e), {})
+          transcript.err = botiumErrorFromList([...transcriptStepErrs.filter(err => err !== transcript.err), transcript.err].filter(e => e), {})
         }
       }
     }

package/src/scripting/helper.js

@@ -77,6 +77,13 @@ const flatString = (str) => {
   return str ? str.split('\n').map(s => s.trim()).join(' ') : ''
 }
 
+const _formatAppendArgs = (args) => {
+  return args ? ` ${args.map(a => _.isString(a) ? a.replace(/\|/g, '\\|') : `${a}`).join('|')}` : ''
+}
+const _parseArgs = (str) => {
+  return (str && str.length > 0 && str.replace(/\\\|/g, '###ESCAPESPLIT###').split('|').map(s => s.replace(/###ESCAPESPLIT###/g, '|').trim())) || []
+}
+
 const linesToConvoStep = (lines, sender, context, eol, singleLineMode = false) => {
   if (!validateSender(sender)) throw new Error(`Failed to parse conversation. Section "${sender}" unknown.`)
 
@@ -106,14 +113,14 @@ const linesToConvoStep = (lines, sender, context, eol, singleLineMode = false) =
       }
       const name = logicLine.split(' ')[0]
       if (sender !== 'me' && context.IsAsserterValid(name)) {
-        const args = (logicLine.length > name.length ? logicLine.substr(name.length + 1).split('|').map(a => a.trim()) : [])
+        const args = (logicLine.length > name.length ? _parseArgs(logicLine.substr(name.length + 1)) : [])
         convoStep.asserters.push({ name, args, not, optional })
       } else if (sender === 'me' && context.IsUserInputValid(name)) {
-        const args = (logicLine.length > name.length ? logicLine.substr(name.length + 1).split('|').map(a => a.trim()) : [])
+        const args = (logicLine.length > name.length ? _parseArgs(logicLine.substr(name.length + 1)) : [])
         convoStep.userInputs.push({ name, args })
         textLinesAccepted = false
       } else if (context.IsLogicHookValid(name)) {
-        const args = (logicLine.length > name.length ? logicLine.substr(name.length + 1).split('|').map(a => a.trim()) : [])
+        const args = (logicLine.length > name.length ? _parseArgs(logicLine.substr(name.length + 1)) : [])
         convoStep.logicHooks.push({ name, args })
         textLinesAccepted = false
       } else {
@@ -422,7 +429,7 @@ const convoStepToLines = (step) => {
   const lines = []
   if (step.sender === 'me') {
     step.forms && step.forms.filter(form => form.value).forEach((form) => {
-      lines.push(`FORM ${form.name}|${form.value}`)
+      lines.push(`FORM${_formatAppendArgs([form.name, form.value])}`)
     })
     if (step.buttons && step.buttons.length > 0) {
       lines.push('BUTTON ' + _decompileButton(step.buttons[0]))
@@ -432,34 +439,34 @@ const convoStepToLines = (step) => {
       lines.push(step.messageText)
     }
     step.userInputs && step.userInputs.forEach((userInput) => {
-      lines.push(userInput.name + (userInput.args ? ' ' + userInput.args.join('|') : ''))
+      lines.push(userInput.name + _formatAppendArgs(userInput.args))
     })
     step.logicHooks && step.logicHooks.forEach((logicHook) => {
-      lines.push(logicHook.name + (logicHook.args ? ' ' + logicHook.args.join('|') : ''))
+      lines.push(logicHook.name + _formatAppendArgs(logicHook.args))
     })
   } else {
     if (step.messageText) {
       lines.push((step.optional ? '?' : '') + (step.not ? '!' : '') + step.messageText)
     }
-    if (step.buttons && step.buttons.length > 0) lines.push('BUTTONS ' + step.buttons.filter(b => b.text).map(b => flatString(b.text)).join('|'))
-    if (step.media && step.media.length > 0) lines.push('MEDIA ' + step.media.filter(m => !m.buffer && m.mediaUri).map(m => m.mediaUri).join('|'))
+    if (step.buttons && step.buttons.length > 0) lines.push('BUTTONS' + _formatAppendArgs(step.buttons.filter(b => b.text).map(b => flatString(b.text))))
+    if (step.media && step.media.length > 0) lines.push('MEDIA' + _formatAppendArgs(step.media.filter(m => !m.buffer && m.mediaUri).map(m => m.mediaUri)))
     if (step.cards && step.cards.length > 0) {
       step.cards.forEach(c => {
         let cardTexts = []
         if (c.text) cardTexts = cardTexts.concat(_.isArray(c.text) ? c.text : [c.text])
         if (c.subtext) cardTexts = cardTexts.concat(_.isArray(c.subtext) ? c.subtext : [c.subtext])
         if (c.content) cardTexts = cardTexts.concat(_.isArray(c.content) ? c.content : [c.content])
-        if (cardTexts.length > 0) lines.push('CARDS ' + cardTexts.map(c => flatString(c)).join('|'))
+        if (cardTexts.length > 0) lines.push('CARDS' + _formatAppendArgs(cardTexts.map(c => flatString(c))))
 
-        if (c.buttons && c.buttons.length > 0) lines.push('BUTTONS ' + c.buttons.filter(b => b.text).map(b => flatString(b.text)).join('|'))
+        if (c.buttons && c.buttons.length > 0) lines.push('BUTTONS' + _formatAppendArgs(c.buttons.filter(b => b.text).map(b => flatString(b.text))))
         if (c.image && !c.image.buffer && c.image.mediaUri) lines.push('MEDIA ' + c.image.mediaUri)
       })
     }
     step.asserters && step.asserters.forEach((asserter) => {
-      lines.push((asserter.optional ? '?' : '') + (asserter.not ? '!' : '') + asserter.name + (asserter.args ? ' ' + asserter.args.join('|') : ''))
+      lines.push((asserter.optional ? '?' : '') + (asserter.not ? '!' : '') + asserter.name + _formatAppendArgs(asserter.args))
     })
     step.logicHooks && step.logicHooks.forEach((logicHook) => {
-      lines.push(logicHook.name + (logicHook.args ? ' ' + logicHook.args.join('|') : ''))
+      lines.push(logicHook.name + _formatAppendArgs(logicHook.args))
     })
   }
   return lines.map(l => l.trim())

package/src/scripting/logichook/asserter/ButtonsAsserter.js

@@ -1,5 +1,7 @@
+const { SCRIPTING_NORMALIZE_TEXT } = require('../../../Capabilities')
 const { BotiumError } = require('../../BotiumError')
 const { buttonsFromMsg } = require('../helpers')
+const { normalizeText } = require('../../helper')
 
 module.exports = class ButtonsAsserter {
   constructor (context, caps = {}) {
@@ -9,14 +11,14 @@ module.exports = class ButtonsAsserter {
   }
 
   _evalButtons (args, botMsg) {
-    const allButtons = buttonsFromMsg(botMsg, true).map(b => b.text)
+    const allButtons = buttonsFromMsg(botMsg, true).map(b => b.text).filter(b => b).map(b => normalizeText(b, !!this.caps[SCRIPTING_NORMALIZE_TEXT]))
     if (!args || args.length === 0) {
       return { allButtons, buttonsNotFound: [], buttonsFound: allButtons }
     }
     const buttonsNotFound = []
     const buttonsFound = []
     for (let i = 0; i < (args || []).length; i++) {
-      if (allButtons.findIndex(b => this.context.Match(b, args[i])) < 0) {
+      if (allButtons.findIndex(b => this.context.Match(b, normalizeText(args[i], !!this.caps[SCRIPTING_NORMALIZE_TEXT]))) < 0) {
         buttonsNotFound.push(args[i])
       } else {
         buttonsFound.push(args[i])

package/src/scripting/logichook/asserter/CardsAsserter.js

@@ -1,5 +1,7 @@
+const { SCRIPTING_NORMALIZE_TEXT } = require('../../../Capabilities')
 const { BotiumError } = require('../../BotiumError')
 const { cardsFromMsg } = require('../helpers')
+const { normalizeText } = require('../../helper')
 
 module.exports = class CardsAsserter {
   constructor (context, caps = {}) {
@@ -9,14 +11,14 @@ module.exports = class CardsAsserter {
   }
 
   _evalCards (args, botMsg) {
-    const allCards = cardsFromMsg(botMsg, true).reduce((acc, mc) => acc.concat([mc.text, mc.subtext, mc.content].filter(t => t)), [])
+    const allCards = cardsFromMsg(botMsg, true).reduce((acc, mc) => acc.concat([mc.text, mc.subtext, mc.content].filter(t => t).map(t => normalizeText(t, !!this.caps[SCRIPTING_NORMALIZE_TEXT]))), [])
     if (!args || args.length === 0) {
       return { allCards, cardsNotFound: [], cardsFound: allCards }
     }
     const cardsNotFound = []
     const cardsFound = []
     for (let i = 0; i < (args || []).length; i++) {
-      if (allCards.findIndex(c => this.context.Match(c, args[i])) < 0) {
+      if (allCards.findIndex(c => this.context.Match(c, normalizeText(args[i], !!this.caps[SCRIPTING_NORMALIZE_TEXT]))) < 0) {
         cardsNotFound.push(args[i])
       } else {
         cardsFound.push(args[i])

package/test/compiler/compilertxt.spec.js

@@ -308,5 +308,18 @@ describe('compiler.compilertxt', function () {
       assert.equal(convo.conversation[0].asserters.length, 1)
       assert.deepEqual(convo.conversation[0].asserters[0], { name: 'BUTTONS', args: ['Test1', 'Test2'], not: true, optional: false })
     })
+    it('should allow escape pipe for args', async function () {
+      const scriptBuffer = fs.readFileSync(path.resolve(__dirname, CONVOS_DIR, 'convos_args_escape.convo.txt'))
+      const context = buildContextWithPause()
+      const caps = {
+      }
+      const compiler = new Compiler(context, Object.assign({}, DefaultCapabilities, caps))
+
+      compiler.Compile(scriptBuffer, 'SCRIPTING_TYPE_CONVO')
+      const convo = context.convos[0]
+      assert.equal(convo.conversation.length, 1)
+      assert.equal(convo.conversation[0].asserters.length, 1)
+      assert.deepEqual(convo.conversation[0].asserters[0], { name: 'BUTTONS', args: ['Test|1', 'Test|2'], not: false, optional: false })
+    })
   })
 })

package/test/compiler/convos/txt/convos_args_escape.convo.txt

@@ -0,0 +1,2 @@
+#bot
+BUTTONS Test\|1|Test\|2

package/test/convo/convos/continuefailing_timeout.convo.txt

@@ -0,0 +1,16 @@
+continuefailing
+
+#me
+Hello
+
+#bot
+Hello
+
+#me
+Hello again!
+
+#bot
+Hello again FAILING!
+
+#bot
+working again

package/test/convo/transcript.spec.js

@@ -47,7 +47,8 @@ describe('convo.transcript', function () {
       [Capabilities.PROJECTNAME]: 'convo.transcript',
       [Capabilities.CONTAINERMODE]: echoConnector,
       [Capabilities.SCRIPTING_ENABLE_MULTIPLE_ASSERT_ERRORS]: true,
-      [Capabilities.SCRIPTING_ENABLE_SKIP_ASSERT_ERRORS]: true
+      [Capabilities.SCRIPTING_ENABLE_SKIP_ASSERT_ERRORS]: true,
+      [Capabilities.WAITFORBOTTIMEOUT]: 500
     }
     this.driverSkipAssertErrors = new BotDriver(myCapsSkipAssertErrors)
     this.compilerSkipAssertErrors = this.driverSkipAssertErrors.BuildCompiler()
@@ -381,4 +382,20 @@ describe('convo.transcript', function () {
       assert.isNull(err.transcript.steps[5].err)
     }
   })
+  it('should continue on failing assertion with timeout', async function () {
+    this.compilerSkipAssertErrors.ReadScript(path.resolve(__dirname, 'convos'), 'continuefailing_timeout.convo.txt')
+    assert.equal(this.compilerSkipAssertErrors.convos.length, 1)
+
+    try {
+      await this.compilerSkipAssertErrors.convos[0].Run(this.containerSkipAssertErrors)
+      assert.fail('expected error')
+    } catch (err) {
+      assert.isDefined(err.cause)
+      assert.equal(err.cause.message, 'continuefailing/Line 12: Bot response (on Line 9: #me - Hello again!) "Hello again!" expected to match "Hello again FAILING!",\ncontinuefailing/Line 15: error waiting for bot - Bot did not respond within 500ms')
+      assert.equal(err.cause.context.errors.length, 2)
+
+      assert.isDefined(err.transcript)
+      assert.equal(err.transcript.steps.length, 5)
+    }
+  })
 })

package/test/scripting/asserters/buttonsAsserter.spec.js

@@ -263,3 +263,50 @@ describe('scripting.asserters.buttonsCountAsserter', function () {
     })
   })
 })
+
+describe('scripting.asserters.buttonsNormalizeAsserter', function () {
+  beforeEach(async function () {
+    this.cardsAsserter = new ButtonsAsserter({
+      Match: (botresponse, utterance) => botresponse.toLowerCase().indexOf(utterance.toLowerCase()) >= 0
+    }, { SCRIPTING_NORMALIZE_TEXT: true })
+  })
+
+  it('should succeed with normalized text', async function () {
+    await this.cardsAsserter.assertConvoStep({
+      convoStep: { stepTag: 'test' },
+      args: ['Test Html header      test html text'],
+      botMsg: {
+        buttons: [
+          {
+            text: '<html><h1>test html header</h1><p>test html text</p>'
+          }
+        ]
+      }
+    })
+  })
+
+  it('should fail with normalized text', async function () {
+    try {
+      await this.cardsAsserter.assertConvoStep({
+        convoStep: { stepTag: 'test' },
+        args: ['Test Html header1      test html text'],
+        botMsg: {
+          buttons: [
+            {
+              text: '<html><h1>test html header</h1><p>test html text</p>'
+            }
+          ]
+        }
+      })
+      assert.fail('should have failed')
+    } catch (err) {
+      assert.isTrue(err.message.indexOf('Expected button(s) with text "Test Html header1      test html text"') > 0)
+      assert.isNotNull(err.context)
+      assert.isNotNull(err.context.cause)
+      assert.isArray(err.context.cause.expected)
+      assert.deepEqual(err.context.cause.expected, ['Test Html header1      test html text'])
+      assert.deepEqual(err.context.cause.actual, ['test html header test html text'])
+      assert.deepEqual(err.context.cause.diff, ['Test Html header1      test html text'])
+    }
+  })
+})

package/test/scripting/asserters/cardsAsserter.spec.js

@@ -243,3 +243,42 @@ describe('scripting.asserters.cardsCountAsserter', function () {
     })
   })
 })
+
+describe('scripting.asserters.cardsNormalizeAsserter', function () {
+  beforeEach(async function () {
+    this.cardsAsserter = new CardsAsserter({
+      Match: (botresponse, utterance) => botresponse.toLowerCase().indexOf(utterance.toLowerCase()) >= 0
+    }, { SCRIPTING_NORMALIZE_TEXT: true })
+  })
+
+  it('should succeed with normalized text', async function () {
+    await this.cardsAsserter.assertConvoStep({
+      convoStep: { stepTag: 'test' },
+      args: ['Test Html header      test html text'],
+      botMsg: {
+        cards: [{ text: '<html><h1>test html header</h1><p>test html text</p>' }]
+      }
+    })
+  })
+
+  it('should fail with normalized text', async function () {
+    try {
+      await this.cardsAsserter.assertConvoStep({
+        convoStep: { stepTag: 'test' },
+        args: ['Test Html header1      test html text'],
+        botMsg: {
+          cards: [{ text: '<html><h1>test html header</h1><p>test html text</p>' }]
+        }
+      })
+      assert.fail('should have failed')
+    } catch (err) {
+      assert.isTrue(err.message.indexOf('Expected card(s) with text "Test Html header1      test html text"') > 0)
+      assert.isNotNull(err.context)
+      assert.isNotNull(err.context.cause)
+      assert.isArray(err.context.cause.expected)
+      assert.deepEqual(err.context.cause.expected, ['Test Html header1      test html text'])
+      assert.deepEqual(err.context.cause.actual, ['test html header test html text'])
+      assert.deepEqual(err.context.cause.diff, ['Test Html header1      test html text'])
+    }
+  })
+})

package/test/scripting/txt/decompile.spec.js

@@ -634,6 +634,30 @@ CARDS text of card2
 #me
 some text
 CUSTOMINPUT arg1|arg2
+`
+    )
+  })
+  it('should escape pipe in args', async function () {
+    const scriptingProvider = new ScriptingProvider(DefaultCapabilities)
+    await scriptingProvider.Build()
+
+    const convo = {
+      header: {
+        name: 'test convo'
+      },
+      conversation: [
+        {
+          sender: 'me',
+          userInputs: [{ name: 'CUSTOMINPUT', args: ['arg|1', 'arg|2'] }]
+        }
+      ]
+    }
+
+    const script = scriptingProvider.Decompile([convo], 'SCRIPTING_FORMAT_TXT')
+    assert.equal(script, `test convo
+
+#me
+CUSTOMINPUT arg\\|1|arg\\|2
 `
     )
   })