extensiontest

package
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 19, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package extensiontest provides test doubles for the extension.API surface. The primary export is Fake, a no-op extension.API implementation that records every call. Use it in unit tests for code that consumes the API surface without standing up a real host.

Example:

api := extensiontest.NewFake()
myExtension(api)
if len(api.RegisterToolCalls) != 1 {
    t.Fatalf("expected one tool registered, got %d", len(api.RegisterToolCalls))
}

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewMemBus

func NewMemBus() extension.EventBusController

NewMemBus returns a fresh in-process event bus, extension.CreateEventBus.

Types

type AppendEntryCall

type AppendEntryCall struct {
	CustomType string
	Data       any
}

type ExecCall

type ExecCall struct {
	Command string
	Args    []string
	Options *extension.ExecOptions
}

type Fake

type Fake struct {

	// ── Event subscriptions ──
	OnProjectTrustHandlers          []extension.ProjectTrustHandler
	OnResourcesDiscoverHandlers     []func(ctx context.Context, evt extension.ResourcesDiscoverEvent) (extension.ResourcesDiscoverResult, error)
	OnSessionStartHandlers          []func(ctx context.Context, evt extension.SessionStartEvent) error
	OnSessionInfoChangedHandlers    []func(ctx context.Context, evt extension.SessionInfoChangedEvent) error
	OnMcpServersChangeHandlers      []func(ctx context.Context, evt extension.McpServersChangeEvent) error
	OnProviderStreamEventHandlers   []func(ctx context.Context, evt extension.ProviderStreamEvent) error
	OnSessionBeforeSwitchHandlers   []func(ctx context.Context, evt extension.SessionBeforeSwitchEvent) (extension.SessionBeforeSwitchResult, error)
	OnSessionBeforeForkHandlers     []func(ctx context.Context, evt extension.SessionBeforeForkEvent) (extension.SessionBeforeForkResult, error)
	OnSessionBeforeCompactHandlers  []func(ctx context.Context, evt extension.SessionBeforeCompactEvent) (extension.SessionBeforeCompactResult, error)
	OnSessionCompactHandlers        []func(ctx context.Context, evt extension.SessionCompactEvent) error
	OnSessionCompactFailedHandlers  []func(ctx context.Context, evt extension.SessionCompactFailedEvent) error
	OnSessionShutdownHandlers       []func(ctx context.Context, evt extension.SessionShutdownEvent) error
	OnSessionBeforeTreeHandlers     []func(ctx context.Context, evt extension.SessionBeforeTreeEvent) (extension.SessionBeforeTreeResult, error)
	OnSessionTreeHandlers           []func(ctx context.Context, evt extension.SessionTreeEvent) error
	OnContextHandlers               []func(ctx context.Context, evt extension.ContextEvent) (extension.ContextEventResult, error)
	OnContextWithSystemHandlers     []func(ctx context.Context, evt extension.ContextWithSystemEvent) (extension.ContextEventResult, error)
	OnBeforeProviderRequestHandlers []func(ctx context.Context, evt extension.BeforeProviderRequestEvent) (extension.BeforeProviderRequestEventResult, error)
	OnAfterProviderResponseHandlers []func(ctx context.Context, evt extension.AfterProviderResponseEvent) error
	OnBeforeProviderHeadersHandlers []func(ctx context.Context, evt extension.BeforeProviderHeadersEvent) error
	OnBeforeAgentStartHandlers      []func(ctx context.Context, evt extension.BeforeAgentStartEvent) (extension.BeforeAgentStartEventResult, error)
	OnAgentStartHandlers            []func(ctx context.Context, evt extension.AgentStartEvent) error
	OnAgentEndHandlers              []func(ctx context.Context, evt extension.AgentEndEvent) error
	OnAgentBeforeSettleHandlers     []func(ctx context.Context, evt *extension.AgentBeforeSettleEvent) (extension.AgentBeforeSettleEventResult, error)
	OnAgentSettledHandlers          []func(ctx context.Context, evt extension.AgentSettledEvent) error
	OnUiPromptStartHandlers         []func(ctx context.Context, evt extension.UIPromptStartEvent) error
	OnUiPromptEndHandlers           []func(ctx context.Context, evt extension.UIPromptEndEvent) error
	OnCacheWarmingDecisionHandlers  []func(ctx context.Context, evt extension.CacheWarmingDecisionEvent) (extension.CacheWarmingDecisionEventResult, error)
	OnTurnStartHandlers             []func(ctx context.Context, evt extension.TurnStartEvent) error
	OnTurnEndHandlers               []func(ctx context.Context, evt extension.TurnEndEvent) (extension.TurnEndEventResult, error)
	OnMessageStartHandlers          []func(ctx context.Context, evt extension.MessageStartEvent) error
	OnMessageUpdateHandlers         []func(ctx context.Context, evt extension.MessageUpdateEvent) error
	OnMessageEndHandlers            []func(ctx context.Context, evt extension.MessageEndEvent) (extension.MessageEndEventResult, error)
	OnToolExecutionStartHandlers    []func(ctx context.Context, evt extension.ToolExecutionStartEvent) error
	OnToolExecutionUpdateHandlers   []func(ctx context.Context, evt extension.ToolExecutionUpdateEvent) error
	OnToolExecutionEndHandlers      []func(ctx context.Context, evt extension.ToolExecutionEndEvent) error
	OnModelSelectHandlers           []func(ctx context.Context, evt extension.ModelSelectEvent) error
	OnThinkingLevelSelectHandlers   []func(ctx context.Context, evt extension.ThinkingLevelSelectEvent) error
	OnToolCallHandlers              []func(ctx context.Context, evt extension.ToolCallEvent) (extension.ToolCallEventResult, error)
	OnToolResultHandlers            []func(ctx context.Context, evt extension.ToolResultEvent) (extension.ToolResultEventResult, error)
	OnUserBashHandlers              []func(ctx context.Context, evt extension.UserBashEvent) (extension.UserBashEventResult, error)
	OnInputHandlers                 []func(ctx context.Context, evt extension.InputEvent) (extension.InputEventResult, error)

	// ── Registrations ──
	RegisterToolCalls            []extension.ToolDefinition
	RegisterCommandCalls         []RegisterCommandCall
	RegisterShortcutCalls        []RegisterShortcutCall
	RegisterFlagCalls            []RegisterFlagCall
	RegisterMessageRendererCalls []RegisterMessageRendererCall
	RegisterEntryRendererCalls   []RegisterEntryRendererCall
	RegisterMarkdownTransformers []extension.MarkdownTransformer
	RegisterToolRenderers        []extension.ToolRendererResolver
	RegisterProviderCalls        []RegisterProviderCall
	RegisterNativeProviderCalls  []*ai.ModelsProvider
	UnregisterProviderCalls      []string
	RegisterMcpServerCalls       []RegisterMcpServerCall
	UnregisterMcpServerCalls     []string
	McpServers                   []extension.RegisteredMcpServer
	RegisterVirtualModelCalls    []extension.ExtensionVirtualModel
	UnregisterVirtualModelCalls  []UnregisterVirtualModelCall

	// ── Actions ──
	SendMessageCalls     []SendMessageCall
	SendUserMessageCalls []SendUserMessageCall
	AppendEntryCalls     []AppendEntryCall

	// ── Session metadata ──
	SessionName         string
	SetLabelCalls       []SetLabelCall
	ExecCalls           []ExecCall
	ActiveTools         []string
	AllTools            []extension.ToolInfo
	Commands            []extension.SlashCommandInfo
	SetActiveToolsCalls [][]string
	Settings            extension.Settings

	// ── Model + thinking ──
	CurrentModel          extension.Model
	SetModelCalls         []extension.Model
	SetModelReturn        bool
	ThinkingLevel         extension.ThinkingLevel
	SetThinkingLevelCalls []extension.ThinkingLevel

	// ── Flags ──
	Flags map[string]any

	// ── Event bus ──
	Bus extension.EventBus
	// contains filtered or unexported fields
}

Fake is a recording, no-op implementation of extension.API. Each method appends to a per-method call slice; tests assert on those slices.

Fake is NOT goroutine-safe. Tests that drive a fake from multiple goroutines must wrap access with their own synchronisation.

func NewFake

func NewFake() *Fake

NewFake returns a fresh Fake with a [Bus] backed by NewMemBus.

func (*Fake) AppendEntry

func (f *Fake) AppendEntry(customType string, data any)

func (*Fake) Events

func (f *Fake) Events() extension.EventBus

func (*Fake) Exec

func (f *Fake) Exec(command string, args []string, options *extension.ExecOptions) (extension.ExecResult, error)

func (*Fake) GetActiveTools

func (f *Fake) GetActiveTools() []string

func (*Fake) GetAllTools

func (f *Fake) GetAllTools() []extension.ToolInfo

func (*Fake) GetCommands

func (f *Fake) GetCommands() []extension.SlashCommandInfo

func (*Fake) GetFlag

func (f *Fake) GetFlag(name string) any

func (*Fake) GetMcpServers

func (f *Fake) GetMcpServers() []extension.RegisteredMcpServer

func (*Fake) GetSessionName

func (f *Fake) GetSessionName() string

func (*Fake) GetSettings

func (f *Fake) GetSettings() extension.Settings

func (*Fake) GetThinkingLevel

func (f *Fake) GetThinkingLevel() extension.ThinkingLevel

func (*Fake) OnAfterProviderResponse

func (f *Fake) OnAfterProviderResponse(h func(ctx context.Context, evt extension.AfterProviderResponseEvent) error) func()

func (*Fake) OnAgentBeforeSettle

func (f *Fake) OnAgentBeforeSettle(h func(ctx context.Context, evt *extension.AgentBeforeSettleEvent) (extension.AgentBeforeSettleEventResult, error)) func()

func (*Fake) OnAgentEnd

func (f *Fake) OnAgentEnd(h func(ctx context.Context, evt extension.AgentEndEvent) error) func()

func (*Fake) OnAgentSettled

func (f *Fake) OnAgentSettled(h func(ctx context.Context, evt extension.AgentSettledEvent) error) func()

func (*Fake) OnAgentStart

func (f *Fake) OnAgentStart(h func(ctx context.Context, evt extension.AgentStartEvent) error) func()

func (*Fake) OnBeforeAgentStart

func (f *Fake) OnBeforeAgentStart(h func(ctx context.Context, evt extension.BeforeAgentStartEvent) (extension.BeforeAgentStartEventResult, error)) func()

func (*Fake) OnBeforeProviderHeaders

func (f *Fake) OnBeforeProviderHeaders(h func(ctx context.Context, evt extension.BeforeProviderHeadersEvent) error) func()

func (*Fake) OnBeforeProviderRequest

func (f *Fake) OnBeforeProviderRequest(h func(ctx context.Context, evt extension.BeforeProviderRequestEvent) (extension.BeforeProviderRequestEventResult, error)) func()

func (*Fake) OnCacheWarmingDecision

func (f *Fake) OnCacheWarmingDecision(h func(ctx context.Context, evt extension.CacheWarmingDecisionEvent) (extension.CacheWarmingDecisionEventResult, error)) func()

func (*Fake) OnContext

func (f *Fake) OnContext(h func(ctx context.Context, evt extension.ContextEvent) (extension.ContextEventResult, error)) func()

func (*Fake) OnContextWithSystem

func (f *Fake) OnContextWithSystem(h func(ctx context.Context, evt extension.ContextWithSystemEvent) (extension.ContextEventResult, error)) func()

func (*Fake) OnInput

func (f *Fake) OnInput(h func(ctx context.Context, evt extension.InputEvent) (extension.InputEventResult, error)) func()

func (*Fake) OnMcpServersChange

func (f *Fake) OnMcpServersChange(h func(ctx context.Context, evt extension.McpServersChangeEvent) error) func()

func (*Fake) OnMessageEnd

func (f *Fake) OnMessageEnd(h func(ctx context.Context, evt extension.MessageEndEvent) (extension.MessageEndEventResult, error)) func()

func (*Fake) OnMessageStart

func (f *Fake) OnMessageStart(h func(ctx context.Context, evt extension.MessageStartEvent) error) func()

func (*Fake) OnMessageUpdate

func (f *Fake) OnMessageUpdate(h func(ctx context.Context, evt extension.MessageUpdateEvent) error) func()

func (*Fake) OnModelSelect

func (f *Fake) OnModelSelect(h func(ctx context.Context, evt extension.ModelSelectEvent) error) func()

func (*Fake) OnProjectTrust

func (f *Fake) OnProjectTrust(h extension.ProjectTrustHandler) func()

func (*Fake) OnProviderStreamEvent

func (f *Fake) OnProviderStreamEvent(h func(ctx context.Context, evt extension.ProviderStreamEvent) error) func()

func (*Fake) OnResourcesDiscover

func (f *Fake) OnResourcesDiscover(h func(ctx context.Context, evt extension.ResourcesDiscoverEvent) (extension.ResourcesDiscoverResult, error)) func()

func (*Fake) OnSessionBeforeCompact

func (f *Fake) OnSessionBeforeCompact(h func(ctx context.Context, evt extension.SessionBeforeCompactEvent) (extension.SessionBeforeCompactResult, error)) func()

func (*Fake) OnSessionBeforeFork

func (f *Fake) OnSessionBeforeFork(h func(ctx context.Context, evt extension.SessionBeforeForkEvent) (extension.SessionBeforeForkResult, error)) func()

func (*Fake) OnSessionBeforeSwitch

func (f *Fake) OnSessionBeforeSwitch(h func(ctx context.Context, evt extension.SessionBeforeSwitchEvent) (extension.SessionBeforeSwitchResult, error)) func()

func (*Fake) OnSessionBeforeTree

func (f *Fake) OnSessionBeforeTree(h func(ctx context.Context, evt extension.SessionBeforeTreeEvent) (extension.SessionBeforeTreeResult, error)) func()

func (*Fake) OnSessionCompact

func (f *Fake) OnSessionCompact(h func(ctx context.Context, evt extension.SessionCompactEvent) error) func()

func (*Fake) OnSessionCompactFailed

func (f *Fake) OnSessionCompactFailed(h func(ctx context.Context, evt extension.SessionCompactFailedEvent) error) func()

func (*Fake) OnSessionInfoChanged

func (f *Fake) OnSessionInfoChanged(h func(ctx context.Context, evt extension.SessionInfoChangedEvent) error) func()

func (*Fake) OnSessionShutdown

func (f *Fake) OnSessionShutdown(h func(ctx context.Context, evt extension.SessionShutdownEvent) error) func()

func (*Fake) OnSessionStart

func (f *Fake) OnSessionStart(h func(ctx context.Context, evt extension.SessionStartEvent) error) func()

func (*Fake) OnSessionTree

func (f *Fake) OnSessionTree(h func(ctx context.Context, evt extension.SessionTreeEvent) error) func()

func (*Fake) OnThinkingLevelSelect

func (f *Fake) OnThinkingLevelSelect(h func(ctx context.Context, evt extension.ThinkingLevelSelectEvent) error) func()

func (*Fake) OnToolCall

func (f *Fake) OnToolCall(h func(ctx context.Context, evt extension.ToolCallEvent) (extension.ToolCallEventResult, error)) func()

func (*Fake) OnToolExecutionEnd

func (f *Fake) OnToolExecutionEnd(h func(ctx context.Context, evt extension.ToolExecutionEndEvent) error) func()

func (*Fake) OnToolExecutionStart

func (f *Fake) OnToolExecutionStart(h func(ctx context.Context, evt extension.ToolExecutionStartEvent) error) func()

func (*Fake) OnToolExecutionUpdate

func (f *Fake) OnToolExecutionUpdate(h func(ctx context.Context, evt extension.ToolExecutionUpdateEvent) error) func()

func (*Fake) OnToolResult

func (f *Fake) OnToolResult(h func(ctx context.Context, evt extension.ToolResultEvent) (extension.ToolResultEventResult, error)) func()

func (*Fake) OnTurnEnd

func (f *Fake) OnTurnEnd(h func(ctx context.Context, evt extension.TurnEndEvent) (extension.TurnEndEventResult, error)) func()

func (*Fake) OnTurnStart

func (f *Fake) OnTurnStart(h func(ctx context.Context, evt extension.TurnStartEvent) error) func()

func (*Fake) OnUiPromptEnd

func (f *Fake) OnUiPromptEnd(h func(ctx context.Context, evt extension.UIPromptEndEvent) error) func()

func (*Fake) OnUiPromptStart

func (f *Fake) OnUiPromptStart(h func(ctx context.Context, evt extension.UIPromptStartEvent) error) func()

func (*Fake) OnUserBash

func (f *Fake) OnUserBash(h func(ctx context.Context, evt extension.UserBashEvent) (extension.UserBashEventResult, error)) func()

func (*Fake) RegisterCommand

func (f *Fake) RegisterCommand(name string, options extension.CommandOptions)

func (*Fake) RegisterEntryRenderer

func (f *Fake) RegisterEntryRenderer(customType string, renderer extension.EntryRenderer)

func (*Fake) RegisterFlag

func (f *Fake) RegisterFlag(name string, options extension.FlagOptions)

func (*Fake) RegisterMarkdownTransformer

func (f *Fake) RegisterMarkdownTransformer(transformer extension.MarkdownTransformer)

func (*Fake) RegisterMcpServer

func (f *Fake) RegisterMcpServer(name string, config extension.McpServerConfig) error

func (*Fake) RegisterMessageRenderer

func (f *Fake) RegisterMessageRenderer(customType string, renderer extension.MessageRenderer)

func (*Fake) RegisterNativeProvider

func (f *Fake) RegisterNativeProvider(provider *ai.ModelsProvider)

func (*Fake) RegisterProvider

func (f *Fake) RegisterProvider(name string, config extension.ProviderConfig)

func (*Fake) RegisterShortcut

func (f *Fake) RegisterShortcut(shortcut extension.KeyID, options extension.ShortcutOptions)

func (*Fake) RegisterTool

func (f *Fake) RegisterTool(tool extension.ToolDefinition)

func (*Fake) RegisterToolRenderer

func (f *Fake) RegisterToolRenderer(resolver extension.ToolRendererResolver)

func (*Fake) RegisterVirtualModel

func (f *Fake) RegisterVirtualModel(model extension.ExtensionVirtualModel)

func (*Fake) SendMessage

func (f *Fake) SendMessage(message extension.SendMessagePayload, options *extension.SendMessageOptions)

func (*Fake) SendUserMessage

func (f *Fake) SendUserMessage(content any, options *extension.SendUserMessageOptions)

func (*Fake) SetActiveTools

func (f *Fake) SetActiveTools(toolNames []string)

func (*Fake) SetLabel

func (f *Fake) SetLabel(entryID string, label string)

func (*Fake) SetModel

func (f *Fake) SetModel(model extension.Model) (bool, error)

func (*Fake) SetSessionName

func (f *Fake) SetSessionName(name string)

func (*Fake) SetThinkingLevel

func (f *Fake) SetThinkingLevel(level extension.ThinkingLevel)

func (*Fake) UnregisterMcpServer

func (f *Fake) UnregisterMcpServer(name string)

func (*Fake) UnregisterProvider

func (f *Fake) UnregisterProvider(name string)

func (*Fake) UnregisterVirtualModel

func (f *Fake) UnregisterVirtualModel(provider, id string)

type RegisterCommandCall

type RegisterCommandCall struct {
	Name    string
	Options extension.CommandOptions
}

type RegisterEntryRendererCall

type RegisterEntryRendererCall struct {
	CustomType string
	Renderer   extension.EntryRenderer
}

type RegisterFlagCall

type RegisterFlagCall struct {
	Name    string
	Options extension.FlagOptions
}

type RegisterMcpServerCall

type RegisterMcpServerCall struct {
	Name   string
	Config extension.McpServerConfig
}

RegisterMcpServerCall records one RegisterMcpServer call.

type RegisterMessageRendererCall

type RegisterMessageRendererCall struct {
	CustomType string
	Renderer   extension.MessageRenderer
}

type RegisterProviderCall

type RegisterProviderCall struct {
	Name   string
	Config extension.ProviderConfig
}

type RegisterShortcutCall

type RegisterShortcutCall struct {
	Shortcut extension.KeyID
	Options  extension.ShortcutOptions
}

type SendMessageCall

type SendMessageCall struct {
	Message extension.SendMessagePayload
	Options *extension.SendMessageOptions
}

type SendUserMessageCall

type SendUserMessageCall struct {
	Content any
	Options *extension.SendUserMessageOptions
}

type SetLabelCall

type SetLabelCall struct {
	EntryID string
	Label   string
}

type UnregisterVirtualModelCall

type UnregisterVirtualModelCall struct {
	Provider string
	ID       string
}

UnregisterVirtualModelCall records one UnregisterVirtualModel call.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL