policy

Documentation

Index

• type CloneFn
• type GitClient
• type GitPolicyFile
• type GitPolicySource
  • func (src GitPolicySource) GetPolicyFiles() ([]*PolicyFile, error)
• type GitTree
• type GitTreeWalker
• type LocalPolicySource
  • func (src LocalPolicySource) GetPolicyFiles() ([]*PolicyFile, error)
• type Policy
• type PolicyAgent
  • func NewPolicyAgent(ctx context.Context, files []*PolicyFile) *PolicyAgent
  • func (p *PolicyAgent) EvaluatePolicies(input interface{}) (*PolicyEvaluationResult, error)
• type PolicyEvaluationResult
  • func (r *PolicyEvaluationResult) AppendErroredPolicy(policy *Policy)
  • func (r *PolicyEvaluationResult) AppendSuccessfulPolicy(policy *Policy)
  • func (r *PolicyEvaluationResult) Errored() []*Policy
  • func (r *PolicyEvaluationResult) ErroredCount() int
  • func (r *PolicyEvaluationResult) Groups() []string
  • func (r *PolicyEvaluationResult) Policies(group string) []*Policy
  • func (r *PolicyEvaluationResult) ValidCount() int
  • func (r *PolicyEvaluationResult) ViolatedCount() int
• type PolicyFile
• type PolicySource
  • func NewGitPolicySource(repoURL string, repoBrach string, policyDir string) PolicySource
  • func NewLocalPolicySource(rootDirectory string) PolicySource
• type ReadFn
• type WalkFn

Types

type CloneFn

type CloneFn func(s storage.Storer, worktree billy.Filesystem, o *git.CloneOptions) (*git.Repository, error)

type GitClient

type GitClient interface {
	Clone(s storage.Storer, worktree billy.Filesystem, o *git.CloneOptions) (*git.Repository, error)
}

type GitPolicyFile

type GitPolicyFile struct {
	Hash string
	*PolicyFile
}

type GitPolicySource

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

func (GitPolicySource) GetPolicyFiles

func (src GitPolicySource) GetPolicyFiles() ([]*PolicyFile, error)

type GitTree

type GitTree interface {
	TreeEntryFile(e *object.TreeEntry) (*object.File, error)
}

type GitTreeWalker

type GitTreeWalker interface {
	Next() (name string, entry object.TreeEntry, err error)
	Close()
}

type LocalPolicySource

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

func (LocalPolicySource) GetPolicyFiles

func (src LocalPolicySource) GetPolicyFiles() ([]*PolicyFile, error)

type Policy

type Policy struct {
	Name             string
	FullName         string
	Description      string
	Group            string
	Valid            bool
	Violations       []string
	ProcessingErrors []error
}

type PolicyAgent

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

func NewPolicyAgent

func NewPolicyAgent(ctx context.Context, files []*PolicyFile) *PolicyAgent

func (*PolicyAgent) EvaluatePolicies

func (p *PolicyAgent) EvaluatePolicies(input interface{}) (*PolicyEvaluationResult, error)

type PolicyEvaluationResult

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

func (*PolicyEvaluationResult) AppendErroredPolicy

func (r *PolicyEvaluationResult) AppendErroredPolicy(policy *Policy)

func (*PolicyEvaluationResult) AppendSuccessfulPolicy

func (r *PolicyEvaluationResult) AppendSuccessfulPolicy(policy *Policy)

func (*PolicyEvaluationResult) Errored

func (r *PolicyEvaluationResult) Errored() []*Policy

func (*PolicyEvaluationResult) ErroredCount

func (r *PolicyEvaluationResult) ErroredCount() int

func (*PolicyEvaluationResult) Groups

func (r *PolicyEvaluationResult) Groups() []string

func (*PolicyEvaluationResult) Policies

func (r *PolicyEvaluationResult) Policies(group string) []*Policy

func (*PolicyEvaluationResult) ValidCount

func (r *PolicyEvaluationResult) ValidCount() int

func (*PolicyEvaluationResult) ViolatedCount

func (r *PolicyEvaluationResult) ViolatedCount() int

type PolicyFile

type PolicyFile struct {
	Name     string
	FullName string
	Content  string
}

type PolicySource

type PolicySource interface {
	GetPolicyFiles() ([]*PolicyFile, error)
}

func NewGitPolicySource

func NewGitPolicySource(repoURL string, repoBrach string, policyDir string) PolicySource

func NewLocalPolicySource

func NewLocalPolicySource(rootDirectory string) PolicySource

type ReadFn

type ReadFn func(name string) ([]byte, error)

type WalkFn

type WalkFn func(root string, fn filepath.WalkFunc) error