info

Documentation

Index

• func RulesSuccesfuly(rules []*RuleInfo) bool
• type PolicyInfo
  • func NewPolicyInfo(policyName, rKind, rName, rNamespace, validationFailureAction string) *PolicyInfo
  • func (pi *PolicyInfo) AddRuleInfos(rules []*RuleInfo)
  • func (pi *PolicyInfo) ContainsRuleType(ruleType RuleType) bool
  • func (pi *PolicyInfo) ErrorRules() string
  • func (pi *PolicyInfo) FailedRules() []string
  • func (pi *PolicyInfo) GetFailedRules() []v1alpha1.FailedRule
  • func (pi *PolicyInfo) GetRuleNames(onSuccess bool) string
  • func (pi *PolicyInfo) IsSuccessful() bool
  • func (pi *PolicyInfo) SuccessfulRules() []string
• type RuleInfo
  • func NewRuleInfo(ruleName string, ruleType RuleType) *RuleInfo
  • func (ri *RuleInfo) Add(msg string)
  • func (ri *RuleInfo) Addf(msg string, args ...interface{})
  • func (ri *RuleInfo) Fail()
  • func (ri *RuleInfo) GetErrorString() string
  • func (ri *RuleInfo) IsSuccessful() bool
  • func (ri *RuleInfo) ToString() string
• type RuleType
  • func (ri RuleType) String() string

Functions

func RulesSuccesfuly

func RulesSuccesfuly(rules []*RuleInfo) bool

RulesSuccesfuly check if the any rule has failed or not

Types

type PolicyInfo

type PolicyInfo struct {
	// Name is policy name
	Name string
	// RKind represents the resource kind
	RKind string
	// RName is resource name
	RName string
	// Namespace is the ns of resource
	// empty on non-namespaced resources
	RNamespace string
	//TODO: add check/enum for types
	ValidationFailureAction string // BlockChanges, ReportViolation
	Rules                   []*RuleInfo
	// contains filtered or unexported fields
}

PolicyInfo defines policy information

func NewPolicyInfo

func NewPolicyInfo(policyName, rKind, rName, rNamespace, validationFailureAction string) *PolicyInfo

NewPolicyInfo returns a new policy info

func (*PolicyInfo) AddRuleInfos

func (pi *PolicyInfo) AddRuleInfos(rules []*RuleInfo)

AddRuleInfos sets the rule information

func (*PolicyInfo) ContainsRuleType

func (pi *PolicyInfo) ContainsRuleType(ruleType RuleType) bool

ContainsRuleType checks if a policy info contains a rule type

func (*PolicyInfo) ErrorRules

func (pi *PolicyInfo) ErrorRules() string

ErrorRules returns error msgs from all rule

func (*PolicyInfo) FailedRules

func (pi *PolicyInfo) FailedRules() []string

FailedRules returns list of failed rule names

func (*PolicyInfo) GetFailedRules

func (pi *PolicyInfo) GetFailedRules() []v1alpha1.FailedRule

GetFailedRules returns the failed rules with rule type

func (*PolicyInfo) GetRuleNames

func (pi *PolicyInfo) GetRuleNames(onSuccess bool) string

GetRuleNames gets the name of successful rules

func (*PolicyInfo) IsSuccessful

func (pi *PolicyInfo) IsSuccessful() bool

IsSuccessful checks if policy is succesful the policy is set to fail, if any of the rules have failed

func (*PolicyInfo) SuccessfulRules

func (pi *PolicyInfo) SuccessfulRules() []string

SuccessfulRules returns list of successful rule names

type RuleInfo

type RuleInfo struct {
	Name     string
	Msgs     []string
	Changes  string // this will store the mutation patch being applied by the rule
	RuleType RuleType
	// contains filtered or unexported fields
}

RuleInfo defines rule struct

func NewRuleInfo

func NewRuleInfo(ruleName string, ruleType RuleType) *RuleInfo

NewRuleInfo creates a new RuleInfo

func (*RuleInfo) Add

func (ri *RuleInfo) Add(msg string)

Add add msg

func (*RuleInfo) Addf

func (ri *RuleInfo) Addf(msg string, args ...interface{})

Addf add msg with args

func (*RuleInfo) Fail

func (ri *RuleInfo) Fail()

Fail set the rule as failed

func (*RuleInfo) GetErrorString

func (ri *RuleInfo) GetErrorString() string

GetErrorString returns the error message for a rule

func (*RuleInfo) IsSuccessful

func (ri *RuleInfo) IsSuccessful() bool

IsSuccessful checks if rule is succesful

func (*RuleInfo) ToString

func (ri *RuleInfo) ToString() string

ToString reule information TODO: check if this is needed

type RuleType

type RuleType int

const (
	Mutation RuleType = iota
	Validation
	Generation
	All
)

func (RuleType) String

func (ri RuleType) String() string