How to use mergeCaps method in Appium Base Driver

...57  });58  // Tests based on: https://www.w3.org/TR/webdriver/#dfn-merging-caps59  describe('#mergeCaps', function () {60    it('returns a result that is {} by default (1)', function () {61      mergeCaps().should.deep.equal({});62    });63    it('returns a result that matches primary by default (2, 3)', function () {64      mergeCaps({hello: 'world'}).should.deep.equal({hello: 'world'});65    });66    it('returns invalid argument error if primary and secondary have matching properties (4)', function () {67      (() => mergeCaps({hello: 'world'}, {hello: 'whirl'})).should.throw(/property 'hello' should not exist on both primary [\w\W]* and secondary [\w\W]*/);68    });69    it('returns a result with keys from primary and secondary together', function () {70      let primary = {71        a: 'a',72        b: 'b',73      };74      let secondary = {75        c: 'c',76        d: 'd',77      };78      mergeCaps(primary, secondary).should.deep.equal({79        a: 'a', b: 'b', c: 'c', d: 'd',80      });81    });82  });83  // Tests based on: https://www.w3.org/TR/webdriver/#processing-caps84  describe('#parseCaps', function () {85    let caps;86    beforeEach(function () {87      caps = {};88    });89    it('should return invalid argument if no caps object provided', function () {90      (() => parseCaps()).should.throw(/must be a JSON object/);91    });92    it('sets "requiredCaps" to property named "alwaysMatch" (2)', function () {...

...113//*************************************************************114// This function merges title, brief description, page content,115// keywords and returns all-caps string116//*************************************************************117function mergeCaps(str1, str2, str3) {118	mergeStr = "";119	// join str2 (brief description) and str3 (rest of page text)120	// if page content is longer than brief description length,121	// then str2 ends "..."122	// if str2 ends "..." remove dots123	if ((str2.length > 0) && (str2.charAt(0) != " ")) str2 = " " + str2;124	if (str2.substring(str2.length - 3, str2.length) == "...") {125			mergeString = str2.substring(0, str2.length - 3).concat(str3);126	} else {127			mergeString = str2.concat(str3);128	}129	mergeString = str1 + mergeString130	//to make search case-insensitive, convert to all caps131	return mergeString.toUpperCase();132}133//*************************************************************************134// This function will parse the URL search string and change a name/value pair135//*************************************************************************136function changeParam(whichParam, newVal) {137	newParamStr = "";138	thisURLstr = document.location.href.substring(0, document.location.href.indexOf("?"));139	thisURLparamStr = document.location.href.substring(document.location.href.indexOf("?") + 1, document.location.href.length);140	//Build array out of thisURLparamStr using "&" as delimiter141	divide1=(thisURLparamStr.split("&"))142	for (cnt=0; cnt < divide1.length; cnt++) {143		divide2 = divide1[cnt].split("=")144		if (divide2[0] == whichParam) {145			// if we find whichParam in thisURLparamStr replace whichParam's value with newVal146			newParamStr = newParamStr + divide2[0] + "=" + escape(newVal) + "&";147		} else {148			//leave other parameters intact149			newParamStr = newParamStr + divide2[0] + "=" + divide2[1] + "&";150		}151	}152	//strip off trailing ampersand153	if (newParamStr.charAt(newParamStr.length - 1) == "&") newParamStr = newParamStr.substring(0, newParamStr.length - 1);154	//apply new URL155 	return(thisURLstr + "?" + newParamStr);156}157//*************************************************************158// Sorts search results based on 1.Number of hits 2.aplhabetically159//*************************************************************160function compare(a, b) {161	if (parseInt(a) - parseInt(b) != 0) {162		return parseInt(a) - parseInt(b)163	}else {164		var aComp = a.substring(a.indexOf("|") + 1, a.length)165		var bComp = b.substring(b.indexOf("|") + 1, b.length)166		if (aComp < bComp) {return -1}167		if (aComp > bComp) {return 1}168		return 0169	}170}171//Evoked if user searches ANY WORDS172function allowAny(t, text) {173	var OccurNum = 0;174	for (i = 0; i < profiles.length; i++) {175		//strip url out of search string176		var refineElement = "";177		var splitline = profiles[i].split("|");178		refineElement = mergeCaps(splitline[0], splitline[1], splitline[2])179		OccurNum = 0;180		181		for (j = 0; j < t.length; j++) {182			183			eval("myRE = /" + t[j] + "/gi");184			OccurArray = refineElement.match(myRE);185			if (OccurArray != null) OccurNum = OccurNum + OccurArray.length;186			187		}188		if (OccurNum > 0) {189			anyMatch[indexer] = (0-OccurNum) + "|" + profiles[i];190			indexer++;191		}192	}193	if (anyMatch.length == 0) {						// If no matches are found, print a no match194		noMatch(text);							// HTML document195		return;196	}197	else { formatResults(anyMatch, text); }					// Otherwise, generate a results document198}199//Evoked if user searches ALL WORDS200function requireAll(t, text) {201	var OccurNum = 0;202	for (i = 0; i < profiles.length; i++) {203		var allConfirmation = true;204		var refineAllString = "";205		var splitline = profiles[i].split("|");206		refineAllString = mergeCaps(splitline[0], splitline[1], splitline[2])207		OccurNum = 0;208		209		for (j = 0; j < t.length; j++) {210			eval("myRE = /" + t[j] + "/gi");211			OccurArray = refineAllString.match(myRE);212			if (OccurArray != null) {213				OccurNum = OccurNum + OccurArray.length;214			} else {215				allConfirmation = false;216			}217			218		}219		220		if (allConfirmation) {221			allMatch[indexer] = (0-OccurNum) + "|" + profiles[i];222			indexer++;223			}224		}225	if (allMatch.length == 0) {226		noMatch(text);227		return;228	} else {229		formatResults(allMatch, text);230	}231}232//If user wants exact phrase233function requirePhrase(t, text) {234	for (i = 0; i < profiles.length; i++) {235		var allConfirmation = true;236		//strip url out of search string237		var refineAllString = "";238		var splitline = profiles[i].split("|");239		refineAllString = mergeCaps(splitline[0], splitline[1], splitline[2])240		var allElement = t.toUpperCase();241		var OccurNum = 0;242		243		eval("myRE = /" + t + "/gi");244		OccurArray = refineAllString.match(myRE);245		if (OccurArray != null) {246			OccurNum = OccurNum + OccurArray.length;247			phraseMatch[indexer] = (0-OccurNum) + "|" + profiles[i];248			indexer++;249		}250	}251	if (phraseMatch.length == 0) {252		noMatch(text);253		return;...

...161  // Try to merge requiredCaps with first match capabilities, break once it finds its first match (see spec #6)162  let matchedCaps = null;163  for (let firstMatchCaps of validatedFirstMatchCaps) {164    try {165      matchedCaps = mergeCaps(requiredCaps, firstMatchCaps);166      if (matchedCaps) {167        break;168      }169    } catch (err) {170      log.warn(err.message);171      validationErrors.push(err.message);172    }173  }174  // Returns variables for testing purposes175  return {requiredCaps, allFirstMatchCaps, validatedFirstMatchCaps, matchedCaps, validationErrors};176}177// Calls parseCaps and just returns the matchedCaps variable178function processCapabilities (caps, constraints = {}, shouldValidateCaps = true) {179  const {matchedCaps, validationErrors} = parseCaps(caps, constraints, shouldValidateCaps);...

1const nock = require('nock')2const assert = require('chai').assert3const BotDriver = require('../../').BotDriver4const Capabilities = require('../../').Capabilities5const echoConnector = ({ queueBotSays }) => {6  return {7    UserSays (msg) {8      const botMsg = { sender: 'bot', sourceData: msg.sourceData, messageText: msg.messageText, testInput: msg.testInput }9      queueBotSays(botMsg)10    }11  }12}13const buildDriver = async (mergeCaps) => {14  const myCaps = Object.assign({15    [Capabilities.PROJECTNAME]: 'customhooks',16    [Capabilities.CONTAINERMODE]: echoConnector17  }, mergeCaps)18  const result = {}19  result.driver = new BotDriver(myCaps)20  result.container = await result.driver.Build()21  return result22}23describe('customhooks.hookfromsrc', function () {24  it('should call hooks from code', async function () {25    let onBuildCalled = false26    let onStartCalled = false27    let onUserSaysCalled = false28    let onBotResponseCalled = false29    let onStopCalled = false30    let onCleanCalled = false31    const { container } = await buildDriver({32      [Capabilities.CUSTOMHOOK_ONBUILD]: () => {33        onBuildCalled = true34      },35      [Capabilities.CUSTOMHOOK_ONSTART]: () => {36        onStartCalled = true37      },38      [Capabilities.CUSTOMHOOK_ONUSERSAYS]: () => {39        onUserSaysCalled = true40      },41      [Capabilities.CUSTOMHOOK_ONBOTRESPONSE]: () => {42        onBotResponseCalled = true43      },44      [Capabilities.CUSTOMHOOK_ONSTOP]: () => {45        onStopCalled = true46      },47      [Capabilities.CUSTOMHOOK_ONCLEAN]: () => {48        onCleanCalled = true49      }50    })51    await container.Start()52    await container.UserSaysText('hallo')53    await container.WaitBotSays()54    await container.Stop()55    await container.Clean()56    assert.isTrue(onBuildCalled)57    assert.isTrue(onStartCalled)58    assert.isTrue(onUserSaysCalled)59    assert.isTrue(onBotResponseCalled)60    assert.isTrue(onStopCalled)61    assert.isTrue(onCleanCalled)62  })63  it('should call hooks from string function', async function () {64    const { container } = await buildDriver({65      [Capabilities.CUSTOMHOOK_ONBUILD]: 'module.exports = ({ container }) => { container.onBuildCalled = true }',66      [Capabilities.CUSTOMHOOK_ONSTART]: 'module.exports = ({ container }) => { container.onStartCalled = true }',67      [Capabilities.CUSTOMHOOK_ONUSERSAYS]: 'module.exports = ({ container }) => { container.onUserSaysCalled = true }',68      [Capabilities.CUSTOMHOOK_ONBOTRESPONSE]: 'module.exports = ({ container }) => { container.onBotResponseCalled = true }',69      [Capabilities.CUSTOMHOOK_ONSTOP]: 'module.exports = ({ container }) => { container.onStopCalled = true }',70      [Capabilities.CUSTOMHOOK_ONCLEAN]: 'module.exports = ({ container }) => { container.onCleanCalled = true }'71    })72    await container.Start()73    await container.UserSaysText('hallo')74    await container.WaitBotSays()75    await container.Stop()76    await container.Clean()77    assert.isTrue(container.onBuildCalled)78    assert.isTrue(container.onStartCalled)79    assert.isTrue(container.onUserSaysCalled)80    assert.isTrue(container.onBotResponseCalled)81    assert.isTrue(container.onStopCalled)82    assert.isTrue(container.onCleanCalled)83  })84  it('should change meMsg from hook', async function () {85    const { container } = await buildDriver({86      [Capabilities.CUSTOMHOOK_ONUSERSAYS]: ({ meMsg }) => {87        meMsg.testInput = 188      }89    })90    await container.Start()91    await container.UserSaysText('hallo')92    const botMsg = await container.WaitBotSays()93    await container.Stop()94    await container.Clean()95    assert.equal(botMsg.testInput, 1)96  })97  it('should change botMsg from hook', async function () {98    const { container } = await buildDriver({99      [Capabilities.CUSTOMHOOK_ONBOTRESPONSE]: ({ botMsg }) => {100        botMsg.fromHook = 1101      }102    })103    await container.Start()104    await container.UserSaysText('hallo')105    const botMsg = await container.WaitBotSays()106    await container.Stop()107    await container.Clean()108    assert.equal(botMsg.fromHook, 1)109  })110  it('should call http api from string function', async function () {111    const scope = nock('https://gettoken.com')112      .get('/get')113      .reply(200, {114        token: 'thisisausertoken'115      })116      .persist()117    const { container } = await buildDriver({118      [Capabilities.CUSTOMHOOK_ONSTART]: `module.exports = async ({ container, request }) => {119        return new Promise((resolve, reject) => {120          request({ method: 'get', uri: 'https://gettoken.com/get', json: true }, (err, response, body) => {121            if (err) return reject(err)122            container.caps.MYTOKEN = body.token123            resolve()124          })125        })126      }`127    })128    await container.Start()129    assert.equal(container.caps.MYTOKEN, 'thisisausertoken')130    scope.persist(false)131  })...

1const path = require('path')2const assert = require('chai').assert3const BotDriver = require('../../').BotDriver4const Capabilities = require('../../').Capabilities5const echoConnector = ({ queueBotSays }) => {6  return {7    UserSays (msg) {8      const botMsg = { sender: 'bot', sourceData: msg.sourceData, messageText: msg.messageText }9      queueBotSays(botMsg)10    }11  }12}13const buildDriver = async (mergeCaps) => {14  const myCaps = Object.assign({15    [Capabilities.PROJECTNAME]: 'logichooks.hookfromsrc',16    [Capabilities.CONTAINERMODE]: echoConnector17  }, mergeCaps)18  const result = {}19  result.driver = new BotDriver(myCaps)20  result.compiler = result.driver.BuildCompiler()21  result.container = await result.driver.Build()22  return result23}24describe('logichooks.hookfromsrc', function () {25  it('should succeed with asserter from code', async function () {26    const { compiler, container } = await buildDriver({27      [Capabilities.ASSERTERS]: [{28        ref: 'CUSTOMASSERTER',29        src: {30          assertConvoStep: 'if (botMsg.messageText === "Hello") result=Promise.resolve(); else result=Promise.reject(new Error("expected Hello"))'31        }32      }]33    })34    compiler.ReadScript(path.resolve(__dirname, 'convos'), 'HOOKFROMSRC.convo.txt')35    await compiler.convos[0].Run(container)36  })37  it('should fail with asserter from code', async function () {38    const { compiler, container } = await buildDriver({39      [Capabilities.ASSERTERS]: [{40        ref: 'CUSTOMASSERTER',41        src: {42          assertConvoStep: 'if (botMsg.messageText === "Hello1") module.exports=Promise.resolve(); else module.exports=Promise.reject(new Error("expected Hello1"))'43        }44      }]45    })46    compiler.ReadScript(path.resolve(__dirname, 'convos'), 'HOOKFROMSRC.convo.txt')47    try {48      await compiler.convos[0].Run(container)49      assert.fail('it should have failed')50    } catch (err) {51      assert.isTrue(err.message.includes('Line 6: assertion error - expected Hello1'))52    }53  })54  it('should fail with asserter with invalid script', async function () {55    const { compiler, container } = await buildDriver({56      [Capabilities.ASSERTERS]: [{57        ref: 'CUSTOMASSERTER',58        src: {59          assertConvoStep: '!'60        }61      }]62    })63    compiler.ReadScript(path.resolve(__dirname, 'convos'), 'HOOKFROMSRC.convo.txt')64    try {65      await compiler.convos[0].Run(container)66      assert.fail('it should have failed')67    } catch (err) {68      assert.isTrue(err.message.includes('Line 6: assertion error - Unexpected end of input'))69    }70  })71})72const buildDriverFromFile = async (mergeCaps) => {73  const myCaps = Object.assign({74    [Capabilities.PROJECTNAME]: 'logichooks.hookfromsrc',75    [Capabilities.CONTAINERMODE]: path.join(__dirname, 'botium-connector-fromfile')76  }, mergeCaps)77  const result = {}78  result.driver = new BotDriver(myCaps)79  result.compiler = result.driver.BuildCompiler()80  result.container = await result.driver.Build()81  return result82}83describe('logichooks.hookfromconnector', function () {84  it('should succeed with asserter from connector', async function () {85    const { compiler, container } = await buildDriverFromFile({86      [Capabilities.ASSERTERS]: [{87        ref: 'CUSTOMASSERTER',88        src: path.join(__dirname, 'botium-connector-fromfile.js/MyCustomAsserter')89      }]90    })91    compiler.ReadScript(path.resolve(__dirname, 'convos'), 'HOOKFROMSRC.convo.txt')92    await compiler.convos[0].Run(container)93  })94  it('should succeed with asserter from asserter module file', async function () {95    const { compiler, container } = await buildDriverFromFile({96      [Capabilities.ASSERTERS]: [{97        ref: 'CUSTOMASSERTER',98        src: path.join(__dirname, 'botium-asserter-fromfile.js')99      }]100    })101    compiler.ReadScript(path.resolve(__dirname, 'convos'), 'HOOKFROMSRC.convo.txt')102    await compiler.convos[0].Run(container)103  })...

1const path = require('path')2const assert = require('chai').assert3const BotDriver = require('../../').BotDriver4const Capabilities = require('../../').Capabilities5const echoConnector = ({ queueBotSays }) => {6  return {7    UserSays (msg) {8      const botMsg = { sender: 'bot', sourceData: msg.sourceData, messageText: msg.messageText }9      queueBotSays(botMsg)10    }11  }12}13const buildDriver = async (mergeCaps) => {14  const myCaps = Object.assign({15    [Capabilities.PROJECTNAME]: 'logichooks.textfromhook',16    [Capabilities.CONTAINERMODE]: echoConnector17  }, mergeCaps)18  const result = {}19  result.driver = new BotDriver(myCaps)20  result.compiler = result.driver.BuildCompiler()21  result.container = await result.driver.Build()22  return result23}24describe('logichooks.textfromhook', function () {25  it('should use text from onMeStart logic hook', async function () {26    const { compiler, container } = await buildDriver({27      [Capabilities.LOGIC_HOOKS]: [{28        ref: 'SET_TEXT_FROM_HOOK',29        src: {30          onMeStart: ({ meMsg, args }) => {31            meMsg.messageText = args[0]32            meMsg.testAttribute = 'val1'33          }34        }35      }]36    })37    compiler.ReadScript(path.resolve(__dirname, 'convos'), 'TEXTFROMHOOK.convo.txt')38    const transcript = await compiler.convos[0].Run(container)39    assert.lengthOf(transcript.steps, 2)40    assert.equal(transcript.steps[0].actual.testAttribute, 'val1')41  })42  it('should use text from onBotPrepare logic hook', async function () {43    const { compiler, container } = await buildDriver({44      [Capabilities.LOGIC_HOOKS]: [{45        ref: 'SET_TEXT_FROM_HOOK',46        src: {47          onBotPrepare: ({ botMsg, args }) => {48            botMsg.messageText = args[0]49          }50        }51      }]52    })53    compiler.ReadScript(path.resolve(__dirname, 'convos'), 'TEXTFROMBOTHOOK.convo.txt')54    const transcript = await compiler.convos[0].Run(container)55    assert.lengthOf(transcript.steps, 2)56  })...

1const path = require('path')2const assert = require('chai').assert3const BotDriver = require('../../..').BotDriver4const Capabilities = require('../../..').Capabilities5const myCaps = require('./customEmbeddedAsserter')6const echoConnector = () => ({ queueBotSays }) => {7  return {8    UserSays (msg) {9      const botMsg = { sender: 'bot', sourceData: msg.sourceData, messageText: msg.messageText }10      queueBotSays(botMsg)11    }12  }13}14const buildDriver = async (mergeCaps) => {15  const myCaps = Object.assign({16    [Capabilities.PROJECTNAME]: 'convo.customasserters',17    [Capabilities.CONTAINERMODE]: echoConnector()18  }, mergeCaps)19  const result = {}20  result.driver = new BotDriver(myCaps)21  result.compiler = result.driver.BuildCompiler()22  result.container = await result.driver.Build()23  return result24}25describe('convo.customasserters', function () {26  beforeEach(async function () {27    const { compiler, container } = await buildDriver(myCaps)28    this.compiler = compiler29    this.container = container30    await this.container.Start()31  })32  afterEach(async function () {33    await this.container.Stop()34    await this.container.Clean()35  })36  it('should fail', async function () {37    this.compiler.ReadScript(path.resolve(__dirname, 'convos'), 'customembeddedasserterwithouthugo.convo.txt')38    try {39      await this.compiler.convos[0].Run(this.container)40    } catch (err) {41      assert.isTrue(err.message.indexOf('expected hugo') >= 0)42      return43    }44    assert.fail('should have failed without retry')45  })46  it('should succeed', async function () {47    this.compiler.ReadScript(path.resolve(__dirname, 'convos'), 'customembeddedasserterwithhugo.convo.txt')48    await this.compiler.convos[0].Run(this.container)49  })...

1const path = require('path')2const BotDriver = require('../../..').BotDriver3const Capabilities = require('../../..').Capabilities4const myCaps = require('./customEmbedded')5const echoConnector = () => ({ queueBotSays }) => {6  return {7    UserSays (msg) {8      const botMsg = { sender: 'bot', sourceData: msg.sourceData, messageText: msg.messageText }9      queueBotSays(botMsg)10    }11  }12}13const buildDriver = async (mergeCaps) => {14  const myCaps = Object.assign({15    [Capabilities.PROJECTNAME]: 'convo.customasserters',16    [Capabilities.CONTAINERMODE]: echoConnector()17  }, mergeCaps)18  const result = {}19  result.driver = new BotDriver(myCaps)20  result.compiler = result.driver.BuildCompiler()21  result.container = await result.driver.Build()22  return result23}24describe('convo.customasserters', function () {25  beforeEach(async function () {26    const { compiler, container } = await buildDriver(myCaps)27    this.compiler = compiler28    this.container = container29    await this.container.Start()30  })31  afterEach(async function () {32    await this.container.Stop()33    await this.container.Clean()34  })35  it('should success', async function () {36    this.compiler.ReadScript(path.resolve(__dirname, 'convos'), 'custom_embedded.convo.txt')37    await this.compiler.convos[0].Run(this.container)38  })...