agents-test/ai.koog.agents.testing.tools/MockLLMBuilder

MockLLMBuilder

Builder class for creating mock LLM executors for testing.

This class provides a fluent API for configuring mock responses for LLM requests and tool calls. It allows you to define how the LLM should respond to different inputs and how tools should behave when called during testing.

Example usage:

val mockLLMApi = getMockExecutor(toolRegistry) {
    // Mock LLM text responses
    mockLLMAnswer("Hello!") onRequestContains "Hello"
    mockLLMAnswer("I don't know how to answer that.").asDefaultResponse

    // Mock LLM tool calls
    mockLLMToolCall(CreateTool, CreateTool.Args("solve")) onRequestEquals "Solve task"

    // Mock tool behavior
    mockTool(PositiveToneTool) alwaysReturns "The text has a positive tone."
    mockTool(NegativeToneTool) alwaysTells {
        println("Negative tone tool called")
        "The text has a negative tone."
    }
}

Constructors

MockLLMBuilder

constructor()

Types

MockToolReceiver

class MockToolReceiver<Args : Tool.Args, Result : ToolResult>(tool: Tool<Args, Result>, builder: MockLLMBuilder)

Receiver class for configuring tool behavior during testing.

ToolCallReceiver

class ToolCallReceiver<Args : Tool.Args>(tool: Tool<Args, *>, args: Args, builder: MockLLMBuilder)

Receiver class for configuring tool call responses from the LLM.

Functions

addLLMAnswerExactPattern

fun <Args : Tool.Args> addLLMAnswerExactPattern(llmAnswer: String, tool: Tool<Args, *>, args: Args)

Adds an exact pattern match for an LLM answer that triggers a tool call.

addToolAction

fun <Args : Tool.Args, Result : ToolResult> addToolAction(tool: Tool<Args, Result>, argsCondition: suspend (Args) -> Boolean = { true }, action: suspend (Args) -> Result)

Adds a tool action to be executed when a tool call matches the specified condition.

alwaysReturns

infix fun <Args : Tool.Args> MockLLMBuilder.MockToolReceiver<Args, ToolResult.Text>.alwaysReturns(response: String)

Convenience extension function for configuring a text tool to always return the specified string.

alwaysTells

infix fun <Args : Tool.Args> MockLLMBuilder.MockToolReceiver<Args, ToolResult.Text>.alwaysTells(action: suspend () -> String)

Convenience extension function for configuring a text tool to always execute the specified action and return its string result.

build

fun build(): PromptExecutor

Builds and returns a PromptExecutor configured with the mock responses and tool actions.

doesStr

infix fun <Args : Tool.Args> MockLLMBuilder.MockToolReceiver<Args, ToolResult.Text>.doesStr(action: suspend () -> String): MockLLMBuilder.MockToolReceiver.MockToolResponseBuilder<Args, ToolResult.Text>

Convenience extension function for configuring a text tool to execute the specified action and return its string result when it receives matching arguments.

mockLLMToolCall