options

Documentation

Index

• Variables
• func Initialize(opts *Opts) error
• type ActionFactories
  • func (af ActionFactories) Find(name string) action.Factory
• type FilterFactories
  • func (ff FilterFactories) Find(name string) filter.Factory
• type Opts
  • func ToOptions(c config.Configuration) (Opts, error)
  • func (o Opts) DataDir() string
  • func (o *Opts) RepositoryCacheTtl() time.Duration
  • func (o *Opts) SetPrometheusRegistry(reg *prometheus.Registry)
  • func (o Opts) WorkerLoopInterval() time.Duration

Variables

var (
	// ErrNoHosts indicates that no hosts have been set up.
	ErrNoHosts = errors.New("no hosts configured")
)

Functions

func Initialize

func Initialize(opts *Opts) error

Initialize ensures that outside dependencies needed on every execution of saturn-bot are set up. Such dependencies can be logging or directories.

Types

type ActionFactories

type ActionFactories []action.Factory

func (ActionFactories) Find

func (af ActionFactories) Find(name string) action.Factory

type FilterFactories

type FilterFactories []filter.Factory

func (FilterFactories) Find

func (ff FilterFactories) Find(name string) filter.Factory

type Opts

type Opts struct {
	ActionFactories ActionFactories
	// Clock interfaces to a clock.
	// Its purpose is to fake time in unit tests.
	// Defaults to an object that proxies to the [time] package.
	Clock                clock.Clock
	Config               config.Configuration
	FilterFactories      FilterFactories
	Hosts                []host.Host
	IsCi                 bool
	SkipPlugins          bool
	PushGateway          *push.Pusher
	PrometheusGatherer   prometheus.Gatherer
	PrometheusRegisterer prometheus.Registerer
	// contains filtered or unexported fields
}

func ToOptions

func ToOptions(c config.Configuration) (Opts, error)

ToOptions takes a configuration struct, initializes global state and returns an Options struct that can be modified further, if needed.

func (Opts) DataDir

func (o Opts) DataDir() string

func (*Opts) RepositoryCacheTtl

func (o *Opts) RepositoryCacheTtl() time.Duration

func (*Opts) SetPrometheusRegistry

func (o *Opts) SetPrometheusRegistry(reg *prometheus.Registry)

func (Opts) WorkerLoopInterval

func (o Opts) WorkerLoopInterval() time.Duration