testutils

package

v1.4.0 Latest Latest Go to latest Published: Jun 4, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/googleapis/mcp-toolbox

Links

Documentation ¶

Index ¶

func ContextWithNewLogger() (context.Context, error)
func ContextWithUserAgent(ctx context.Context, userAgent string) context.Context
func FormatYaml(in string) []byte
func WaitForString(ctx context.Context, re *regexp.Regexp, pr io.ReadCloser) (string, error)
type MockPrompt
- func NewMockPrompt(name, desc string, args prompts.Arguments) MockPrompt
type MockTool
- func NewMockTool(name, desc string, params []parameters.Parameter, ...) MockTool

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ContextWithNewLogger ¶

func ContextWithNewLogger() (context.Context, error)

ContextWithNewLogger create a new context with new logger

func ContextWithUserAgent ¶

func ContextWithUserAgent(ctx context.Context, userAgent string) context.Context

ContextWithUserAgent creates a new context with a specified user agent string.

func FormatYaml ¶

func FormatYaml(in string) []byte

formatYaml is a utility function for stripping out tabs in multiline strings

func WaitForString ¶

func WaitForString(ctx context.Context, re *regexp.Regexp, pr io.ReadCloser) (string, error)

WaitForString waits until the server logs a single line that matches the provided regex. returns the output of whatever the server sent so far.

Types ¶

type MockPrompt ¶ added in v1.2.0

type MockPrompt struct {
	Name        string
	Description string
	Args        prompts.Arguments
	// contains filtered or unexported fields
}

MockPrompt is used to mock prompts in tests

func NewMockPrompt ¶ added in v1.2.0

func NewMockPrompt(name, desc string, args prompts.Arguments) MockPrompt

NewMockPrompt creates a new mock prompt for testing.

func (MockPrompt) GetArguments ¶ added in v1.3.0

func (p MockPrompt) GetArguments() prompts.Arguments

func (MockPrompt) GetDesc ¶ added in v1.3.0

func (p MockPrompt) GetDesc() string

func (MockPrompt) Manifest ¶ added in v1.2.0

func (p MockPrompt) Manifest() prompts.Manifest

func (MockPrompt) ParseArgs ¶ added in v1.2.0

func (p MockPrompt) ParseArgs(data map[string]any, claimsMap map[string]map[string]any) (parameters.ParamValues, error)

func (MockPrompt) SubstituteParams ¶ added in v1.2.0

func (p MockPrompt) SubstituteParams(vals parameters.ParamValues) (any, error)

func (MockPrompt) ToConfig ¶ added in v1.2.0

func (p MockPrompt) ToConfig() prompts.PromptConfig

type MockTool ¶ added in v1.2.0

type MockTool struct {
	Name        string
	Description string
	Params      []parameters.Parameter
	// contains filtered or unexported fields
}

MockTool is used to mock tools in tests

func NewMockTool ¶ added in v1.2.0

func NewMockTool(name, desc string, params []parameters.Parameter, unauthorized, requireClientAuthorization bool) MockTool

NewMockTool creates a new mock prompt for testing.

func (MockTool) Authorized ¶ added in v1.2.0

func (t MockTool) Authorized(verifiedAuthServices []string) bool

func (MockTool) EmbedParams ¶ added in v1.2.0

func (t MockTool) EmbedParams(ctx context.Context, paramValues parameters.ParamValues, embeddingModelsMap map[string]embeddingmodels.EmbeddingModel) (parameters.ParamValues, error)

func (MockTool) GetAnnotations ¶ added in v1.3.0

func (t MockTool) GetAnnotations() *tools.ToolAnnotations

func (MockTool) GetAuthRequired ¶ added in v1.3.0

func (t MockTool) GetAuthRequired() []string

func (MockTool) GetAuthTokenHeaderName ¶ added in v1.2.0

func (t MockTool) GetAuthTokenHeaderName(tools.SourceProvider) (string, error)

func (MockTool) GetDescription ¶ added in v1.3.0

func (t MockTool) GetDescription() string

func (MockTool) GetName ¶ added in v1.3.0

func (t MockTool) GetName() string

func (MockTool) GetParameters ¶ added in v1.2.0

func (t MockTool) GetParameters() parameters.Parameters

func (MockTool) GetScopesRequired ¶ added in v1.3.0

func (t MockTool) GetScopesRequired() []string

func (MockTool) Invoke ¶ added in v1.2.0

func (t MockTool) Invoke(context.Context, tools.SourceProvider, parameters.ParamValues, tools.AccessToken) (any, util.ToolboxError)

func (MockTool) Manifest ¶ added in v1.2.0

func (t MockTool) Manifest() tools.Manifest

func (MockTool) ParseParams ¶ added in v1.2.0

func (t MockTool) ParseParams(data map[string]any, claimsMap map[string]map[string]any) (parameters.ParamValues, error)

claims is a map of user info decoded from an auth token

func (MockTool) RequiresClientAuthorization ¶ added in v1.2.0

func (t MockTool) RequiresClientAuthorization(tools.SourceProvider) (bool, error)

func (MockTool) ToConfig ¶ added in v1.2.0

func (t MockTool) ToConfig() tools.ToolConfig

Source Files ¶

View all Source files

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