est-base.21.3.5.source-code.BotBusMockInitializers.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2017/2021 e-voyageurs technologies
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ai.tock.bot.test

import ai.tock.bot.connector.ConnectorType
import ai.tock.bot.definition.BotDefinition
import ai.tock.bot.definition.StoryDefinition
import ai.tock.bot.engine.action.Action
import ai.tock.bot.engine.action.SendSentence
import ai.tock.bot.engine.user.PlayerId
import ai.tock.bot.engine.user.PlayerType
import ai.tock.bot.engine.user.UserPreferences
import ai.tock.translator.UserInterfaceType
import java.util.Locale

/**
 * Provides a mock initialized with the specified [StoryDefinition] and starts the story.
 */
fun BotDefinition.startNewBusMock(
    testContext: TestContext = currentTestContext,
    story: StoryDefinition = testContext.defaultStoryDefinition(this),
    connectorType: ConnectorType = testContext.defaultConnectorType(),
    locale: Locale = testContext.defaultLocale(),
    userId: PlayerId = testContext.defaultPlayerId()
): BotBusMock =
    newBusMock(testContext, story, connectorType, locale, userId).run()

/**
 * Provides a mock initialized with the specified [StoryDefinition].
 */
fun BotDefinition.newBusMock(
    testContext: TestContext = currentTestContext,
    story: StoryDefinition = testContext.defaultStoryDefinition(this),
    connectorType: ConnectorType = testContext.defaultConnectorType(),
    locale: Locale = testContext.defaultLocale(),
    userId: PlayerId = testContext.defaultPlayerId()
): BotBusMock =
    BotBusMock(newBusMockContext(testContext, story, connectorType, locale, userId))

/**
 * Provides a mock context initialized with the specified [StoryDefinition].
 */
fun BotDefinition.newBusMockContext(
    testContext: TestContext = currentTestContext,
    story: StoryDefinition = testContext.defaultStoryDefinition(this),
    connectorType: ConnectorType = testContext.defaultConnectorType(),
    locale: Locale = testContext.defaultLocale(),
    userId: PlayerId = testContext.defaultPlayerId(),
    botId: PlayerId = PlayerId("bot", PlayerType.bot),
    action: Action = SendSentence(userId, this.botId, botId, ""),
    userInterfaceType: UserInterfaceType = UserInterfaceType.textChat,
    userPreferences: UserPreferences = UserPreferences(locale = locale)
): BotBusMockContext =
    BotBusMockContext(
        this,
        story,
        this.botId,
        userId,
        botId,
        action,
        userInterfaceType,
        userPreferences,
        connectorType,
        testContext
    )

/**
 * Provides a mock context initialized with the specified [TestContext] and runs the story.
 */
fun startBusMock(testContext: TestContext = currentTestContext): BotBusMock = busMock(testContext).run()

/**
 * Provides a mock context initialized with the specified [TestContext].
 */
fun busMock(testContext: TestContext = currentTestContext): BotBusMock = BotBusMock(testContext.botBusMockContext)