validators

Documentation

Overview

Package validators provides an entrypoint for the cloudprober's validators framework.

Index

• func RunValidators(vs []*ValidatorWithName, resp interface{}, respBody []byte, ...) []string
• func ValidationFailureMap(vs []*ValidatorWithName) *metrics.Map
• type Validator
• type ValidatorWithName
  • func Init(validatorConfs []*configpb.Validator, l *logger.Logger) ([]*ValidatorWithName, error)
  • func (vwn *ValidatorWithName) Validate(responseObject interface{}, responseBody []byte) (bool, error)

Functions

func RunValidators

func RunValidators(vs []*ValidatorWithName, resp interface{}, respBody []byte, validationFailure *metrics.Map, l *logger.Logger) []string

RunValidators runs the list of validators on the given response and responseBody, updates the given validationFailure map and returns the list of failures.

func ValidationFailureMap

func ValidationFailureMap(vs []*ValidatorWithName) *metrics.Map

ValidationFailureMap returns an initialized validation failures map.

Types

type Validator

type Validator interface {
	Init(config interface{}, l *logger.Logger) error
	Validate(responseObject interface{}, responseBody []byte) (bool, error)
}

Validator interface represents a validator.

A validator runs a test on the provided input, usually the probe response, and returns the test result. If test cannot be run successfully for some reason (e.g. for malformed input), an error is returned.

type ValidatorWithName

type ValidatorWithName struct {
	Name      string
	Validator Validator
}

ValidatorWithName encapsulate a Validator and its name.

func Init

func Init(validatorConfs []*configpb.Validator, l *logger.Logger) ([]*ValidatorWithName, error)

Init initializes the validators defined in the config.

func (*ValidatorWithName) Validate

func (vwn *ValidatorWithName) Validate(responseObject interface{}, responseBody []byte) (bool, error)

Validate is simply a wrapper around the encapsulated Validator's Validate method.