policydevel

Documentation

Index

• func Initialize(opts *InitOptions) error
• type Content
• type EvalOptions
• type EvalResult
  • func Evaluate(opts *EvalOptions, logger zerolog.Logger) (*EvalResult, error)
• type File
• type InitOptions
• type PolicyToLint
  • func Lookup(absPath, config string, format bool) (*PolicyToLint, error)
  • func (p *PolicyToLint) AddError(path, message string, line int)
  • func (p *PolicyToLint) HasErrors() bool
  • func (p *PolicyToLint) Validate()
• type TemplateData
• type ValidationError
  • func (e ValidationError) Error() string

Functions

func Initialize

func Initialize(opts *InitOptions) error

Types

type Content

type Content struct {
	YAML string
	Rego string
}

type EvalOptions

type EvalOptions struct {
	PolicyPath   string
	MaterialKind string
	Annotations  map[string]string
	MaterialPath string
	Inputs       map[string]string
}

type EvalResult

type EvalResult struct {
	Skipped     bool
	SkipReasons []string
	Violations  []string
	Ignored     bool
}

func Evaluate

func Evaluate(opts *EvalOptions, logger zerolog.Logger) (*EvalResult, error)

type File

type File struct {
	Path    string
	Content []byte
}

type InitOptions

type InitOptions struct {
	Directory   string
	Embedded    bool
	Force       bool
	Name        string
	Description string
}

type PolicyToLint

type PolicyToLint struct {
	Path      string
	YAMLFiles []*File
	RegoFiles []*File
	Format    bool
	Config    string
	Errors    []ValidationError
}

func Lookup

func Lookup(absPath, config string, format bool) (*PolicyToLint, error)

Read policy files from the given directory or file

func (*PolicyToLint) AddError

func (p *PolicyToLint) AddError(path, message string, line int)

Adds a new validation error

func (*PolicyToLint) HasErrors

func (p *PolicyToLint) HasErrors() bool

Returns true if any validation errors were found

func (*PolicyToLint) Validate

func (p *PolicyToLint) Validate()

type TemplateData

type TemplateData struct {
	Name         string
	Description  string
	RegoPath     string
	RegoContent  string
	Embedded     bool
	MaterialKind string
}

type ValidationError

type ValidationError struct {
	Path    string
	Line    int
	Message string
}

func (ValidationError) Error

func (e ValidationError) Error() string