test-messages.js

/**
 * Define a common set of test messages along with data on how to set up 
 * related framework.hears() handlers to validate framework behavior.
 * 
 * @property {string} msgText - message user will send in the test
 * @property {string} msgFiles - url to a file to include in message
 * @property {int} mentionIndex - 0 index word position where bot mention should be added
 *                                if not set, bot mention is inserted before msgText
 * @property {array} hearsInfo - array of objects that describes a 
 *                                hears() handler to register for the test
 * 
 * @namespace {object} hearsInfo[]
 * Array of object to describe how to register hears() handler.  Only phrase is required
 * @property {string | regex} phrase - phrase for hears handler
 * @property {string} helpstring - help message to register with handler
 * @property {integer} priority - priority of hears handler
 * @property {string} command - expected value in trigger.command
 * @property {string} prompt - expected value in trigger.prompt
 * 
 * All messages defined here will be used in the following tests:
 * - bot-created-room-tests.js   
 * - bot-membership-rules-tests.js  
 * - guide-mode-rules-tests.jus                           
 * - user-created-room-tests.js
 * 
 * During iterative development is may be helpful to comment out all but one or
 * two problematic phrases while running tests
 */

// TODO - Add some hearsInfo phrases that should not match and update the test
// framework to check that the appropriate ones have (or have not) been called
var common = require('../common/common');
 
module.exports = {
  testMessages: [
    {
      msgText: 'hi', 
      hearsInfo: [{phrase: 'hi'}]
    },
    {
      msgText: 'Here is a file for ya',
      msgFiles: process.env.HOSTED_FILE,
      hearsInfo: [{phrase: /.*file.*/im}]
    },
    {
      msgText: 'Here is a whole mess of stuff for ya',
      hearsInfo: [{
        phrase: /.*/im,
        helpString: '',
        priority: 99
      }]
    },
    {
      msgText: 'Here is a Some Stuff for ya',
      hearsInfo: [
        {
          phrase: /.*Some Stuf.*/im,
          helpString: '',
          // Will fix multiple different priority tests in subsequent PR
          //priority: 2 // lower number == higher priority
        },
        {
          phrase: /.*/im,
          helpString: 'This is the catch all',
          // Will fix multiple different priority tests in subsequent PR
          //priority: 100 // lower number == higher priority
        }
      ]
    },
    {
      msgText: 'echo this is the echo message',
      hearsInfo: [
        {
          phrase: /echo\s/,
          command: 'echo ',
          prompt: 'this is the echo message',
          helpString: '',
          // Will fix multiple different priority tests in subsequent PR
          // priority: 2 // lower number == higher priority
        },
        {
          phrase: /.*/,
          command: 'echo this is the echo message',
          prompt: '',
          helpString: 'This is the catch all',
          // Will fix multiple different priority tests in subsequent PR
          //priority: 100 // lower number == higher priority
        }
      ]
    },
    {
      msgText: 'just do it man',
      hearsInfo: [
        {
          phrase: /(^| )do it($| )/i,
          command: ' do it ',
          prompt: 'man',
          helpString: '',
          // Will fix multiple different priority tests in subsequent PR
          // priority: 2 // lower number == higher priority
        },
        {
          phrase: /.*/,
          command: 'just do it man',
          prompt: '',
          helpString: 'This is the catch all',
          // Will fix multiple different priority tests in subsequent PR
          //priority: 100 // lower number == higher priority
        }
      ]
    },
    {
      msgText: 'hello. please echo this is the echo message',
      // This will result in "hello. please @bot echo this is the echo message"
      mentionIndex: 2,
      hearsInfo: [
        {
          phrase: /(^| )echo( |$)/i,
          command: ' echo ',
          prompt: 'this is the echo message',
          helpString: '',
          // Will fix multiple different priority tests in subsequent PR
          // priority: 2 // lower number == higher priority
        },
        {
          phrase: /.*/,
          command: 'hello. please echo this is the echo message',
          prompt: '',
          helpString: 'This is the catch all',
          // Will fix multiple different priority tests in subsequent PR
          //priority: 100 // lower number == higher priority
        }
      ]
    },    
    {
      msgText: 'hello. please echo this is the echo message',
      // This will result in "hello. please echo this is the echo message @bot"
      mentionIndex: 7,
      hearsInfo: [
        {
          phrase: /(^| )echo( |$)/i,
          command: ' echo ',
          prompt: 'this is the echo message',
          helpString: '',
          // Will fix multiple different priority tests in subsequent PR
          // priority: 2 // lower number == higher priority
        },
        {
          phrase: /.*/,
          command: 'hello. please echo this is the echo message',
          prompt: '',
          helpString: 'This is the catch all',
          // Will fix multiple different priority tests in subsequent PR
          //priority: 100 // lower number == higher priority
        }
      ]
    }    
  ],

  // External Helper function to iterate through all the user sent msg tests 
  runUserMessageTests: function(framework, testInfo, testMessages, botShouldRespond=true) {
    let behavior = 'should';
    if (!botShouldRespond) {
      behavior += ' not';
    }
    testMessages.forEach((testData) => {
      let userMsgTest = `user says ${testData.msgText}`;
      let botResponseTest = `bot ${behavior} respond to ${testData.msgText}`;

        
      // Don't use ES6 arrow functions to access mocha as this
      it(userMsgTest, function() {
        testInfo.config.testName = userMsgTest;
        if ((testInfo.config?.isDirectTest) && (!common?.botForUser1on1Space)) {
          this.skip();
        }        
        return common.userSendMessage(framework, testInfo, testData)
          .then((trigger) => {
            testInfo.config.priorTestsTrigger = trigger;
          });
      });

      it(botResponseTest, function() {
        testInfo.config.testName = botResponseTest;
        if ((testInfo.config?.isDirectTest) && (!common?.botForUser1on1Space)) {
          this.skip();
        }        
        return common.botRespondsToTrigger(framework,
          testInfo, botShouldRespond);
      });

      it(`clears framework.hears for ${testData.msgText}`, function() {
        if ((testInfo.config?.isDirectTest) && (!common?.botForUser1on1Space)) {
          this.skip();
        }        
        delete testInfo.config.priorTestsTrigger;
        testData.hearsInfo.forEach((info) => {
          framework.clearHears(info.functionId);
        });
      });
    });
  },
};