anchor

Documentation

Index

• Variables
• func AddAnchor(key, anchorPrefix string) string
• func ContainsCondition(str string) bool
• func GetAnchorsResourcesFromMap(patternMap map[string]interface{}) (map[string]interface{}, map[string]interface{})
• func IsAddIfNotPresentAnchor(key string) bool
• func IsConditionAnchor(str string) bool
• func IsConditionalAnchorError(msg string) bool
• func IsEqualityAnchor(str string) bool
• func IsExistenceAnchor(str string) bool
• func IsGlobalAnchor(str string) bool
• func IsGlobalAnchorError(msg string) bool
• func IsNegationAnchor(str string) bool
• func IsNegationAnchorError(msg string) bool
• func IsNonAnchor(str string) bool
• func RemoveAnchor(key string) (string, string)
• func RemoveAnchorsFromPath(str string) string
• type AnchorError
• type AnchorKey
  • func NewAnchorMap() *AnchorKey
  • func (ac *AnchorKey) CheckAnchorInResource(pattern interface{}, resource interface{})
  • func (ac *AnchorKey) IsAnchorError() bool
• type ConditionAnchorHandler
  • func (ch ConditionAnchorHandler) Handle(handler resourceElementHandler, resourceMap map[string]interface{}, ...) (string, error)
• type DefaultHandler
  • func (dh DefaultHandler) Handle(handler resourceElementHandler, resourceMap map[string]interface{}, ...) (string, error)
• type EqualityHandler
  • func (eh EqualityHandler) Handle(handler resourceElementHandler, resourceMap map[string]interface{}, ...) (string, error)
• type ExistenceHandler
  • func (eh ExistenceHandler) Handle(handler resourceElementHandler, resourceMap map[string]interface{}, ...) (string, error)
• type GlobalAnchorHandler
  • func (gh GlobalAnchorHandler) Handle(handler resourceElementHandler, resourceMap map[string]interface{}, ...) (string, error)
• type IsAnchor
• type NegationHandler
  • func (nh NegationHandler) Handle(handler resourceElementHandler, resourceMap map[string]interface{}, ...) (string, error)
• type ValidateAnchorError
  • func NewConditionalAnchorError(msg string) ValidateAnchorError
  • func NewGlobalAnchorError(msg string) ValidateAnchorError
  • func NewNegationAnchorError(msg string) ValidateAnchorError
  • func (e ValidateAnchorError) Error() error
  • func (e ValidateAnchorError) IsConditionAnchorError() bool
  • func (e ValidateAnchorError) IsGlobalAnchorError() bool
  • func (e ValidateAnchorError) IsNegationAnchorError() bool
  • func (e ValidateAnchorError) IsNil() bool
• type ValidationHandler
  • func CreateElementHandler(element string, pattern interface{}, path string) ValidationHandler
  • func NewConditionAnchorHandler(anchor string, pattern interface{}, path string) ValidationHandler
  • func NewDefaultHandler(element string, pattern interface{}, path string) ValidationHandler
  • func NewEqualityHandler(anchor string, pattern interface{}, path string) ValidationHandler
  • func NewExistenceHandler(anchor string, pattern interface{}, path string) ValidationHandler
  • func NewGlobalAnchorHandler(anchor string, pattern interface{}, path string) ValidationHandler
  • func NewNegationHandler(anchor string, pattern interface{}, path string) ValidationHandler

Variables

var ConditionalAnchorErrMsg = "conditional anchor mismatch"

ConditionalAnchorErrMsg - the error message for conditional anchor error

var GlobalAnchorErrMsg = "global anchor mismatch"

GlobalAnchorErrMsg - the error message for global anchor error

var NegationAnchorErrMsg = "negation anchor matched in resource"

NegationAnchorErrMsg - the error message for negation anchor error

Functions

func AddAnchor

func AddAnchor(key, anchorPrefix string) string

AddAnchor adds an anchor with the supplied prefix. The suffix is assumed to be ")".

func ContainsCondition

func ContainsCondition(str string) bool

ContainsCondition returns true, if str is either condition anchor or global condition anchor

func GetAnchorsResourcesFromMap

func GetAnchorsResourcesFromMap(patternMap map[string]interface{}) (map[string]interface{}, map[string]interface{})

GetAnchorsResourcesFromMap returns map of anchors

func IsAddIfNotPresentAnchor

func IsAddIfNotPresentAnchor(key string) bool

IsAddIfNotPresentAnchor checks for addition anchor

func IsConditionAnchor

func IsConditionAnchor(str string) bool

IsConditionAnchor checks for condition anchor

func IsConditionalAnchorError

func IsConditionalAnchorError(msg string) bool

IsConditionalAnchorError checks if error message has conditional anchor error string

func IsEqualityAnchor

func IsEqualityAnchor(str string) bool

IsEqualityAnchor checks for equality anchor

func IsExistenceAnchor

func IsExistenceAnchor(str string) bool

IsExistenceAnchor checks for existence anchor

func IsGlobalAnchor

func IsGlobalAnchor(str string) bool

IsGlobalAnchor checks for global condition anchor

func IsGlobalAnchorError

func IsGlobalAnchorError(msg string) bool

IsGlobalAnchorError checks if error message has global anchor error string

func IsNegationAnchor

func IsNegationAnchor(str string) bool

IsNegationAnchor checks for negation anchor

func IsNegationAnchorError

func IsNegationAnchorError(msg string) bool

IsNegationAnchorError checks if error message has negation anchor error string

func IsNonAnchor

func IsNonAnchor(str string) bool

IsNonAnchor checks that key does not have any anchor

func RemoveAnchor

func RemoveAnchor(key string) (string, string)

RemoveAnchor remove anchor from the given key. It returns the anchor-free tag value and the prefix of the anchor.

func RemoveAnchorsFromPath

func RemoveAnchorsFromPath(str string) string

RemoveAnchorsFromPath removes all anchor from path string

Types

type AnchorError

type AnchorError int

AnchorError is the const specification of anchor errors

const (
	// ConditionalAnchorErr refers to condition violation
	ConditionalAnchorErr AnchorError = iota

	// GlobalAnchorErr refers to global condition violation
	GlobalAnchorErr

	// NegationAnchorErr refers to negation violation
	NegationAnchorErr
)

type AnchorKey

type AnchorKey struct {

	// AnchorError - used in validate to break execution of the recursion when if condition fails
	AnchorError ValidateAnchorError
	// contains filtered or unexported fields
}

AnchorKey - contains map of anchors

func NewAnchorMap

func NewAnchorMap() *AnchorKey

NewAnchorMap -initialize anchorMap

func (*AnchorKey) CheckAnchorInResource

func (ac *AnchorKey) CheckAnchorInResource(pattern interface{}, resource interface{})

CheckAnchorInResource checks if condition anchor key has values

func (*AnchorKey) IsAnchorError

func (ac *AnchorKey) IsAnchorError() bool

IsAnchorError - if any of the anchor key doesn't exists in the resource then it will return true if any of (key)=false then return IsAnchorError() as true if all the keys exists in the pattern exists in resource then return IsAnchorError() as false

type ConditionAnchorHandler

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

ConditionAnchorHandler provides handler for condition anchor

func (ConditionAnchorHandler) Handle

func (ch ConditionAnchorHandler) Handle(handler resourceElementHandler, resourceMap map[string]interface{}, originPattern interface{}, ac *AnchorKey) (string, error)

Handle processed condition anchor

type DefaultHandler

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

DefaultHandler provides handler for non anchor element

func (DefaultHandler) Handle

func (dh DefaultHandler) Handle(handler resourceElementHandler, resourceMap map[string]interface{}, originPattern interface{}, ac *AnchorKey) (string, error)

Handle process non anchor element

type EqualityHandler

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

EqualityHandler provides handler for non anchor element

func (EqualityHandler) Handle

func (eh EqualityHandler) Handle(handler resourceElementHandler, resourceMap map[string]interface{}, originPattern interface{}, ac *AnchorKey) (string, error)

Handle processed condition anchor

type ExistenceHandler

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

ExistenceHandler provides handlers to process exitence anchor handler

func (ExistenceHandler) Handle

func (eh ExistenceHandler) Handle(handler resourceElementHandler, resourceMap map[string]interface{}, originPattern interface{}, ac *AnchorKey) (string, error)

Handle processes the existence anchor handler

type GlobalAnchorHandler

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

GlobalAnchorHandler provides handler for global condition anchor

func (GlobalAnchorHandler) Handle

func (gh GlobalAnchorHandler) Handle(handler resourceElementHandler, resourceMap map[string]interface{}, originPattern interface{}, ac *AnchorKey) (string, error)

Handle processed global condition anchor

type IsAnchor

type IsAnchor func(str string) bool

IsAnchor is a function handler

type NegationHandler

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

NegationHandler provides handler for check if the tag in anchor is not defined

func (NegationHandler) Handle

func (nh NegationHandler) Handle(handler resourceElementHandler, resourceMap map[string]interface{}, originPattern interface{}, ac *AnchorKey) (string, error)

Handle process negation handler

type ValidateAnchorError

type ValidateAnchorError struct {
	Err     AnchorError
	Message string
}

ValidateAnchorError represents the error type of validation anchors

func NewConditionalAnchorError

func NewConditionalAnchorError(msg string) ValidateAnchorError

NewConditionalAnchorError returns a new instance of ConditionalAnchorError

func NewGlobalAnchorError

func NewGlobalAnchorError(msg string) ValidateAnchorError

NewGlobalAnchorError returns a new instance of GlobalAnchorError

func NewNegationAnchorError

func NewNegationAnchorError(msg string) ValidateAnchorError

NewNegationAnchorError returns a new instance of NegationAnchorError

func (ValidateAnchorError) Error

func (e ValidateAnchorError) Error() error

Error returns an error instance of the anchor error

func (ValidateAnchorError) IsConditionAnchorError

func (e ValidateAnchorError) IsConditionAnchorError() bool

IsConditionAnchorError checks if the error is a conditional anchor error

func (ValidateAnchorError) IsGlobalAnchorError

func (e ValidateAnchorError) IsGlobalAnchorError() bool

IsGlobalAnchorError checks if the error is a global anchor error

func (ValidateAnchorError) IsNegationAnchorError

func (e ValidateAnchorError) IsNegationAnchorError() bool

IsNegationAnchorError checks if the error is a negation anchor error

func (ValidateAnchorError) IsNil

func (e ValidateAnchorError) IsNil() bool

IsNil checks if the error isn't populated

type ValidationHandler

type ValidationHandler interface {
	Handle(handler resourceElementHandler, resourceMap map[string]interface{}, originPattern interface{}, ac *AnchorKey) (string, error)
}

ValidationHandler for element processes

func CreateElementHandler

func CreateElementHandler(element string, pattern interface{}, path string) ValidationHandler

CreateElementHandler factory to process elements

func NewConditionAnchorHandler

func NewConditionAnchorHandler(anchor string, pattern interface{}, path string) ValidationHandler

NewConditionAnchorHandler returns an instance of condition acnhor handler

func NewDefaultHandler

func NewDefaultHandler(element string, pattern interface{}, path string) ValidationHandler

NewDefaultHandler returns handler for non anchor elements

func NewEqualityHandler

func NewEqualityHandler(anchor string, pattern interface{}, path string) ValidationHandler

NewEqualityHandler returens instance of equality handler

func NewExistenceHandler

func NewExistenceHandler(anchor string, pattern interface{}, path string) ValidationHandler

NewExistenceHandler returns existence handler

func NewGlobalAnchorHandler

func NewGlobalAnchorHandler(anchor string, pattern interface{}, path string) ValidationHandler

NewGlobalAnchorHandler returns an instance of condition acnhor handler

func NewNegationHandler

func NewNegationHandler(anchor string, pattern interface{}, path string) ValidationHandler

NewNegationHandler returns instance of negation handler