resetter

Documentation

Index

• type Error
  • func NewError(bt [][]byte) *Error
  • func (re *Error) Error() string
  • func (re *Error) Reason() []string
• type Interface
• type Maker

Types

type Error

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

Error describes a resetter error

func NewError

func NewError(bt [][]byte) *Error

NewError returns a new empty resetter.Error

func (*Error) Error

func (re *Error) Error() string

Error returns the error string

func (*Error) Reason

func (re *Error) Reason() []string

Reason describes the error on multiple lines

type Interface

type Interface interface {
	// Name uniquely identifies this instance
	Name() string

	// Provides lists the models a resetter resets
	Provides() []string

	// ToProto marshals a resetter.Interface implementation into a *fm.Clt_Fuzz_Resetter
	ToProto() *fm.Clt_Fuzz_Resetter

	// ExecStart executes the setup phase of the System Under Test
	ExecStart(context.Context, progresser.Shower, bool, map[string]string) error
	// ExecReset resets the System Under Test to a state similar to a post-ExecStart state
	ExecReset(context.Context, progresser.Shower, bool, map[string]string) error
	// ExecStop executes the cleanup phase of the System Under Test
	ExecStop(context.Context, progresser.Shower, bool, map[string]string) error

	// Terminate cleans up after a resetter.Interface implementation instance
	Terminate(context.Context, progresser.Shower, map[string]string) error
}

Interface describes ways to reset the system under test to a known initial state A package defining a type that implements Interface also has to define: * a non-empty const Name that names the Starlark builtin * a func of type Maker named New that instanciates a new resetter

type Maker

type Maker func(kwargs []starlark.Tuple) (Interface, error)

Maker types the New func that instanciates new resetters