[ARO] Adding a feature to make tester able to create their own test

Author: erbizard

.gitignore

@@ -4,4 +4,5 @@ yarn-error.log
 .coveralls.yml
 .nyc_output
 coverage
-*.ava.spec.js
+*.ava.spec.js
+.idea

README.md

@@ -242,7 +242,28 @@ describe('BotTester', () => {
             .runTest();
     });
 ```
-
+# Make your own tests
+```javascript
+      it("should make you able to write your own tests", () => {
+        bot.dialog('/', (session) => {
+          session.send("Hello");
+          session.send("12");
+        });
+        return botTester.sendMessageToBot('Bonjour',(message) => {
+          if (message.text === "Hello") {
+            return true;
+          } else {
+            return new Error("Message : " + message.text + "is not equal to 'Hello'")
+          }
+        },(message)=>{
+           if (parseInt(message.text,0) % 2 === 0) {
+               return true;
+             } else {
+               return new Error("Message is not an even number : " + message.text);
+             }
+          }).runTest();
+      });
+```
 # Address/multiuser cases
 ```javascript
     describe('Address/multi user', () => {

src/ExpectedMessage.ts

@@ -1,17 +1,19 @@
-import { IEvent, IMessage } from 'botbuilder';
-import { BotTesterExpectation } from './assertionLibraries/BotTesterExpectation';
-import { IConfig } from './config';
+import {IEvent, IMessage} from 'botbuilder';
+import {assert} from 'chai';
+import {BotTesterExpectation} from './assertionLibraries/BotTesterExpectation';
+import {IConfig} from './config';
 
 export enum ExpectedMessageType {
     String,
     IMessage,
-    Regex
+    Regex,
+    Function
 }
 
 /**
  * Types accepted for responses checkers
  */
-export type PossibleExpectedMessageType = string | IMessage | RegExp | IEvent;
+export type PossibleExpectedMessageType = string | IMessage | RegExp | IEvent | Function;
 
 /**
  * Response expectations area always collections. The collection is the set of possible responses, chosen at random. If the collection size
@@ -26,8 +28,10 @@ function getExpectedMessageType(expectedResponseCollection: PossibleExpectedMess
         return ExpectedMessageType.String;
     } else if (firstElt.constructor.name === 'RegExp') {
         return ExpectedMessageType.Regex;
-    } else {
+    } else if (firstElt.constructor.name === 'IMessage') {
         return ExpectedMessageType.IMessage;
+    } else {
+        return ExpectedMessageType.Function;
     }
 }
 
@@ -42,10 +46,8 @@ export class ExpectedMessage {
      */
     private readonly expectedResponseCollection: PossibleExpectedMessageCollections;
 
-    constructor(
-        config: IConfig,
-        expectedResponseCollection: PossibleExpectedMessageType | PossibleExpectedMessageCollections
-    ) {
+    constructor(config: IConfig,
+                expectedResponseCollection: PossibleExpectedMessageType | PossibleExpectedMessageCollections) {
         this.internalExpectation = new BotTesterExpectation(config);
 
         if (!(expectedResponseCollection instanceof Array)) {
@@ -73,6 +75,9 @@ export class ExpectedMessage {
                 // doing this check will highlight if the diff in text instead of a large IMessage diff
                 this.deepMessageMatchCheck(outgoingMessage);
                 break;
+            case ExpectedMessageType.Function:
+                this.deepMatchCheckWithFunction(outgoingMessage);
+                break;
             default:
                 this.internalExpectation.expect(outgoingMessage.type).toEqual('save');
         }
@@ -111,7 +116,7 @@ export class ExpectedMessage {
         const regexCollection: RegExp[] = this.expectedResponseCollection as RegExp[];
 
         this.internalExpectation.expect(regexCollection.some((regex: RegExp) => regex.test(text)),
-                                        `'${text}' did not match any regex in ${regexCollection}`).toBeTrue();
+            `'${text}' did not match any regex in ${regexCollection}`).toBeTrue();
     }
 
     /**
@@ -136,4 +141,30 @@ export class ExpectedMessage {
 
         this.internalExpectation.expect(expectedResponseCollectionAsIMessage).toDeeplyInclude(outgoingMessage);
     }
+
+    /**
+     *  Verfy the incoming message with custom test defined by tester
+     *  If the function that tester defined return an error, make the test break
+     *  If the function return anything else, the test is considered as good
+     *  I've tryed to use promise as parameter, but in a promise we change scope, so the assert doesn't work
+     * @param {IMessage} outgoingMessage outgoing message being compared
+     */
+    private deepMatchCheckWithFunction(outgoingMessage: IMessage): void {
+        const functionCollection: Function[] = this.expectedResponseCollection as Function[];
+        let errorString = '';
+        let success = false;
+        functionCollection.forEach((func: Function) => {
+            const result = func(outgoingMessage);
+            if (result instanceof Error) {
+                errorString += `\n -----------------ERROR-----------------\n\n\n'${result.message}' `;
+            } else {
+                success = true;
+            }
+        });
+        // ErrorString here, can hold multiples error, if the bot send multiples message in one batching
+        const error = `Bot should have relied response that matches with function but respond '${outgoingMessage}'` +
+            ` that create the following error(s) '${errorString}'`;
+        this.internalExpectation.expect(success, error).toBeTrue();
+
+    }
 }

test/mocha.opts

@@ -1,3 +1,3 @@
 --require ts-node/register
 --recursive
-test/*.spec.ts
+test/**/*mocha.spec.ts