botium-core 1.11.14 → 1.12.1

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

@@ -0,0 +1,51 @@
+const assert = require('chai').assert
+const path = require('path')
+
+const BotDriver = require('../../..').BotDriver
+const Capabilities = require('../../..').Capabilities
+
+const echoConnector = ({ queueBotSays }) => {
+  return {
+    UserSays (msg) {
+      const botMsg = { sender: 'bot', sourceData: msg.sourceData, messageText: msg.messageText }
+      queueBotSays(botMsg)
+    }
+  }
+}
+
+describe('scripting.asserters.textWildcardExactAnyAsserter', function () {
+  beforeEach(async function () {
+    const myCaps = {
+      [Capabilities.PROJECTNAME]: 'scripting.asserters.textWildcardExactAnyAsserter',
+      [Capabilities.CONTAINERMODE]: echoConnector
+    }
+    const driver = new BotDriver(myCaps)
+    this.compiler = driver.BuildCompiler()
+    this.container = await driver.Build()
+  })
+  afterEach(async function () {
+    this.container && await this.container.Clean()
+  })
+
+  it('ok', async function () {
+    this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convos', 'text_wildcardexact_any_ok.yml'))
+
+    this.compiler.ExpandScriptingMemoryToConvos()
+    assert.equal(this.compiler.convos.length, 1)
+    await this.compiler.convos[0].Run(this.container)
+  })
+
+  it('nok', async function () {
+    this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convos', 'text_wildcardexact_any_nok.yml'))
+
+    this.compiler.ExpandScriptingMemoryToConvos()
+    assert.equal(this.compiler.convos.length, 1)
+
+    try {
+      await this.compiler.convos[0].Run(this.container)
+      assert.fail('expected error')
+    } catch (err) {
+      assert.equal(err.message, 'text_wildcardexact_any_nok/Line 2: assertion error - Line 2: Expected any text in response "Im Joe, my number is 12345, and my ID is id2_*3,Im Joe, my number is 12345, and my ID is id3_*3"')
+    }
+  })
+})

package/test/scripting/matching/matchingmode.spec.js

@@ -206,6 +206,49 @@ describe('matching.matchingmode.wildcardIgnoreCase', function () {
   })
 })
 
+describe('matching.matchingmode.wildcardExact', function () {
+  beforeEach(async function () {
+    const myCaps = {
+      [Capabilities.PROJECTNAME]: 'matching.matchingmode',
+      [Capabilities.CONTAINERMODE]: echoConnector,
+      [Capabilities.SCRIPTING_MATCHING_MODE]: 'wildcardExact'
+    }
+    const driver = new BotDriver(myCaps)
+    this.compiler = driver.BuildCompiler()
+    this.container = await driver.Build()
+  })
+  afterEach(async function () {
+    this.container && await this.container.Clean()
+  })
+
+  it('should not match response with substring', async function () {
+    assert.isFalse(this.compiler.Match('Interesting...', 'Interesting'))
+  })
+  it('should match long response with wildcard', async function () {
+    assert.isTrue(this.compiler.Match('this is a long text', 'this is a * text'))
+  })
+  it('should match very long response with wildcard', async function () {
+    assert.isTrue(this.compiler.Match('this is a long text this is a long text this is a long text this is a long text', 'this is a * text this is a * text this is a * text this is a * text'))
+  })
+  it('should not match long uppcercase response with wildcard', async function () {
+    assert.isFalse(this.compiler.Match('THIS IS A LONG TEXT', 'this is a * text'))
+  })
+  it('should match very long response with very long wildcard', async function () {
+    assert.isTrue(this.compiler.Match('begin this is a long text this is a long text this is a long text this is a long text end', 'begin * end'))
+  })
+  it('should not allow more than 10 wildcards in a string', async function () {
+    try {
+      this.compiler.Match('some text', 'begin * * * * * * * * * * * end')
+      assert.fail('should have failed')
+    } catch (err) {
+      assert.equal(err.message, 'Maximum number of 10 wildcards supported.')
+    }
+  })
+  it('should not match if pattern is not matching', async function () {
+    assert.isFalse(this.compiler.Match('This is a long text', '*notthere*'))
+  })
+})
+
 describe('matching.matchingmode.equals', function () {
   beforeEach(async function () {
     const myCaps = {

package/test/scripting/scriptingProvider.spec.js

@@ -508,11 +508,11 @@ describe('scriptingProvider.ExpandUtterancesToConvos', function () {
     assert.equal(scriptingProvider.convos[0].conversation.length, 2)
     assert.equal(scriptingProvider.convos[0].header.name, 'utt1/utt1-L1')
     assert.equal(scriptingProvider.convos[0].conversation[0].messageText, 'TEXT1')
-    assert.equal(scriptingProvider.convos[0].toString(), '1 utt1/utt1-L1 (Expanded Utterances - utt1) ({ origUttName: \'utt1\', origConvoName: \'utt1\' }): Step 1 - tell utterance: #me - TEXT1 | Step 2 - check bot response: #bot - ')
+    assert.equal(scriptingProvider.convos[0].toString(), '1 utt1/utt1-L1 (Expanded Utterances - utt1) ({ origUttName: \'utt1\', origConvoName: \'utt1\' }): Step 1 - tell utterance: #me - TEXT1 SKIP_BOT_UNCONSUMED(no args) | Step 2 - check bot response: #bot - ')
     assert.equal(scriptingProvider.convos[1].conversation.length, 2)
     assert.equal(scriptingProvider.convos[1].header.name, 'utt1/utt1-L2')
     assert.equal(scriptingProvider.convos[1].conversation[0].messageText, 'TEXT2')
-    assert.equal(scriptingProvider.convos[1].toString(), '2 utt1/utt1-L2 (Expanded Utterances - utt1) ({ origUttName: \'utt1\', origConvoName: \'utt1\' }): Step 1 - tell utterance: #me - TEXT2 | Step 2 - check bot response: #bot - ')
+    assert.equal(scriptingProvider.convos[1].toString(), '2 utt1/utt1-L2 (Expanded Utterances - utt1) ({ origUttName: \'utt1\', origConvoName: \'utt1\' }): Step 1 - tell utterance: #me - TEXT2 SKIP_BOT_UNCONSUMED(no args) | Step 2 - check bot response: #bot - ')
   })
   it('should add leading zeros for utterance tags', async function () {
     const scriptingProvider = new ScriptingProvider(DefaultCapabilities)
@@ -529,11 +529,11 @@ describe('scriptingProvider.ExpandUtterancesToConvos', function () {
     assert.equal(scriptingProvider.convos[0].conversation.length, 2)
     assert.equal(scriptingProvider.convos[0].header.name, 'utt1/utt1-L00001')
     assert.equal(scriptingProvider.convos[0].conversation[0].messageText, 'TEXT1')
-    assert.equal(scriptingProvider.convos[0].toString(), '1 utt1/utt1-L00001 (Expanded Utterances - utt1) ({ origUttName: \'utt1\', origConvoName: \'utt1\' }): Step 1 - tell utterance: #me - TEXT1 | Step 2 - check bot response: #bot - ')
+    assert.equal(scriptingProvider.convos[0].toString(), '1 utt1/utt1-L00001 (Expanded Utterances - utt1) ({ origUttName: \'utt1\', origConvoName: \'utt1\' }): Step 1 - tell utterance: #me - TEXT1 SKIP_BOT_UNCONSUMED(no args) | Step 2 - check bot response: #bot - ')
     assert.equal(scriptingProvider.convos[1].conversation.length, 2)
     assert.equal(scriptingProvider.convos[1].header.name, 'utt1/utt1-L00002')
     assert.equal(scriptingProvider.convos[1].conversation[0].messageText, 'TEXT2')
-    assert.equal(scriptingProvider.convos[1].toString(), '2 utt1/utt1-L00002 (Expanded Utterances - utt1) ({ origUttName: \'utt1\', origConvoName: \'utt1\' }): Step 1 - tell utterance: #me - TEXT2 | Step 2 - check bot response: #bot - ')
+    assert.equal(scriptingProvider.convos[1].toString(), '2 utt1/utt1-L00002 (Expanded Utterances - utt1) ({ origUttName: \'utt1\', origConvoName: \'utt1\' }): Step 1 - tell utterance: #me - TEXT2 SKIP_BOT_UNCONSUMED(no args) | Step 2 - check bot response: #bot - ')
   })
   it('should build incomprehension convos for utterance', async function () {
     const scriptingProvider = new ScriptingProvider(Object.assign({}, DefaultCapabilities, { SCRIPTING_UTTEXPANSION_INCOMPREHENSION: 'INCOMPREHENSION' }))

package/test/scripting/scriptingmemory/convosMultiMemorySameCols/buy.convo.txt

@@ -0,0 +1,6 @@
+buy
+
+#me
+Ok, then send me some $productName
+
+#bot

package/test/scripting/scriptingmemory/convosMultiMemorySameCols/products1.scriptingmemory.txt

@@ -0,0 +1,2 @@
+             | productBread | productBeer | productEE
+$productName | Bread        | Beer        | Everything Else

package/test/scripting/scriptingmemory/convosMultiMemorySameCols/products2.scriptingmemory.txt

@@ -0,0 +1,2 @@
+             | productHamburger
+$productName | Hamburger

package/test/scripting/scriptingmemory/convosSimpleCols/buy.convo.txt

@@ -0,0 +1,8 @@
+simple text
+
+#begin
+
+#me
+$productName $customer 
+
+#bot

package/test/scripting/scriptingmemory/convosSimpleCols/product.scriptingmemory.txt

@@ -0,0 +1,3 @@
+              |product1
+$productName  |Wiener Schnitzel
+$customer     |Joe

package/test/scripting/scriptingmemory/convosTwoTablesCols/buy.convo.txt

@@ -0,0 +1,6 @@
+two table
+
+#me
+buy $productName as $customerName
+
+#bot

package/test/scripting/scriptingmemory/fillScriptingMemoryFromFile.spec.js

@@ -71,6 +71,27 @@ describe('scripting.fillingScriptingMemoryFromFile.memoryenabled.originaldeleted
     }
   })
 
+  it('two scripting memory file, one colum each, column mode testcasenames', async function () {
+    // all variations are generated
+    this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convosTwoTablesCols'))
+    this.compiler.ExpandScriptingMemoryToConvos()
+    assert.equal(this.compiler.convos.length, 4)
+
+    const assertScriptingMemory = [
+      { $productName: 'Wiener Schnitzel', $customerName: 'GoodCustomer' },
+      { $productName: 'Pfannkuchen', $customerName: 'GoodCustomer' },
+      { $productName: 'Wiener Schnitzel', $customerName: 'BadCustomer' },
+      { $productName: 'Pfannkuchen', $customerName: 'BadCustomer' }
+    ]
+
+    for (const [i, convo] of this.compiler.convos.entries()) {
+      const transcript = await convo.Run(this.container)
+      assert.isObject(transcript.scriptingMemory)
+      assert.equal(transcript.scriptingMemory.$productName, assertScriptingMemory[i].$productName)
+      assert.equal(transcript.scriptingMemory.$customerName, assertScriptingMemory[i].$customerName)
+    }
+  })
+
   it('Value is optional in the scripting memory file', async function () {
     // all variations are generated
     this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convosValueOptional'))
@@ -96,6 +117,19 @@ describe('scripting.fillingScriptingMemoryFromFile.memoryenabled.originaldeleted
     assert.equal(transcript.scriptingMemory.$customer, 'Joe')
   })
 
+  it('Using text file in column mode testcasenames', async function () {
+    this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convosSimpleCols'))
+    this.compiler.ExpandScriptingMemoryToConvos()
+    assert.equal(this.compiler.convos.length, 1)
+
+    const transcript = await this.compiler.convos[0].Run(this.container)
+    assert.isObject(transcript.scriptingMemory)
+    assert.isDefined(transcript.scriptingMemory.$productName)
+    assert.equal(transcript.scriptingMemory.$productName, 'Wiener Schnitzel')
+    assert.isDefined(transcript.scriptingMemory.$customer)
+    assert.equal(transcript.scriptingMemory.$customer, 'Joe')
+  })
+
   it('should throw exception if name is not set', async function () {
     try {
       this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convosMultiMemoryNoName'))
@@ -178,6 +212,17 @@ describe('scripting.fillingScriptingMemoryFromFile.memoryenabled.originaldeleted
       assert.equal(transcript.scriptingMemory.$productName, 'Hamburger')
     })
 
+    it('should work with same variable names in column mode testcasenames', async function () {
+      this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convosMultiMemorySameCols'))
+      this.compiler.ExpandScriptingMemoryToConvos()
+      assert.equal(this.compiler.convos.length, 4)
+
+      const transcript = await this.compiler.convos[3].Run(this.container)
+      assert.isObject(transcript.scriptingMemory)
+      assert.isDefined(transcript.scriptingMemory.$productName)
+      assert.equal(transcript.scriptingMemory.$productName, 'Hamburger')
+    })
+
     it('should throw exception if there is intersection in convosMultiMemoryCaseNameCollisionvariable names', async function () {
       try {
         this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convosMultiMemoryIntersection'))

package/test/scripting/userinputs/mediaInputConvos.spec.js

@@ -1,4 +1,5 @@
 const path = require('path')
+const fs = require('fs')
 const assert = require('chai').assert
 const nock = require('nock')
 const BotDriver = require('../../../').BotDriver
@@ -96,6 +97,30 @@ describe('scripting.userinputs.mediaInputConvos.relative', function () {
     assert.equal(this.compiler.convos[1].conversation[0].userInputs[0].args[0], 'files/botium1.png')
     assert.equal(this.compiler.convos[2].conversation[0].userInputs[0].args[0], 'files/botium2.png')
   })
+
+  it('should use dataUri as media in user message', async function () {
+    const mediaData = fs.readFileSync(path.resolve(__dirname, 'convos', 'files', 'botium0.png'))
+    const mediaUri = `data:image/png;base64,${mediaData.toString('base64')}`
+    const script = `should use dataUri as media in user message
+
+#me
+MEDIA ${mediaUri}
+`
+
+    this.compiler.Compile(script, 'SCRIPTING_FORMAT_TXT', 'SCRIPTING_TYPE_CONVO')
+    assert.equal(this.compiler.convos.length, 1)
+    assert.equal(this.compiler.convos[0].conversation.length, 1)
+    assert.equal(this.compiler.convos[0].conversation[0].userInputs.length, 1)
+    assert.equal(this.compiler.convos[0].conversation[0].userInputs[0].name, 'MEDIA')
+    assert.equal(this.compiler.convos[0].conversation[0].userInputs[0].args.length, 1)
+    assert.isTrue(this.compiler.convos[0].conversation[0].userInputs[0].args[0].startsWith('data:image/png'))
+
+    const transcript = await this.compiler.convos[0].Run(this.container)
+    assert.equal(transcript.steps.length, 1)
+    assert.equal(transcript.steps[0].actual.media.length, 1)
+    assert.isTrue(transcript.steps[0].actual.media[0].downloadUri.startsWith('data:image/png'))
+    assert.equal(transcript.steps[0].actual.media[0].mimeType, 'image/png')
+  })
 })
 
 describe('scripting.userinputs.mediaInputConvos.baseUri', function () {
@@ -257,6 +282,7 @@ describe('scripting.userinputs.mediaInputConvos.baseDir', function () {
           ref: 'MEDIA',
           src: 'MediaInput',
           args: {
+            downloadMedia: true,
             baseDir: path.join(__dirname, 'convos', 'files')
           }
         }
@@ -315,6 +341,31 @@ describe('scripting.userinputs.mediaInputConvos.baseDir', function () {
       assert.isTrue(err.message.startsWith('mediaoutofbasedir/Line 3: error sending to bot - The uri \'../*.png\' is pointing out of the base directory'))
     }
   })
+
+  it('should use dataUri as media in user message', async function () {
+    const mediaData = fs.readFileSync(path.resolve(__dirname, 'convos', 'files', 'botium0.png'))
+    const mediaUri = `data:image/png;base64,${mediaData.toString('base64')}`
+    const script = `should use dataUri as media in user message
+
+#me
+MEDIA ${mediaUri}
+`
+
+    this.compiler.Compile(script, 'SCRIPTING_FORMAT_TXT', 'SCRIPTING_TYPE_CONVO')
+    assert.equal(this.compiler.convos.length, 1)
+    assert.equal(this.compiler.convos[0].conversation.length, 1)
+    assert.equal(this.compiler.convos[0].conversation[0].userInputs.length, 1)
+    assert.equal(this.compiler.convos[0].conversation[0].userInputs[0].name, 'MEDIA')
+    assert.equal(this.compiler.convos[0].conversation[0].userInputs[0].args.length, 1)
+    assert.isTrue(this.compiler.convos[0].conversation[0].userInputs[0].args[0].startsWith('data:image/png'))
+
+    const transcript = await this.compiler.convos[0].Run(this.container)
+    assert.equal(transcript.steps.length, 1)
+    assert.equal(transcript.steps[0].actual.media.length, 1)
+    assert.isTrue(transcript.steps[0].actual.media[0].downloadUri.startsWith('data:image/png'))
+    assert.equal(transcript.steps[0].actual.media[0].mimeType, 'image/png')
+    assert.isTrue(Buffer.isBuffer(transcript.steps[0].actual.media[0].buffer))
+  })
 })
 
 describe('scripting.userinputs.mediaInputDownloadConvos.relative', function () {
@@ -349,7 +400,7 @@ describe('scripting.userinputs.mediaInputDownloadConvos.relative', function () {
     assert.equal(transcript.steps[0].actual.media.length, 1)
     assert.isTrue(transcript.steps[0].actual.media[0].downloadUri.endsWith('test/scripting/userinputs/convos/botium.png'))
     assert.equal(transcript.steps[0].actual.media[0].mimeType, 'image/png')
-    assert.isNotNull(transcript.steps[0].actual.media[0].buffer)
+    assert.isTrue(Buffer.isBuffer(transcript.steps[0].actual.media[0].buffer))
   })
 })
 
@@ -391,7 +442,7 @@ describe('scripting.userinputs.mediaInputDownloadConvos.baseUri', function () {
     assert.equal(transcript.steps[0].actual.media.length, 1)
     assert.equal(transcript.steps[0].actual.media[0].downloadUri, 'https://www.botium.at/botium.png')
     assert.equal(transcript.steps[0].actual.media[0].mimeType, 'image/png')
-    assert.isNotNull(transcript.steps[0].actual.media[0].buffer)
+    assert.isTrue(Buffer.isBuffer(transcript.steps[0].actual.media[0].buffer))
 
     scope.persist(false)
   })