base

Documentation

Index

• Variables
• type Cfg
  • func Mock(paths *path.Paths, dir string) (*Cfg, error)
  • func New(paths *path.Paths) *Cfg
  • func (cfg *Cfg) Load() error
  • func (cfg *Cfg) Path() string
  • func (cfg *Cfg) Validate() error

Variables

var (
	// ErrHostnameLookup means hostname lookup error.
	ErrHostnameLookup = errors.New("base: hostname lookup error")
)

Types

type Cfg

type Cfg struct {
	Identifier string `env:"IDENTIFIER"`
	Cores      int    `env:"CORES"`
	Threads    int    `env:"THREADS"`
	Scans      *scan.Cfg
	Secrets    *secret.Cfg
	Acts       *act.Cfg
	Database   *db.Cfg
	Log        *logger.Cfg
	// contains filtered or unexported fields
}

Cfg represents base cfg. It also references secondary cfgs such as secrets, actions, etc.

func Mock

func Mock(paths *path.Paths, dir string) (*Cfg, error)

Mock mocks a cfg.

func New

func New(paths *path.Paths) *Cfg

New returns a new base cfg from given paths.

func (*Cfg) Load

func (cfg *Cfg) Load() error

Load reads the cfg from toml path.

func (*Cfg) Path

func (cfg *Cfg) Path() string

Path returns a given cfg's toml path.

func (*Cfg) Validate

func (cfg *Cfg) Validate() error

Validate validates cfg var values beyond toml concrete types.