check

Documentation

Index

• func RoundDuration(d time.Duration, digits int) time.Duration
• type Check
  • func (c *Check) Error() string
  • func (c *Check) ExecutionTime() time.Duration
  • func (c *Check) Passed() bool
  • func (c *Check) Process()
  • func (c *Check) RawResult() string
  • func (c *Check) Result() string
• type CheckFunction
• type CheckSuite
  • func NewCheckSuite(name string) *CheckSuite
  • func (h *CheckSuite) AddCheck(name string, checkFunc CheckFunction) *Check
  • func (h *CheckSuite) Passed() bool
  • func (h *CheckSuite) Print()
  • func (h *CheckSuite) Process(parentCtx context.Context)
  • func (h *CheckSuite) RawResult() string
  • func (h *CheckSuite) Result() string
• type OnCompletionHook

Functions

func RoundDuration

func RoundDuration(d time.Duration, digits int) time.Duration

Types

type Check

type Check struct {
	Name      string
	CheckFunc CheckFunction
	// contains filtered or unexported fields
}

func (*Check) Error

func (c *Check) Error() string

func (*Check) ExecutionTime

func (c *Check) ExecutionTime() time.Duration

func (*Check) Passed

func (c *Check) Passed() bool

func (*Check) Process

func (c *Check) Process()

func (*Check) RawResult

func (c *Check) RawResult() string

func (*Check) Result

func (c *Check) Result() string

type CheckFunction

type CheckFunction func() (string, error)

type CheckSuite

type CheckSuite struct {
	Name         string
	Checks       []*Check
	OnCompletion OnCompletionHook
	ErrOnSetup   error
	// contains filtered or unexported fields
}

func NewCheckSuite

func NewCheckSuite(name string) *CheckSuite

func (*CheckSuite) AddCheck

func (h *CheckSuite) AddCheck(name string, checkFunc CheckFunction) *Check

func (*CheckSuite) Passed

func (h *CheckSuite) Passed() bool

func (*CheckSuite) Print

func (h *CheckSuite) Print()

Print will send output straight to stdout.

func (*CheckSuite) Process

func (h *CheckSuite) Process(parentCtx context.Context)

func (*CheckSuite) RawResult

func (h *CheckSuite) RawResult() string

func (*CheckSuite) Result

func (h *CheckSuite) Result() string

type OnCompletionHook

type OnCompletionHook func()