executor

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 *Executor)
• func OptionIncludeIgnored(include bool) func(s *Executor)
• func OptionIncludePassed(include bool) func(s *Executor)
• func OptionIncludeRules(ruleIDs []string) func(s *Executor)
• func OptionStopOnErrors(stop bool) func(s *Executor)
• func OptionWithConfig(c config.Config) func(s *Executor)
• func OptionWithSingleThread(single bool) func(s *Executor)
• func OptionWithWorkspaceName(workspaceName string) func(s *Executor)
• func RegisterCheckRule(rule rule.Rule)
• type Executor
  • func New(options ...Option) *Executor
  • func (e *Executor) Execute(modules terraform.Modules) (rules.Results, Metrics, error)
• type Job
• type Metrics
• type Option
  • func OptionWithDebugWriter(w io.Writer) Option
  • func OptionWithResultsFilter(f func(rules.Results) rules.Results) Option
• type Pool
  • func NewPool(size int, rules []rule.Rule, modules terraform.Modules, state *state.State, ...) *Pool
  • func (p *Pool) Run() (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 *Executor)

func OptionIncludeIgnored

func OptionIncludeIgnored(include bool) func(s *Executor)

func OptionIncludePassed

func OptionIncludePassed(include bool) func(s *Executor)

func OptionIncludeRules

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

func OptionStopOnErrors

func OptionStopOnErrors(stop bool) func(s *Executor)

func OptionWithConfig

func OptionWithConfig(c config.Config) func(s *Executor)

func OptionWithSingleThread

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

func OptionWithWorkspaceName

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

func RegisterCheckRule

func RegisterCheckRule(rule rule.Rule)

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

Types

type Executor

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

Executor scans HCL blocks by running all registered rules against them

func New

func New(options ...Option) *Executor

New creates a new Executor

func (*Executor) Execute

func (e *Executor) Execute(modules terraform.Modules) (rules.Results, Metrics, error)

type Job

type Job interface {
	Run() (rules.Results, error)
}

type Metrics

type Metrics struct {
	Timings struct {
		Adaptation    time.Duration
		RunningChecks time.Duration
	}
	Counts struct {
		Ignored  int
		Excluded int
		Failed   int
		Passed   int
		Critical int
		High     int
		Medium   int
		Low      int
	}
}

type Option

type Option func(s *Executor)

func OptionWithDebugWriter

func OptionWithDebugWriter(w io.Writer) Option

func OptionWithResultsFilter

func OptionWithResultsFilter(f func(rules.Results) rules.Results) Option

type Pool

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

func NewPool

func NewPool(size int, rules []rule.Rule, modules terraform.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 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