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 ¶
- type AppendEntryCall
- type ExecCall
- type Fake
- func (f *Fake) AppendEntry(customType string, data any)
- func (f *Fake) Events() extension.EventBus
- func (f *Fake) Exec(command string, args []string, options *extension.ExecOptions) (extension.ExecResult, error)
- func (f *Fake) GetActiveTools() []string
- func (f *Fake) GetAllTools() []extension.ToolInfo
- func (f *Fake) GetCommands() []extension.SlashCommandInfo
- func (f *Fake) GetFlag(name string) any
- func (f *Fake) GetMcpServers() []extension.RegisteredMcpServer
- func (f *Fake) GetSessionName() string
- func (f *Fake) GetSettings() extension.Settings
- func (f *Fake) GetThinkingLevel() extension.ThinkingLevel
- func (f *Fake) OnAfterProviderResponse(h func(ctx context.Context, evt extension.AfterProviderResponseEvent) error)
- func (f *Fake) OnAgentBeforeSettle(...)
- func (f *Fake) OnAgentEnd(h func(ctx context.Context, evt extension.AgentEndEvent) error)
- func (f *Fake) OnAgentSettled(h func(ctx context.Context, evt extension.AgentSettledEvent) error)
- func (f *Fake) OnAgentStart(h func(ctx context.Context, evt extension.AgentStartEvent) error)
- func (f *Fake) OnBeforeAgentStart(...)
- func (f *Fake) OnBeforeProviderHeaders(h func(ctx context.Context, evt extension.BeforeProviderHeadersEvent) error)
- func (f *Fake) OnBeforeProviderRequest(...)
- func (f *Fake) OnContext(...)
- func (f *Fake) OnContextWithSystem(...)
- func (f *Fake) OnInput(...)
- func (f *Fake) OnMcpServersChange(h func(ctx context.Context, evt extension.McpServersChangeEvent) error)
- func (f *Fake) OnMessageEnd(...)
- func (f *Fake) OnMessageStart(h func(ctx context.Context, evt extension.MessageStartEvent) error)
- func (f *Fake) OnMessageUpdate(h func(ctx context.Context, evt extension.MessageUpdateEvent) error)
- func (f *Fake) OnModelSelect(h func(ctx context.Context, evt extension.ModelSelectEvent) error)
- func (f *Fake) OnProjectTrust(...)
- func (f *Fake) OnProviderStreamEvent(h func(ctx context.Context, evt extension.ProviderStreamEvent) error)
- func (f *Fake) OnResourcesDiscover(...)
- func (f *Fake) OnSessionBeforeCompact(...)
- func (f *Fake) OnSessionBeforeFork(...)
- func (f *Fake) OnSessionBeforeSwitch(...)
- func (f *Fake) OnSessionBeforeTree(...)
- func (f *Fake) OnSessionCompact(h func(ctx context.Context, evt extension.SessionCompactEvent) error)
- func (f *Fake) OnSessionCompactFailed(h func(ctx context.Context, evt extension.SessionCompactFailedEvent) error)
- func (f *Fake) OnSessionInfoChanged(h func(ctx context.Context, evt extension.SessionInfoChangedEvent) error)
- func (f *Fake) OnSessionShutdown(h func(ctx context.Context, evt extension.SessionShutdownEvent) error)
- func (f *Fake) OnSessionStart(h func(ctx context.Context, evt extension.SessionStartEvent) error)
- func (f *Fake) OnSessionTree(h func(ctx context.Context, evt extension.SessionTreeEvent) error)
- func (f *Fake) OnThinkingLevelSelect(h func(ctx context.Context, evt extension.ThinkingLevelSelectEvent) error)
- func (f *Fake) OnToolCall(...)
- func (f *Fake) OnToolExecutionEnd(h func(ctx context.Context, evt extension.ToolExecutionEndEvent) error)
- func (f *Fake) OnToolExecutionStart(h func(ctx context.Context, evt extension.ToolExecutionStartEvent) error)
- func (f *Fake) OnToolExecutionUpdate(h func(ctx context.Context, evt extension.ToolExecutionUpdateEvent) error)
- func (f *Fake) OnToolResult(...)
- func (f *Fake) OnTurnEnd(h func(ctx context.Context, evt extension.TurnEndEvent) error)
- func (f *Fake) OnTurnStart(h func(ctx context.Context, evt extension.TurnStartEvent) error)
- func (f *Fake) OnUiPromptEnd(h func(ctx context.Context, evt extension.UIPromptEndEvent) error)
- func (f *Fake) OnUiPromptStart(h func(ctx context.Context, evt extension.UIPromptStartEvent) error)
- func (f *Fake) OnUserBash(...)
- func (f *Fake) RegisterCommand(name string, options extension.CommandOptions)
- func (f *Fake) RegisterEntryRenderer(customType string, renderer extension.EntryRenderer)
- func (f *Fake) RegisterFlag(name string, options extension.FlagOptions)
- func (f *Fake) RegisterMarkdownTransformer(transformer extension.MarkdownTransformer)
- func (f *Fake) RegisterMcpServer(name string, config extension.McpServerConfig) error
- func (f *Fake) RegisterMessageRenderer(customType string, renderer extension.MessageRenderer)
- func (f *Fake) RegisterProvider(name string, config extension.ProviderConfig)
- func (f *Fake) RegisterShortcut(shortcut extension.KeyID, options extension.ShortcutOptions)
- func (f *Fake) RegisterTool(tool extension.ToolDefinition)
- func (f *Fake) RegisterVirtualModel(model extension.ExtensionVirtualModel)
- func (f *Fake) SendMessage(message extension.SendMessagePayload, options *extension.SendMessageOptions)
- func (f *Fake) SendUserMessage(content any, options *extension.SendUserMessageOptions)
- func (f *Fake) SetActiveTools(toolNames []string)
- func (f *Fake) SetLabel(entryID string, label string)
- func (f *Fake) SetModel(model extension.Model) (bool, error)
- func (f *Fake) SetSessionName(name string)
- func (f *Fake) SetThinkingLevel(level extension.ThinkingLevel)
- func (f *Fake) UnregisterMcpServer(name string)
- func (f *Fake) UnregisterProvider(name string)
- func (f *Fake) UnregisterVirtualModel(provider, id string)
- type MemBus
- type RegisterCommandCall
- type RegisterEntryRendererCall
- type RegisterFlagCall
- type RegisterMcpServerCall
- type RegisterMessageRendererCall
- type RegisterProviderCall
- type RegisterShortcutCall
- type SendMessageCall
- type SendUserMessageCall
- type SetLabelCall
- type UnregisterVirtualModelCall
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppendEntryCall ¶
type ExecCall ¶
type ExecCall struct {
Command string
Args []string
Options *extension.ExecOptions
}
type Fake ¶
type Fake struct {
// ── Event subscriptions ──
OnProjectTrustHandlers []func(ctx context.Context, evt extension.ProjectTrustEvent) (extension.ProjectTrustEventResult, error)
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
OnTurnStartHandlers []func(ctx context.Context, evt extension.TurnStartEvent) error
OnTurnEndHandlers []func(ctx context.Context, evt extension.TurnEndEvent) 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
RegisterProviderCalls []RegisterProviderCall
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
}
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 (*Fake) AppendEntry ¶
func (*Fake) Exec ¶
func (f *Fake) Exec(command string, args []string, options *extension.ExecOptions) (extension.ExecResult, error)
func (*Fake) GetActiveTools ¶
func (*Fake) GetAllTools ¶
func (*Fake) GetCommands ¶
func (f *Fake) GetCommands() []extension.SlashCommandInfo
func (*Fake) GetMcpServers ¶
func (f *Fake) GetMcpServers() []extension.RegisteredMcpServer
func (*Fake) GetSessionName ¶
func (*Fake) GetSettings ¶
func (*Fake) GetThinkingLevel ¶
func (f *Fake) GetThinkingLevel() extension.ThinkingLevel
func (*Fake) OnAfterProviderResponse ¶
func (*Fake) OnAgentBeforeSettle ¶
func (f *Fake) OnAgentBeforeSettle(h func(ctx context.Context, evt *extension.AgentBeforeSettleEvent) (extension.AgentBeforeSettleEventResult, error))
func (*Fake) OnAgentEnd ¶
func (*Fake) OnAgentSettled ¶
func (*Fake) OnAgentStart ¶
func (*Fake) OnBeforeAgentStart ¶
func (f *Fake) OnBeforeAgentStart(h func(ctx context.Context, evt extension.BeforeAgentStartEvent) (extension.BeforeAgentStartEventResult, error))
func (*Fake) OnBeforeProviderHeaders ¶
func (*Fake) OnBeforeProviderRequest ¶
func (f *Fake) OnBeforeProviderRequest(h func(ctx context.Context, evt extension.BeforeProviderRequestEvent) (extension.BeforeProviderRequestEventResult, error))
func (*Fake) OnContext ¶
func (f *Fake) OnContext(h func(ctx context.Context, evt extension.ContextEvent) (extension.ContextEventResult, error))
func (*Fake) OnContextWithSystem ¶
func (f *Fake) OnContextWithSystem(h func(ctx context.Context, evt extension.ContextWithSystemEvent) (extension.ContextEventResult, error))
func (*Fake) OnInput ¶
func (f *Fake) OnInput(h func(ctx context.Context, evt extension.InputEvent) (extension.InputEventResult, error))
func (*Fake) OnMcpServersChange ¶
func (*Fake) OnMessageEnd ¶
func (f *Fake) OnMessageEnd(h func(ctx context.Context, evt extension.MessageEndEvent) (extension.MessageEndEventResult, error))
func (*Fake) OnMessageStart ¶
func (*Fake) OnMessageUpdate ¶
func (*Fake) OnModelSelect ¶
func (*Fake) OnProjectTrust ¶
func (f *Fake) OnProjectTrust(h func(ctx context.Context, evt extension.ProjectTrustEvent) (extension.ProjectTrustEventResult, error))
func (*Fake) OnProviderStreamEvent ¶
func (*Fake) OnResourcesDiscover ¶
func (f *Fake) OnResourcesDiscover(h func(ctx context.Context, evt extension.ResourcesDiscoverEvent) (extension.ResourcesDiscoverResult, error))
func (*Fake) OnSessionBeforeCompact ¶
func (f *Fake) OnSessionBeforeCompact(h func(ctx context.Context, evt extension.SessionBeforeCompactEvent) (extension.SessionBeforeCompactResult, error))
func (*Fake) OnSessionBeforeFork ¶
func (f *Fake) OnSessionBeforeFork(h func(ctx context.Context, evt extension.SessionBeforeForkEvent) (extension.SessionBeforeForkResult, error))
func (*Fake) OnSessionBeforeSwitch ¶
func (f *Fake) OnSessionBeforeSwitch(h func(ctx context.Context, evt extension.SessionBeforeSwitchEvent) (extension.SessionBeforeSwitchResult, error))
func (*Fake) OnSessionBeforeTree ¶
func (f *Fake) OnSessionBeforeTree(h func(ctx context.Context, evt extension.SessionBeforeTreeEvent) (extension.SessionBeforeTreeResult, error))
func (*Fake) OnSessionCompact ¶
func (*Fake) OnSessionCompactFailed ¶
func (*Fake) OnSessionInfoChanged ¶
func (*Fake) OnSessionShutdown ¶
func (*Fake) OnSessionStart ¶
func (*Fake) OnSessionTree ¶
func (*Fake) OnThinkingLevelSelect ¶
func (*Fake) OnToolCall ¶
func (f *Fake) OnToolCall(h func(ctx context.Context, evt extension.ToolCallEvent) (extension.ToolCallEventResult, error))
func (*Fake) OnToolExecutionEnd ¶
func (*Fake) OnToolExecutionStart ¶
func (*Fake) OnToolExecutionUpdate ¶
func (*Fake) OnToolResult ¶
func (f *Fake) OnToolResult(h func(ctx context.Context, evt extension.ToolResultEvent) (extension.ToolResultEventResult, error))
func (*Fake) OnTurnStart ¶
func (*Fake) OnUiPromptEnd ¶
func (*Fake) OnUiPromptStart ¶
func (*Fake) OnUserBash ¶
func (f *Fake) OnUserBash(h func(ctx context.Context, evt extension.UserBashEvent) (extension.UserBashEventResult, error))
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) 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) 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 (*Fake) SetSessionName ¶
func (*Fake) SetThinkingLevel ¶
func (f *Fake) SetThinkingLevel(level extension.ThinkingLevel)
func (*Fake) UnregisterMcpServer ¶
func (*Fake) UnregisterProvider ¶
func (*Fake) UnregisterVirtualModel ¶
type MemBus ¶
type MemBus struct {
// contains filtered or unexported fields
}
MemBus is an in-memory implementation of extension.EventBus suitable for unit tests. Goroutine-safe: handlers may emit from any goroutine.
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 UnregisterVirtualModelCall ¶
UnregisterVirtualModelCall records one UnregisterVirtualModel call.