step

Documentation

Index

• type Function
• type Groups
  • func NewGroups() *Groups
  • func (g *Groups) Get(name string) *Steps
  • func (g *Groups) Names() []string
• type Result
  • func NewResult(status Status, message string) *Result
  • func NewResultError(message string) *Result
  • func NewResultSuccess(message string) *Result
  • func NewResultWarning(message string) *Result
• type Status
  • func (s Status) Validate() error
• type Step
  • func NewStep(name string, fn Function, masked []string) *Step
  • func (step *Step) Call() (res *Result)
• type Steps
  • func NewSteps() *Steps
  • func (s *Steps) Add(name string, test Function, masked []string) *Steps
  • func (s *Steps) Get(name string) *Step
  • func (s *Steps) Names() []string

Types

type Function

type Function func() (*Result, error)

type Groups

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

func NewGroups

func NewGroups() *Groups

func (*Groups) Get

func (g *Groups) Get(name string) *Steps

func (*Groups) Names

func (g *Groups) Names() []string

type Result

type Result struct {
	Status  Status
	Message string
}

func NewResult

func NewResult(status Status, message string) *Result

func NewResultError

func NewResultError(message string) *Result

func NewResultSuccess

func NewResultSuccess(message string) *Result

func NewResultWarning

func NewResultWarning(message string) *Result

type Status

type Status string

const (
	Error   Status = "error"
	Warning Status = "warning"
	Success Status = "success"
)

func (Status) Validate

func (s Status) Validate() error

type Step

type Step struct {
	Name     string
	Func     Function
	Replacer *strings.Replacer
}

func NewStep

func NewStep(name string, fn Function, masked []string) *Step

func (*Step) Call

func (step *Step) Call() (res *Result)

type Steps

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

func NewSteps

func NewSteps() *Steps

func (*Steps) Add

func (s *Steps) Add(name string, test Function, masked []string) *Steps

func (*Steps) Get

func (s *Steps) Get(name string) *Step

func (*Steps) Names

func (s *Steps) Names() []string