Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.9.8

Sep 11, 2025

v1.9.7

Jul 8, 2024

v1.9.6

Jul 8, 2024

v1.9.5

Jul 8, 2024

Changes in this version

+ var ErrTimeoutConflict = fmt.Errorf("%w: timeout conflict", RuntimeError)

+ func TimeoutConflict(ti *Timings) error

+ type Runnable interface

+ Run func(context.Context, *testing.T) error

+ type SetOn int

+ const SetOnDefault

+ const SetOnNone

+ const SetOnPlugin

+ const SetOnPluginDefault

+ const SetOnSpec

type Spec

+ Plugin Plugin

+ type Timings struct

+ GoTestTimeout time.Duration

+ MaxTimeout time.Duration

+ MaxTimeoutSetOn SetOn

+ MaxTimeoutSpecIndex int

+ TotalWait time.Duration

+ func (t *Timings) AddTimeout(d time.Duration, on SetOn, specIndex int)

+ func (t *Timings) AddWait(d time.Duration)

v1.9.4

Jun 26, 2024

v1.9.3

Jun 26, 2024

v1.9.2

Jun 26, 2024

v1.9.1

Jun 26, 2024

v1.9.0

Jun 25, 2024

Changes in this version

+ const DefaultRetryAttempts

+ const DefaultRetryConstantInterval

+ var BaseSpecFields = []string

+ var ErrExpectedInt = fmt.Errorf("%w: expected int value", ErrParse)

+ var ErrExpectedMap = fmt.Errorf("%w: expected map field", ErrParse)

+ var ErrExpectedRetry = fmt.Errorf("%w: expected retry specification", ErrParse)

+ var ErrExpectedScalar = fmt.Errorf("%w: expected scalar field", ErrParse)

+ var ErrExpectedScalarOrMap = fmt.Errorf("%w: expected scalar or map field", ErrParse)

+ var ErrExpectedScalarOrSequence = fmt.Errorf("%w: expected scalar or sequence of scalars field", ErrParse)

+ var ErrExpectedSequence = fmt.Errorf("%w: expected sequence field", ErrParse)

+ var ErrExpectedTimeout = fmt.Errorf("%w: expected timeout specification", ErrParse)

+ var ErrExpectedWait = fmt.Errorf("%w: expected wait specification", ErrParse)

+ var ErrFailure = errors.New("assertion failed")

+ var ErrFileNotFound = fmt.Errorf("%w: file not found", ErrParse)

+ var ErrIn = fmt.Errorf("%w: in", ErrFailure)

+ var ErrInvalidRetryAttempts = fmt.Errorf("%w: invalid retry attempts", ErrParse)

+ var ErrNoneIn = fmt.Errorf("%w: none in", ErrFailure)

+ var ErrNotEqual = fmt.Errorf("%w: not equal", ErrFailure)

+ var ErrNotIn = fmt.Errorf("%w: not in", ErrFailure)

+ var ErrParse = errors.New("invalid YAML")

+ var ErrRequiredFixture = fmt.Errorf("%w: required fixture missing", RuntimeError)

+ var ErrTimeoutExceeded = fmt.Errorf("%s: timeout exceeded", ErrFailure)

+ var ErrUnexpectedError = fmt.Errorf("%w: unexpected error", ErrFailure)

+ var ErrUnknownField = errors.New("unknown field")

+ var ErrUnknownSourceType = errors.New("unknown source argument type")

+ var ErrUnknownSpec = errors.New("no plugin could parse spec definition")

+ var NoRetry = &Retry

+ var RuntimeError = errors.New("runtime error")

+ func ExpectedIntAt(node *yaml.Node) error

+ func ExpectedMapAt(node *yaml.Node) error

+ func ExpectedRetryAt(node *yaml.Node) error

+ func ExpectedScalarAt(node *yaml.Node) error

+ func ExpectedScalarOrMapAt(node *yaml.Node) error

+ func ExpectedScalarOrSequenceAt(node *yaml.Node) error

+ func ExpectedSequenceAt(node *yaml.Node) error

+ func ExpectedTimeoutAt(node *yaml.Node) error

+ func ExpectedWaitAt(node *yaml.Node) error

+ func FileNotFound(path string, node *yaml.Node) error

+ func In(element, container interface{}) error

+ func InvalidRetryAttempts(node *yaml.Node, attempts int) error

+ func NoneIn(elements, container interface{}) error

+ func NotEqual(exp, got interface{}) error

+ func NotEqualLength(exp, got int) error

+ func NotIn(element, container interface{}) error

+ func RequiredFixtureMissing(name string) error

+ func TimeoutExceeded(duration string, failure error) error

+ func UnexpectedError(err error) error

+ func UnknownFieldAt(field string, node *yaml.Node) error

+ func UnknownSourceType(source interface{}) error

+ func UnknownSpecAt(path string, node *yaml.Node) error

+ type Assertions interface

+ Fail func(error)

+ Failures func() []error

+ OK func(context.Context) bool

+ type Defaults map[string]interface

+ func (d *Defaults) For(key string) interface{}

+ type Evaluable interface

+ Base func() *Spec

+ Eval func(context.Context) (*Result, error)

+ Retry func() *Retry

+ SetBase func(Spec)

+ Timeout func() *Timeout

+ type Fixture interface

+ HasState func(string) bool

+ Start func(context.Context) error

+ State func(string) interface{}

+ Stop func(context.Context)

+ type FlexStrings struct

+ func (f *FlexStrings) UnmarshalYAML(node *yaml.Node) error

+ func (f *FlexStrings) Values() []string

+ type Plugin interface

+ Defaults func() yaml.Unmarshaler

+ Info func() PluginInfo

+ Specs func() []Evaluable

+ type PluginInfo struct

+ Aliases []string

+ Description string

+ Name string

+ Retry *Retry

+ Timeout *Timeout

+ type Result struct

+ func NewResult(mods ...ResultModifier) *Result

+ func (r *Result) Data() map[string]interface{}

+ func (r *Result) Failed() bool

+ func (r *Result) Failures() []error

+ func (r *Result) HasData() bool

+ func (r *Result) SetData(key string, val interface{})

+ func (r *Result) SetFailures(failures ...error)

+ type ResultModifier func(*Result)

+ func WithData(key string, val interface{}) ResultModifier

+ func WithFailures(failures ...error) ResultModifier

+ type Retry struct

+ Attempts *int

+ Exponential bool

+ Interval string

+ func (r *Retry) IntervalDuration() time.Duration

+ type Spec struct

+ Defaults *Defaults

+ Description string

+ Index int

+ Name string

+ Retry *Retry

+ Timeout *Timeout

+ Wait *Wait

+ func (s *Spec) Title() string

+ func (s *Spec) UnmarshalYAML(node *yaml.Node) error

+ type Timeout struct

+ After string

+ func (t *Timeout) Duration() time.Duration

+ type Wait struct

+ After string

+ Before string

+ func (w *Wait) AfterDuration() time.Duration

+ func (w *Wait) BeforeDuration() time.Duration