assertions

package

v0.2.4 Latest Latest Go to latest Published: Mar 12, 2018 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/jonog/redalert

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Register(name string, constructorFn func(Config, *log.Logger) (Asserter, error))
type Asserter
- func New(config Config, logger *log.Logger) (Asserter, error)
type Config
type JSON
- func (m *JSON) Assert(options Options) (Outcome, error)
- func (m *JSON) ValidateConfig() error
type Metadata
- func (m *Metadata) Assert(options Options) (Outcome, error)
- func (m *Metadata) ValidateConfig() error
type Metric
- func (m *Metric) Assert(options Options) (Outcome, error)
- func (m *Metric) ValidateConfig() error
type Options
type Outcome
type Text
- func (m *Text) Assert(options Options) (Outcome, error)
- func (m *Text) ValidateConfig() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	InvalidJSONIdentifierError = errors.New("json: invalid identifier")
	UnknownJSONComparisonErr   = errors.New("json: unknown comparison")
)

View Source

var InvalidTargetTypeErr = errors.New("metric asserter: target is invalid numeric type")

View Source

var MissingMetadataErr = errors.New("metadata asserter: missing metadata")

View Source

var MissingMetricErr = errors.New("metric asserter: missing metric")

View Source

var NewJSON = func(config Config, logger *log.Logger) (Asserter, error) {
	return Asserter(&JSON{config, logger}), nil
}

View Source

var NewMetadata = func(config Config, logger *log.Logger) (Asserter, error) {
	return Asserter(&Metadata{config, logger}), nil
}

View Source

var NewMetric = func(config Config, logger *log.Logger) (Asserter, error) {
	return Asserter(&Metric{config, logger}), nil
}

View Source

var NewText = func(config Config, logger *log.Logger) (Asserter, error) {
	return Asserter(&Text{config, logger}), nil
}

View Source

var UnknownMetadataComparisonErr = errors.New("metadata asserter: unknown comparison")

View Source

var UnknownMetricComparisonErr = errors.New("metric asserter: unknown comparison")

View Source

var UnknownTextComparisonErr = errors.New("text asserter: unknown comparison")

Functions ¶

func Register ¶

func Register(name string, constructorFn func(Config, *log.Logger) (Asserter, error))

Types ¶

type Asserter ¶

type Asserter interface {
	Assert(Options) (Outcome, error)
	ValidateConfig() error
}

func New ¶

func New(config Config, logger *log.Logger) (Asserter, error)

type Config ¶

type Config struct {

	// Source can be one of metric | metadata | json | text
	Source string `json:"source"`

	// Relevant name. e.g. metric name
	Identifier string `json:"identifier"`

	// Comparison type e.g. == | >=
	Comparison string `json:"comparison"`

	// Target value to compare against
	Target string `json:"target"`
}

type JSON ¶

type JSON struct {
	Config
	// contains filtered or unexported fields
}

func (*JSON) Assert ¶

func (m *JSON) Assert(options Options) (Outcome, error)

func (*JSON) ValidateConfig ¶

func (m *JSON) ValidateConfig() error

type Metadata ¶

type Metadata struct {
	Config
	// contains filtered or unexported fields
}

func (*Metadata) Assert ¶

func (m *Metadata) Assert(options Options) (Outcome, error)

func (*Metadata) ValidateConfig ¶

func (m *Metadata) ValidateConfig() error

type Metric ¶

type Metric struct {
	Config
	// contains filtered or unexported fields
}

func (*Metric) Assert ¶

func (m *Metric) Assert(options Options) (Outcome, error)

func (*Metric) ValidateConfig ¶

func (m *Metric) ValidateConfig() error

type Options ¶

type Options struct {
	CheckResponse data.CheckResponse
}

type Outcome ¶

type Outcome struct {
	Assertion bool
	Message   string
}

type Text ¶

type Text struct {
	Config
	// contains filtered or unexported fields
}

func (*Text) Assert ¶

func (m *Text) Assert(options Options) (Outcome, error)

func (*Text) ValidateConfig ¶

func (m *Text) ValidateConfig() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL