bot-tester/dist/BotTester.d.ts

/// <reference types="bluebird" />
import * as Promise from 'bluebird';
import { IAddress, IMessage, Session, UniversalBot } from 'botbuilder';
import { IConfig } from './config';
import { PossibleExpectedMessageType } from './ExpectedMessage';
export declare type checkSessionFunction = (s: Session) => void;
/**
 * Test builder and runner for botbuilder bots
 */
export declare class BotTester {
    private bot;
    private defaultAddress;
    private sessionLoader;
    private messageService;
    private testSteps;
    /**
     *
     * @param bot bot that will be tested against
     * @param options (optional) options to pass to bot. Sets the default address and test timeout
     */
    constructor(bot: UniversalBot, options?: IConfig);
    /**
     * executes each test step serially
     */
    runTest(): Promise<any>;
    /**
     * loads a session associated with an address and passes it to a user defined function
     * @param sessionCheckerFunction function passed in to inspect message
     * @param address (Optional) address of the session to load. Defaults to bot's default address if not defined
     */
    checkSession(sessionCheckerFunction: checkSessionFunction, address?: IAddress): BotTester;
    /**
     * sends a message to a bot and compares bot responses against expectedResponsess. Expected responses can be a variable number of args,
     * each of which can be a single expected response of any PossibleExpectedMessageType or a collection of PossibleExpectedMessageType
     * that mocks a randomly selected response by the bot
     * @param msg message to send to bot
     * @param expectedResponses (Optional) responses the bot-tester framework checks against
     */
    sendMessageToBot(msg: IMessage | string, ...expectedResponses: (PossibleExpectedMessageType | PossibleExpectedMessageType[])[]): BotTester;
    sendMessageToBotIgnoringResponseOrder(msg: IMessage | string, ...expectedResponses: (PossibleExpectedMessageType | PossibleExpectedMessageType[])[]): BotTester;
    /**
     * sends a message to the bot. This should be used whenever session.save() is used without sending a reply to the user. This exists due
     * to a limitation in the current implementation of the botbuilder framework
     *
     * @param msg message to send to bot
     */
    sendMessageToBotAndExpectSaveWithNoResponse(msg: IMessage | string): BotTester;
    /**
     * Works exactly like Promise's .then function, except that the return value is not passed as an arg to the next function (even if its
     * another .then)
     * @param fn some function to run
     */
    then(fn: Function): BotTester;
    /**
     * Waits for the given delay between test steps.
     * @param delayInMiliseconds time to wait in milliseconds
     */
    wait(delayInMilliseconds: number): BotTester;
    private convertToIMessage(msg);
    /**
     * Packages the expected messages into an ExpectedMessage collection to be handed off to the MessageService's sendMessageToBot function
     * @param message message to be sent to bot
     * @param expectedResponses expected responses
     */
    private sendMessageToBotInternal(message, expectedResponses, ignoreOrder?);
}