requirements

Documentation

Index

• Variables
• func CheckRequirement(key, value string, enabledModules ...set.Set) (bool, error)
• func DumpValues() map[string]interface{}
• func GetValue(key string) (interface{}, bool)
• func HasDisruption(key string) (bool, string)
• func RegisterCheck(key string, f CheckFunc)
• func RegisterDisruption(key string, f DisruptionFunc)
• func RemoveValue(key string)
• func SaveValue(key string, value interface{})
• type CheckFunc
• type DisruptionFunc
• type MemoryValuesStore
  • func (m *MemoryValuesStore) Get(key string) (interface{}, bool)
  • func (m *MemoryValuesStore) GetAll() map[string]interface{}
  • func (m *MemoryValuesStore) Remove(key string)
  • func (m *MemoryValuesStore) Set(key string, value interface{})
• type ValueGetter

Variables

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

Functions

func CheckRequirement

func CheckRequirement(key, value string, enabledModules ...set.Set) (bool, error)

CheckRequirement run check functions for `key` requirement. Returns true if all checks is passed, false otherwise enabledModules is optional and will filter check-functions if module is disabled

func DumpValues

func DumpValues() map[string]interface{}

DumpValues return all stored requirement values

func GetValue

func GetValue(key string) (interface{}, bool)

GetValue returns saved value. !Attention: Please don't use it in hooks, only for tests

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

func RemoveValue

func RemoveValue(key string)

RemoveValue remove previously stored value

func SaveValue

func SaveValue(key string, value interface{})

SaveValue could be used in the modules, to store their internal values for updater One module does not have access to the other's module values, so we can do it through this interface

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(getter ValueGetter) (bool, string)

DisruptionFunc implements inner logic to warn users about potentially dangerous changes

type MemoryValuesStore

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

func (*MemoryValuesStore) Get

func (m *MemoryValuesStore) Get(key string) (interface{}, bool)

func (*MemoryValuesStore) GetAll

func (m *MemoryValuesStore) GetAll() map[string]interface{}

func (*MemoryValuesStore) Remove

func (m *MemoryValuesStore) Remove(key string)

func (*MemoryValuesStore) Set

func (m *MemoryValuesStore) Set(key string, value interface{})

type ValueGetter

type ValueGetter interface {
	Get(path string) (interface{}, bool)
}