issues

Documentation

Index

• Constants
• Variables
• func LevelToStr(l config.Level) string
• type Codes
  • func LoadCodes() (*Codes, error)
  • func (c *Codes) Refine(gloss config.Glossary)
• type Collector
  • func NewCollector(codes *Codes, cfg *config.Config) *Collector
  • func (c *Collector) AddCode(ctx context.Context, code config.ID, args ...interface{})
  • func (c *Collector) AddErr(ctx context.Context, errs ...error)
  • func (c *Collector) AddSubCode(ctx context.Context, code config.ID, args ...interface{})
  • func (c *Collector) ClearOutcome(fqn string)
  • func (c *Collector) InitOutcome(fqn string)
  • func (c *Collector) MaxSeverity(fqn string) config.Level
  • func (c *Collector) NoConcerns(fqn string) bool
  • func (c *Collector) Outcome() Outcome
• type Issue
  • func New(gvr client.GVR, group string, level config.Level, description string) Issue
  • func Newf(gvr client.GVR, group string, level config.Level, format string, ...) Issue
  • func (i Issue) Blank() bool
  • func (i Issue) IsSubIssue() bool
• type Issues
  • func (i Issues) Group() map[string]Issues
  • func (i Issues) MaxSeverity() config.Level
  • func (i Issues) Sort(l config.Level) Issues
• type Outcome
  • func (o Outcome) Filter(level config.Level) Outcome
  • func (o Outcome) For(section, group string) Issues
  • func (o Outcome) MaxGroupSeverity(section, group string) config.Level
  • func (o Outcome) MaxSeverity(section string) config.Level

Constants

const Root = "__root__"

Root denotes a root issue group.

Variables

var Blank = Issue{}

Blank issue

Functions

func LevelToStr

func LevelToStr(l config.Level) string

LevelToStr returns a severity level as a string.

Types

type Codes

type Codes struct {
	Glossary config.Glossary `yaml:"codes"`
}

Codes represents a collection of sanitizer codes.

func LoadCodes

func LoadCodes() (*Codes, error)

LoadCodes retrieves sanitizers codes from yaml file.

func (*Codes) Refine

func (c *Codes) Refine(gloss config.Glossary)

Refine overrides code severity based on user input.

type Collector

type Collector struct {
	*config.Config
	// contains filtered or unexported fields
}

Collector represents a sanitizer issue container.

func NewCollector

func NewCollector(codes *Codes, cfg *config.Config) *Collector

NewCollector returns a new issue collector.

func (*Collector) AddCode

func (c *Collector) AddCode(ctx context.Context, code config.ID, args ...interface{})

AddCode add an error code.

func (*Collector) AddErr

func (c *Collector) AddErr(ctx context.Context, errs ...error)

AddErr adds a collection of errors.

func (*Collector) AddSubCode

func (c *Collector) AddSubCode(ctx context.Context, code config.ID, args ...interface{})

AddSubCode add a sub error code.

func (*Collector) ClearOutcome

func (c *Collector) ClearOutcome(fqn string)

ClearOutcome delete all fqn related issues.

func (*Collector) InitOutcome

func (c *Collector) InitOutcome(fqn string)

InitOutcome creates a places holder for potential issues.

func (*Collector) MaxSeverity

func (c *Collector) MaxSeverity(fqn string) config.Level

MaxSeverity return the highest severity level foe the given section.

func (*Collector) NoConcerns

func (c *Collector) NoConcerns(fqn string) bool

NoConcerns returns true if scan is successful.

func (*Collector) Outcome

func (c *Collector) Outcome() Outcome

Outcome returns scan outcome.

type Issue

type Issue struct {
	Group   string       `yaml:"group" json:"group"`
	GVR     string       `yaml:"gvr" json:"gvr"`
	Level   config.Level `yaml:"level" json:"level"`
	Message string       `yaml:"message" json:"message"`
}

Issue tracks a sanitizer issui.

func New

func New(gvr client.GVR, group string, level config.Level, description string) Issue

New returns a new lint issue.

func Newf

func Newf(gvr client.GVR, group string, level config.Level, format string, args ...interface{}) Issue

Newf returns a new lint issue using a formatter.

func (Issue) Blank

func (i Issue) Blank() bool

Blank checks if an issue is blank.

func (Issue) IsSubIssue

func (i Issue) IsSubIssue() bool

IsSubIssue checks if error is a sub error.

type Issues

type Issues []Issue

Issues represents a collection of issues.

func (Issues) Group

func (i Issues) Group() map[string]Issues

Group collect issues as groups.

func (Issues) MaxSeverity

func (i Issues) MaxSeverity() config.Level

MaxSeverity gather the max severity in a collection of issues.

func (Issues) Sort

func (i Issues) Sort(l config.Level) Issues

Sort sorts issues.

type Outcome

type Outcome map[string]Issues

Outcome represents outcomes resulting from sanitization pass.

func (Outcome) Filter

func (o Outcome) Filter(level config.Level) Outcome

Filter filters outcomes based on sanitizer level.

func (Outcome) For

func (o Outcome) For(section, group string) Issues

For returns issues for a given section/group.

func (Outcome) MaxGroupSeverity

func (o Outcome) MaxGroupSeverity(section, group string) config.Level

MaxGroupSeverity scans the issues and reports the highest severity.

func (Outcome) MaxSeverity

func (o Outcome) MaxSeverity(section string) config.Level

MaxSeverity scans the issues and reports the highest severity.