foxytest

README

foxytest

foxytest is a Golang package that provides a simple way to test your MCP Servers.

Read more about it in the documentation.

Documentation

Index

• type StdRunner
  • func NewTestRunner(t *testing.T) *StdRunner
  • func (tc *StdRunner) Errorf(format string, args ...interface{})
  • func (tc *StdRunner) Fatal(args ...interface{})
  • func (tc *StdRunner) Fatalf(format string, args ...interface{})
  • func (tc *StdRunner) Log(args ...interface{})
  • func (tc *StdRunner) Logf(format string, args ...interface{})
  • func (tc *StdRunner) Run(name string, f func(t TestRunner)) bool
• type Test
• type TestCase
• type TestRunner
• type TestSuite
  • func Read(path string) (TestSuite, error)
• type TestSystem

Types

type StdRunner

type StdRunner struct {
	// contains filtered or unexported fields
}

func NewTestRunner

func NewTestRunner(t *testing.T) *StdRunner

func (*StdRunner) Errorf

func (tc *StdRunner) Errorf(format string, args ...interface{})

func (*StdRunner) Fatal

func (tc *StdRunner) Fatal(args ...interface{})

func (*StdRunner) Fatalf

func (tc *StdRunner) Fatalf(format string, args ...interface{})

func (*StdRunner) Log

func (tc *StdRunner) Log(args ...interface{})

func (*StdRunner) Logf

func (tc *StdRunner) Logf(format string, args ...interface{})

func (*StdRunner) Run

func (tc *StdRunner) Run(name string, f func(t TestRunner)) bool

type Test

type Test interface {
	Run(t TestRunner)
	SetLogging(bool)
	GetTestCases() []TestCase
}

type TestCase

type TestCase interface {
	GetName() string
	GetInputs() []map[string]interface{}
	GetOutputs() []map[string]interface{}
}

type TestRunner

type TestRunner interface {
	TestSystem
	Run(name string, f func(t TestRunner)) bool
}

TestRunner is an interface that is compatible with the testing.T interface , so that the test suite can be run with the standard go test runner or with any other runner that implements this interface, particularly it is used by `mst` command line runner allowing to use this test suite runner from languages other than Go

type TestSuite

type TestSuite interface {
	WithBeforeAll(func() error) TestSuite
	WithAfterAll(func() error) TestSuite
	WithBeforeEach(func() error) TestSuite
	WithAfterEach(func() error) TestSuite
	WithLogging() TestSuite

	WithExecutable(command string, args []string) TestSuite

	Run(t TestRunner)
	Errors() []error
	AssertNoErrors(t TestRunner)
	GetTests() []Test
}

TestSuite represents a collection of tests that can be run together

func Read

func Read(path string) (TestSuite, error)

Read would read a collection of tests from a folder specified by path

type TestSystem

type TestSystem interface {
	Fatal(args ...interface{})
	Fatalf(format string, args ...interface{})
	Errorf(format string, args ...interface{})
	Log(args ...interface{})
	Logf(format string, args ...interface{})
}