util

Documentation

Index

• Constants
• Variables
• func CreateDirectory(workingDirectory string, name string, strict bool) (string, error)
• func CreateFile(workingDirectory string, name string) (string, error)
• func IsPointingAtTemplatedRules(paths []string) error
• func TemplateFile(workingDirectory string, fileName string, template string, ...) error
• func Term() (*ast.Term, error)
• func ValidateFilePath(path string) (fs.FileInfo, error)
• type CapabilitiesFlag
  • func NewCapabilitiesFlag() CapabilitiesFlag
  • func (f *CapabilitiesFlag) Set(s string) error
  • func (f *CapabilitiesFlag) String() string
  • func (f *CapabilitiesFlag) Type() string
• type EnumFlag
  • func NewEnumFlag(defaultValue string, vs []string) EnumFlag
  • func (f *EnumFlag) IsSet() bool
  • func (f *EnumFlag) Set(s string) error
  • func (f *EnumFlag) String() string
  • func (f *EnumFlag) Type() string
• type LoaderFilter
  • func (f LoaderFilter) Apply(abspath string, info os.FileInfo, depth int) bool
• type RepeatedStringFlag
  • func NewRepeatedStringFlag(defaultValue string) RepeatedStringFlag
  • func (f *RepeatedStringFlag) IsSet() bool
  • func (f *RepeatedStringFlag) Set(s string) error
  • func (f *RepeatedStringFlag) String() string
  • func (f *RepeatedStringFlag) Strings() []string
  • func (f *RepeatedStringFlag) Type() string
• type Rule
  • func RetrieveRules(paths []string) ([]Rule, error)
• type Templating

Constants

const (
	TargetRego = "rego"
	TargetWasm = "wasm"
)

const (
	JSON           = "json"
	HCL2           = "hcl2"
	YAML           = "yaml"
	TERRAFORM_PLAN = "tf-plan"
)

const (
	LOW      = "low"
	MEDIUM   = "medium"
	HIGH     = "high"
	CRITICAL = "critical"
)

const (
	ExplainModeFull  = "full"
	ExplainModeNotes = "notes"
	ExplainModeFails = "fails"
)

Variables

var ValidSeverityLevels = []string{LOW, MEDIUM, HIGH, CRITICAL}

Functions

func CreateDirectory

func CreateDirectory(workingDirectory string, name string, strict bool) (string, error)

func CreateFile

func CreateFile(workingDirectory string, name string) (string, error)

func IsPointingAtTemplatedRules

func IsPointingAtTemplatedRules(paths []string) error

func TemplateFile

func TemplateFile(workingDirectory string, fileName string, template string, templating Templating) error

func Term

func Term() (*ast.Term, error)

func ValidateFilePath

func ValidateFilePath(path string) (fs.FileInfo, error)

Types

type CapabilitiesFlag

type CapabilitiesFlag struct {
	C *ast.Capabilities
	// contains filtered or unexported fields
}

func NewCapabilitiesFlag

func NewCapabilitiesFlag() CapabilitiesFlag

func (*CapabilitiesFlag) Set

func (f *CapabilitiesFlag) Set(s string) error

func (*CapabilitiesFlag) String

func (f *CapabilitiesFlag) String() string

func (*CapabilitiesFlag) Type

func (f *CapabilitiesFlag) Type() string

type EnumFlag

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

func NewEnumFlag

func NewEnumFlag(defaultValue string, vs []string) EnumFlag

func (*EnumFlag) IsSet

func (f *EnumFlag) IsSet() bool

IsSet will return true if the EnumFlag has been set.

func (*EnumFlag) Set

func (f *EnumFlag) Set(s string) error

Set sets the enum value. If s is not a valid enum value, an error is returned.

func (*EnumFlag) String

func (f *EnumFlag) String() string

String returns the EnumValue's value as string.

func (*EnumFlag) Type

func (f *EnumFlag) Type() string

Type returns the valid enumeration values.

type LoaderFilter

type LoaderFilter struct {
	Ignore []string
}

LoaderFilter was taken from https://github.com/open-policy-agent/opa/blob/v0.31.0/cmd/filters.go#L13

func (LoaderFilter) Apply

func (f LoaderFilter) Apply(abspath string, info os.FileInfo, depth int) bool

type RepeatedStringFlag

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

func NewRepeatedStringFlag

func NewRepeatedStringFlag(defaultValue string) RepeatedStringFlag

func (*RepeatedStringFlag) IsSet

func (f *RepeatedStringFlag) IsSet() bool

func (*RepeatedStringFlag) Set

func (f *RepeatedStringFlag) Set(s string) error

func (*RepeatedStringFlag) String

func (f *RepeatedStringFlag) String() string

func (*RepeatedStringFlag) Strings

func (f *RepeatedStringFlag) Strings() []string

func (*RepeatedStringFlag) Type

func (f *RepeatedStringFlag) Type() string

type Rule

type Rule struct {
	PublicId      string
	SeverityLevel string
	Path          string
}

func RetrieveRules

func RetrieveRules(paths []string) ([]Rule, error)

type Templating

type Templating struct {
	RuleID       string
	RuleTitle    string
	RuleSeverity string
	Replace      func(string, string, string) string
}