features

Documentation

Index

• type Feature
  • func New(name string, opts ...Option) *Feature
  • func (f *Feature) Test(ctx context.Context) error
  • func (f *Feature) WithAfter(name string, fn StepFn, opts ...StepOpt)
  • func (f *Feature) WithAssessment(name string, fn StepFn, opts ...StepOpt)
  • func (f *Feature) WithBefore(name string, fn StepFn, opts ...StepOpt)
• type Level
• type Option
  • func WithDescription(desc string) Option
• type StepFn
• type StepOpt
  • func StepWithRetry(backoff wait.Backoff) StepOpt

Types

type Feature

type Feature struct {
	Name        string
	Description string
	Labels      map[string]string
	// contains filtered or unexported fields
}

func New

func New(name string, opts ...Option) *Feature

func (*Feature) Test

func (f *Feature) Test(ctx context.Context) error

Test executes the steps in the feature. The "before" steps are executed first, followed by the "assessments", followed by the "afters". On failures, the steps are short-circuited to the "afters". The "afters" are _always_ run.

func (*Feature) WithAfter

func (f *Feature) WithAfter(name string, fn StepFn, opts ...StepOpt)

func (*Feature) WithAssessment

func (f *Feature) WithAssessment(name string, fn StepFn, opts ...StepOpt)

func (*Feature) WithBefore

func (f *Feature) WithBefore(name string, fn StepFn, opts ...StepOpt)

type Level

type Level uint8

const (
	Before Level = iota
	Assessment
	After
)

type Option

type Option func(*Feature)

func WithDescription

func WithDescription(desc string) Option

type StepFn

type StepFn func(context.Context) error

type StepOpt

type StepOpt func(s *step)

func StepWithRetry

func StepWithRetry(backoff wait.Backoff) StepOpt

StepWithRetry wraps the step in an exponential backoff retry loop.