botium-core 1.11.16 → 1.12.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/dist/botium-cjs.js +493 -202
  2. package/dist/botium-cjs.js.map +1 -1
  3. package/dist/botium-es.js +484 -194
  4. package/dist/botium-es.js.map +1 -1
  5. package/index.js +1 -0
  6. package/package.json +29 -29
  7. package/samples/connectors/custom/botium-connector-myapi.js +3 -3
  8. package/samples/extensions/asserterHooks/DummyAsserter.js +3 -3
  9. package/src/BotDriver.js +3 -3
  10. package/src/Capabilities.js +9 -0
  11. package/src/Defaults.js +1 -1
  12. package/src/Enums.js +6 -0
  13. package/src/containers/BaseContainer.js +20 -10
  14. package/src/containers/PluginConnectorContainer.js +1 -0
  15. package/src/containers/plugins/SimpleRestContainer.js +98 -30
  16. package/src/scripting/BotiumError.js +21 -0
  17. package/src/scripting/CompilerCsv.js +1 -1
  18. package/src/scripting/CompilerObjectBase.js +4 -14
  19. package/src/scripting/CompilerTxt.js +4 -15
  20. package/src/scripting/CompilerXlsx.js +81 -25
  21. package/src/scripting/Convo.js +16 -4
  22. package/src/scripting/ScriptingProvider.js +6 -0
  23. package/src/scripting/helper.js +54 -1
  24. package/src/scripting/logichook/LogicHookUtils.js +2 -0
  25. package/src/scripting/logichook/asserter/JsonPathAsserter.js +1 -1
  26. package/src/scripting/logichook/logichooks/ClearQueueLogicHook.js +1 -1
  27. package/src/scripting/logichook/userinput/MediaInput.js +14 -2
  28. package/test/connectors/convos/hello.convo.txt +6 -0
  29. package/test/connectors/simplerest.spec.js +106 -2
  30. package/test/convo/convos/continuefailing.convo.txt +19 -0
  31. package/test/convo/transcript.spec.js +34 -0
  32. package/test/scripting/scriptingProvider.spec.js +4 -4
  33. package/test/scripting/scriptingmemory/convosMultiMemorySameCols/buy.convo.txt +6 -0
  34. package/test/scripting/scriptingmemory/convosMultiMemorySameCols/products1.scriptingmemory.txt +2 -0
  35. package/test/scripting/scriptingmemory/convosMultiMemorySameCols/products2.scriptingmemory.txt +2 -0
  36. package/test/scripting/scriptingmemory/convosSimpleCols/buy.convo.txt +8 -0
  37. package/test/scripting/scriptingmemory/convosSimpleCols/product.scriptingmemory.txt +3 -0
  38. package/test/scripting/scriptingmemory/convosTwoTablesCols/buy.convo.txt +6 -0
  39. package/test/scripting/scriptingmemory/convosTwoTablesCols/customer.xlsx +0 -0
  40. package/test/scripting/scriptingmemory/convosTwoTablesCols/product.xlsx +0 -0
  41. package/test/scripting/scriptingmemory/fillScriptingMemoryFromFile.spec.js +45 -0
  42. package/test/scripting/userinputs/mediaInputConvos.spec.js +53 -2
@@ -71,6 +71,27 @@ describe('scripting.fillingScriptingMemoryFromFile.memoryenabled.originaldeleted
71
71
  }
72
72
  })
73
73
 
74
+ it('two scripting memory file, one colum each, column mode testcasenames', async function () {
75
+ // all variations are generated
76
+ this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convosTwoTablesCols'))
77
+ this.compiler.ExpandScriptingMemoryToConvos()
78
+ assert.equal(this.compiler.convos.length, 4)
79
+
80
+ const assertScriptingMemory = [
81
+ { $productName: 'Wiener Schnitzel', $customerName: 'GoodCustomer' },
82
+ { $productName: 'Pfannkuchen', $customerName: 'GoodCustomer' },
83
+ { $productName: 'Wiener Schnitzel', $customerName: 'BadCustomer' },
84
+ { $productName: 'Pfannkuchen', $customerName: 'BadCustomer' }
85
+ ]
86
+
87
+ for (const [i, convo] of this.compiler.convos.entries()) {
88
+ const transcript = await convo.Run(this.container)
89
+ assert.isObject(transcript.scriptingMemory)
90
+ assert.equal(transcript.scriptingMemory.$productName, assertScriptingMemory[i].$productName)
91
+ assert.equal(transcript.scriptingMemory.$customerName, assertScriptingMemory[i].$customerName)
92
+ }
93
+ })
94
+
74
95
  it('Value is optional in the scripting memory file', async function () {
75
96
  // all variations are generated
76
97
  this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convosValueOptional'))
@@ -96,6 +117,19 @@ describe('scripting.fillingScriptingMemoryFromFile.memoryenabled.originaldeleted
96
117
  assert.equal(transcript.scriptingMemory.$customer, 'Joe')
97
118
  })
98
119
 
120
+ it('Using text file in column mode testcasenames', async function () {
121
+ this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convosSimpleCols'))
122
+ this.compiler.ExpandScriptingMemoryToConvos()
123
+ assert.equal(this.compiler.convos.length, 1)
124
+
125
+ const transcript = await this.compiler.convos[0].Run(this.container)
126
+ assert.isObject(transcript.scriptingMemory)
127
+ assert.isDefined(transcript.scriptingMemory.$productName)
128
+ assert.equal(transcript.scriptingMemory.$productName, 'Wiener Schnitzel')
129
+ assert.isDefined(transcript.scriptingMemory.$customer)
130
+ assert.equal(transcript.scriptingMemory.$customer, 'Joe')
131
+ })
132
+
99
133
  it('should throw exception if name is not set', async function () {
100
134
  try {
101
135
  this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convosMultiMemoryNoName'))
@@ -178,6 +212,17 @@ describe('scripting.fillingScriptingMemoryFromFile.memoryenabled.originaldeleted
178
212
  assert.equal(transcript.scriptingMemory.$productName, 'Hamburger')
179
213
  })
180
214
 
215
+ it('should work with same variable names in column mode testcasenames', async function () {
216
+ this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convosMultiMemorySameCols'))
217
+ this.compiler.ExpandScriptingMemoryToConvos()
218
+ assert.equal(this.compiler.convos.length, 4)
219
+
220
+ const transcript = await this.compiler.convos[3].Run(this.container)
221
+ assert.isObject(transcript.scriptingMemory)
222
+ assert.isDefined(transcript.scriptingMemory.$productName)
223
+ assert.equal(transcript.scriptingMemory.$productName, 'Hamburger')
224
+ })
225
+
181
226
  it('should throw exception if there is intersection in convosMultiMemoryCaseNameCollisionvariable names', async function () {
182
227
  try {
183
228
  this.compiler.ReadScriptsFromDirectory(path.resolve(__dirname, 'convosMultiMemoryIntersection'))
@@ -1,4 +1,5 @@
1
1
  const path = require('path')
2
+ const fs = require('fs')
2
3
  const assert = require('chai').assert
3
4
  const nock = require('nock')
4
5
  const BotDriver = require('../../../').BotDriver
@@ -96,6 +97,30 @@ describe('scripting.userinputs.mediaInputConvos.relative', function () {
96
97
  assert.equal(this.compiler.convos[1].conversation[0].userInputs[0].args[0], 'files/botium1.png')
97
98
  assert.equal(this.compiler.convos[2].conversation[0].userInputs[0].args[0], 'files/botium2.png')
98
99
  })
100
+
101
+ it('should use dataUri as media in user message', async function () {
102
+ const mediaData = fs.readFileSync(path.resolve(__dirname, 'convos', 'files', 'botium0.png'))
103
+ const mediaUri = `data:image/png;base64,${mediaData.toString('base64')}`
104
+ const script = `should use dataUri as media in user message
105
+
106
+ #me
107
+ MEDIA ${mediaUri}
108
+ `
109
+
110
+ this.compiler.Compile(script, 'SCRIPTING_FORMAT_TXT', 'SCRIPTING_TYPE_CONVO')
111
+ assert.equal(this.compiler.convos.length, 1)
112
+ assert.equal(this.compiler.convos[0].conversation.length, 1)
113
+ assert.equal(this.compiler.convos[0].conversation[0].userInputs.length, 1)
114
+ assert.equal(this.compiler.convos[0].conversation[0].userInputs[0].name, 'MEDIA')
115
+ assert.equal(this.compiler.convos[0].conversation[0].userInputs[0].args.length, 1)
116
+ assert.isTrue(this.compiler.convos[0].conversation[0].userInputs[0].args[0].startsWith('data:image/png'))
117
+
118
+ const transcript = await this.compiler.convos[0].Run(this.container)
119
+ assert.equal(transcript.steps.length, 1)
120
+ assert.equal(transcript.steps[0].actual.media.length, 1)
121
+ assert.isTrue(transcript.steps[0].actual.media[0].downloadUri.startsWith('data:image/png'))
122
+ assert.equal(transcript.steps[0].actual.media[0].mimeType, 'image/png')
123
+ })
99
124
  })
100
125
 
101
126
  describe('scripting.userinputs.mediaInputConvos.baseUri', function () {
@@ -257,6 +282,7 @@ describe('scripting.userinputs.mediaInputConvos.baseDir', function () {
257
282
  ref: 'MEDIA',
258
283
  src: 'MediaInput',
259
284
  args: {
285
+ downloadMedia: true,
260
286
  baseDir: path.join(__dirname, 'convos', 'files')
261
287
  }
262
288
  }
@@ -315,6 +341,31 @@ describe('scripting.userinputs.mediaInputConvos.baseDir', function () {
315
341
  assert.isTrue(err.message.startsWith('mediaoutofbasedir/Line 3: error sending to bot - The uri \'../*.png\' is pointing out of the base directory'))
316
342
  }
317
343
  })
344
+
345
+ it('should use dataUri as media in user message', async function () {
346
+ const mediaData = fs.readFileSync(path.resolve(__dirname, 'convos', 'files', 'botium0.png'))
347
+ const mediaUri = `data:image/png;base64,${mediaData.toString('base64')}`
348
+ const script = `should use dataUri as media in user message
349
+
350
+ #me
351
+ MEDIA ${mediaUri}
352
+ `
353
+
354
+ this.compiler.Compile(script, 'SCRIPTING_FORMAT_TXT', 'SCRIPTING_TYPE_CONVO')
355
+ assert.equal(this.compiler.convos.length, 1)
356
+ assert.equal(this.compiler.convos[0].conversation.length, 1)
357
+ assert.equal(this.compiler.convos[0].conversation[0].userInputs.length, 1)
358
+ assert.equal(this.compiler.convos[0].conversation[0].userInputs[0].name, 'MEDIA')
359
+ assert.equal(this.compiler.convos[0].conversation[0].userInputs[0].args.length, 1)
360
+ assert.isTrue(this.compiler.convos[0].conversation[0].userInputs[0].args[0].startsWith('data:image/png'))
361
+
362
+ const transcript = await this.compiler.convos[0].Run(this.container)
363
+ assert.equal(transcript.steps.length, 1)
364
+ assert.equal(transcript.steps[0].actual.media.length, 1)
365
+ assert.isTrue(transcript.steps[0].actual.media[0].downloadUri.startsWith('data:image/png'))
366
+ assert.equal(transcript.steps[0].actual.media[0].mimeType, 'image/png')
367
+ assert.isTrue(Buffer.isBuffer(transcript.steps[0].actual.media[0].buffer))
368
+ })
318
369
  })
319
370
 
320
371
  describe('scripting.userinputs.mediaInputDownloadConvos.relative', function () {
@@ -349,7 +400,7 @@ describe('scripting.userinputs.mediaInputDownloadConvos.relative', function () {
349
400
  assert.equal(transcript.steps[0].actual.media.length, 1)
350
401
  assert.isTrue(transcript.steps[0].actual.media[0].downloadUri.endsWith('test/scripting/userinputs/convos/botium.png'))
351
402
  assert.equal(transcript.steps[0].actual.media[0].mimeType, 'image/png')
352
- assert.isNotNull(transcript.steps[0].actual.media[0].buffer)
403
+ assert.isTrue(Buffer.isBuffer(transcript.steps[0].actual.media[0].buffer))
353
404
  })
354
405
  })
355
406
 
@@ -391,7 +442,7 @@ describe('scripting.userinputs.mediaInputDownloadConvos.baseUri', function () {
391
442
  assert.equal(transcript.steps[0].actual.media.length, 1)
392
443
  assert.equal(transcript.steps[0].actual.media[0].downloadUri, 'https://www.botium.at/botium.png')
393
444
  assert.equal(transcript.steps[0].actual.media[0].mimeType, 'image/png')
394
- assert.isNotNull(transcript.steps[0].actual.media[0].buffer)
445
+ assert.isTrue(Buffer.isBuffer(transcript.steps[0].actual.media[0].buffer))
395
446
 
396
447
  scope.persist(false)
397
448
  })