requirements

Documentation

Index

• Variables
• func CheckRequirement(key, value string, getter ValueGetter) (bool, error)
• func HasDisruption(key string) (bool, string)
• func RegisterCheck(key string, f CheckFunc)
• func RegisterDisruption(key string, f DisruptionFunc)
• type CheckFunc
• type DisruptionFunc
• type ValueGetter

Variables

var (
	ErrNotRegistered = errors.New("Not registered")
)

Functions

func CheckRequirement

func CheckRequirement(key, value string, getter ValueGetter) (bool, error)

CheckRequirement run check function for `key` requirement. Returns true if check is passed, false otherwise

func HasDisruption

func HasDisruption(key string) (bool, string)

HasDisruption run check function for `key` disruption. Returns true if disruption condition is met, false otherwise. Returns reason for true response.

func RegisterCheck

func RegisterCheck(key string, f CheckFunc)

RegisterCheck add CheckFunc for some component

func RegisterDisruption

func RegisterDisruption(key string, f DisruptionFunc)

RegisterDisruption add DisruptionFunc for some component

Types

type CheckFunc

type CheckFunc func(requirementValue string, getter ValueGetter) (bool, error)

CheckFunc check come precondition, comparing desired value (requirementValue) with current value (getter)

type DisruptionFunc

type DisruptionFunc func() (bool, string)

DisruptionFunc implements inner logic to warn users about potentially dangerous changes

type ValueGetter

type ValueGetter interface {
	Get(path string) gjson.Result
}