tests

Documentation

Index

• Variables
• type Case
• type CaseResult
• type Predicate
  • func (p Predicate) Validate() error
• type SuiteResult
  • func Run(agg metrics.Aggregate, cases []Case) SuiteResult

Variables

var ErrUnknownPredicate = errors.New("tests: unknown predicate")

Types

type Case

type Case struct {
	Name      string
	Field     metrics.Field
	Predicate Predicate
	Target    metrics.Value
}

type CaseResult

type CaseResult struct {
	Input   Case
	Pass    bool
	Got     metrics.Value
	Summary string
}

type Predicate

type Predicate string

Predicate represents a comparison operator.

const (
	EQ  Predicate = "EQ"
	NEQ Predicate = "NEQ"
	GT  Predicate = "GT"
	GTE Predicate = "GTE"
	LT  Predicate = "LT"
	LTE Predicate = "LTE"
)

func (Predicate) Validate

func (p Predicate) Validate() error

Validate returns ErrUnknownPredicate if p is not a know Predicate, else nil.

type SuiteResult

type SuiteResult struct {
	Pass    bool
	Results []CaseResult
}

func Run

func Run(agg metrics.Aggregate, cases []Case) SuiteResult