executor

Documentation

Index

• type Executor
  • func New(options ...Option) *Executor
  • func (e *Executor) Execute(modules terraform.Modules) (scan.Results, error)
• type Job
• type Option
  • func OptionWithFrameworks(frameworks ...framework.Framework) Option
  • func OptionWithIncludeDeprecatedChecks(b bool) Option
  • func OptionWithRegoOnly(regoOnly bool) Option
  • func OptionWithRegoScanner(s *rego.Scanner) Option
  • func OptionWithResultsFilter(f func(scan.Results) scan.Results) Option
  • func OptionWithWorkspaceName(workspaceName string) Option
• type Pool
  • func NewPool(size int, rules []types.RegisteredRule, modules terraform.Modules, ...) *Pool
  • func (p *Pool) Run() (scan.Results, error)
• type Worker
  • func NewWorker(incoming <-chan Job) *Worker
  • func (w *Worker) Error() error
  • func (w *Worker) Start()
  • func (w *Worker) Wait() scan.Results

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) (scan.Results, error)

type Job

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

type Option

type Option func(s *Executor)

func OptionWithFrameworks

func OptionWithFrameworks(frameworks ...framework.Framework) Option

func OptionWithIncludeDeprecatedChecks

func OptionWithIncludeDeprecatedChecks(b bool) Option

func OptionWithRegoOnly

func OptionWithRegoOnly(regoOnly bool) Option

func OptionWithRegoScanner

func OptionWithRegoScanner(s *rego.Scanner) Option

func OptionWithResultsFilter

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

func OptionWithWorkspaceName

func OptionWithWorkspaceName(workspaceName string) Option

type Pool

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

func NewPool

func NewPool(size int, rules []types.RegisteredRule, modules terraform.Modules, st *state.State, regoScanner *rego.Scanner, regoOnly bool) *Pool

func (*Pool) Run

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

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

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() scan.Results