scanner

Documentation

Index

• func DeregisterCheckRule(r rule.Rule)
• func GetRegisteredRules() []rule.Rule
• func GetRuleById(id string) (*rule.Rule, error)
• func GetRuleByLegacyID(legacyID string) (*rule.Rule, error)
• func OptionExcludeRules(ruleIDs []string) func(s *Scanner)
• func OptionIncludeIgnored() func(s *Scanner)
• func OptionIncludePassed() func(s *Scanner)
• func OptionIncludeRules(ruleIDs []string) func(s *Scanner)
• func OptionStopOnErrors() func(s *Scanner)
• func OptionWithSingleThread(single bool) func(s *Scanner)
• func OptionWithWorkspaceName(workspaceName string) func(s *Scanner)
• func RegisterCheckRule(rule rule.Rule)
• type Job
• type Option
• type Pool
  • func NewPool(size int, rules []rule.Rule, modules block.Modules, state *state.State, ...) *Pool
  • func (p *Pool) Run() (rules.Results, error)
• type Scanner
  • func New(options ...Option) *Scanner
  • func (scanner *Scanner) Scan(modules block.Modules) (rules.Results, error)
• type Statistics
  • func AddStatisticsCount(statistics Statistics, result rules.Result) Statistics
  • func SortStatistics(statistics Statistics) Statistics
  • func (statistics Statistics) PrintStatisticsTable()
• type StatisticsItem
• type Worker
  • func NewWorker(incoming <-chan Job) *Worker
  • func (w *Worker) Error() error
  • func (w *Worker) Start()
  • func (w *Worker) Wait() rules.Results

Functions

func DeregisterCheckRule

func DeregisterCheckRule(r rule.Rule)

func GetRegisteredRules

func GetRegisteredRules() []rule.Rule

GetRegisteredRules provides all Checks which have been registered with this package

func GetRuleById

func GetRuleById(id string) (*rule.Rule, error)

func GetRuleByLegacyID

func GetRuleByLegacyID(legacyID string) (*rule.Rule, error)

func OptionExcludeRules

func OptionExcludeRules(ruleIDs []string) func(s *Scanner)

func OptionIncludeIgnored

func OptionIncludeIgnored() func(s *Scanner)

func OptionIncludePassed

func OptionIncludePassed() func(s *Scanner)

func OptionIncludeRules

func OptionIncludeRules(ruleIDs []string) func(s *Scanner)

func OptionStopOnErrors

func OptionStopOnErrors() func(s *Scanner)

func OptionWithSingleThread

func OptionWithSingleThread(single bool) func(s *Scanner)

func OptionWithWorkspaceName

func OptionWithWorkspaceName(workspaceName string) func(s *Scanner)

func RegisterCheckRule

func RegisterCheckRule(rule rule.Rule)

RegisterCheckRule registers a new Rule which should be run on future scans

Types

type Job

type Job interface {
	Run() rules.Results
}

type Option

type Option func(s *Scanner)

type Pool

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

func NewPool

func NewPool(size int, rules []rule.Rule, modules block.Modules, state *state.State, ignoreErrors bool) *Pool

func (*Pool) Run

func (p *Pool) Run() (rules.Results, error)

Run runs the job in the pool - this will only return an error if a job panics

type Scanner

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

Scanner scans HCL blocks by running all registered rules against them

func New

func New(options ...Option) *Scanner

New creates a new Scanner

func (*Scanner) Scan

func (scanner *Scanner) Scan(modules block.Modules) (rules.Results, error)

type Statistics

type Statistics []StatisticsItem

func AddStatisticsCount

func AddStatisticsCount(statistics Statistics, result rules.Result) Statistics

func SortStatistics

func SortStatistics(statistics Statistics) Statistics

func (Statistics) PrintStatisticsTable

func (statistics Statistics) PrintStatisticsTable()

type StatisticsItem

type StatisticsItem struct {
	RuleID          string
	RuleDescription string
	Links           []string
	Count           int
}

type Worker

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

func NewWorker

func NewWorker(incoming <-chan Job) *Worker

func (*Worker) Error

func (w *Worker) Error() error

func (*Worker) Start

func (w *Worker) Start()

func (*Worker) Wait

func (w *Worker) Wait() rules.Results