checks

package

v0.2.0 Latest Latest Go to latest Published: Jul 21, 2016 License: MIT Imports: 4 Imported by: 0

Details

This section is empty.

View Source

var ErrInterrupted = errors.New("interrupted")

This section is empty.

type CheckResult string

const (
	CheckResultPending CheckResult = "Pending"
	CheckResultPassing CheckResult = "Passing"
	CheckResultFailing CheckResult = "Failing"
)

type CheckSummary struct {
	Description string
	Result      CheckResult
	Details     string
	Timestamp   time.Time
}

type Checker interface {
	Description() string
	Check(interruptCh <-chan struct{}) (*CheckSummary, error)
	Period() time.Duration
}

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

func NewRunner(opts ...RunnerOption) *Runner

func (runner *Runner) AddSection(section *Section)

func (runner *Runner) Interrupt()

func (runner *Runner) Results() []*SectionSummary

func (runner *Runner) Start()

func (runner *Runner) Wait() error

type RunnerOption func(*Runner)

func SetStatusChannel(statusCh chan<- CheckSummary) RunnerOption

type Section struct {
	Heading  string
	Checkers []Checker
}

type SectionSummary struct {
	Heading string
	Checks  []*CheckSummary
}