config

README

Config Engineering Notes

Internal code to manage config, including Cloud Driver parameters and Test Packs

Log Filter Guidelines

Probr Log Levels:

• ERROR - Behavior that is a result of a definite misconfiguration or code failure
• WARN - Behavior that is likely due to a misconfiguration, but is not fatal
• NOTICE - (1) User config information to prevent confusion, or (2) behavior that could result from a misconfiguration but also may be intentional
• INFO - Non-verbose information that doesn't fit the above criteria
• DEBUG - Any potentially helpful information that doesn't fit the above criteria

Multi-line logs should be formatted prior to log.Printf(...). By using this command multiple times, each line will get a separate timestamp and will appear to be separate entries.

For example, Results: could be read as if an empty string was being output.

However, by misusing log.Printf we may cause a similar appearance:

log.Printf("[NOTICE] Results:")
log.Printf("[NOTICE] %s", myVar)
// Prints:
// 2020/09/28 11:18:01 [NOTICE] Results:
// 2020/09/28 11:18:01 [NOTICE] {"some": "information"}

Config

Configuration docs are located in the README at the top level of the probr repository.

When creating new config vars, remember to do the following:

1. Add an entry to the struct ConfigVars in internal/config/config.go
2. Add an entry (matching the config vars struct) to setEnvOrDefaults in internal/config/defaults.go
3. Add logic (matching the defaults entry) to internal/config/getters.go
4. If appropriate, add logic to cmd/probr-cli/flags.go

By following the above steps, you will have accomplished the following:

1. A new variable will be available across the entire probr codebase
2. That variable will have a default value
3. An environment variable can be set to override the default value
4. The env var can be overridden by a provided yaml config file
5. If set, a flag can be used to override the all other values

Documentation

Index

• Variables
• func Init(configPath string) error
• func LineBreakReplacer(s string) string
• func LogConfigState()
• func SetLogFilter(minLevel string, writer io.Writer)
• func ValidateConfigPath(path string) error
• type ConfigVars
  • func NewConfig(c string) (ConfigVars, error)
  • func (ctx *ConfigVars) GetTags() string
• type ProbeExclusion

Variables

var Spinner *spinner.Spinner

Functions

func Init

func Init(configPath string) error

Init will override config.Vars with the content retrieved from a filepath

func LineBreakReplacer

func LineBreakReplacer(s string) string

LineBreakReplacer replaces carriage return (\r), linefeed (\n), formfeed (\f) and other similar characters with a space.

func LogConfigState

func LogConfigState()

func SetLogFilter

func SetLogFilter(minLevel string, writer io.Writer)

Override the minmium log level.

func ValidateConfigPath

func ValidateConfigPath(path string) error

ValidateConfigPath simply ensures the file exists

Types

type ConfigVars

type ConfigVars struct {
	// NOTE: Env and Defaults are ONLY available if corresponding logic is added to defaults.go and getters.go
	ServicePacks                  servicePacks     `yaml:"ServicePacks"`
	CloudProviders                cloudProviders   `yaml:"CloudProviders"`
	OutputType                    string           `yaml:"OutputType"`
	CucumberDir                   string           `yaml:"CucumberDir"`
	AuditDir                      string           `yaml:"AuditDir"`
	AuditEnabled                  string           `yaml:"AuditEnabled"`
	LogLevel                      string           `yaml:"LogLevel"`
	OverwriteHistoricalAudits     string           `yaml:"OverwriteHistoricalAudits"`
	AuthorisedContainerRegistry   string           `yaml:"AuthorisedContainerRegistry"`
	UnauthorisedContainerRegistry string           `yaml:"UnauthorisedContainerRegistry"`
	ProbeImage                    string           `yaml:"ProbeImage"`
	ProbeExclusions               []ProbeExclusion `yaml:"ProbeExclusions"`
	TagExclusions                 []string         `yaml:"TagExclusions"`
	Tags                          string           // set by flags
	VarsFile                      string           // set by flags only
	NoSummary                     bool             // set by flags only
	Silent                        bool             // set by flags only
}

ConfigVars contains all possible config vars

var Vars ConfigVars

Vars is a singleton instance of ConfigVars

func NewConfig

func NewConfig(c string) (ConfigVars, error)

NewConfig overrides the current config.Vars values

func (*ConfigVars) GetTags

func (ctx *ConfigVars) GetTags() string

GetTags returns Tags, prioritising command line parameter over vars file

type ProbeExclusion

type ProbeExclusion struct {
	Name          string `yaml:"Name"`
	Excluded      bool   `yaml:"Excluded"`
	Justification string `yaml:"Justification"`
}