drift

Documentation

Index

• Constants
• Variables
• type Detector
• type ErrSyncerAlreadyRegistered
  • func (e *ErrSyncerAlreadyRegistered) Error() string
• type Priority
  • func (p Priority) String() string
• type Registry
  • func NewRegistry(syncers []Detector) (Registry, error)
• type RunData
  • func (r *RunData) AutogenMsg() string

Constants

const (
	PriorityLowest  = Priority(100)
	PriorityLow     = Priority(200)
	PriorityNormal  = Priority(300)
	PriorityHigh    = Priority(400)
	PriorityHighest = Priority(500)
)

const (
	MagicTrackedString                = "THIS FILE IS AUTOGENERATED BY SYNCER" + " DO NOT EDIT"
	DefaultSyncerGeneratedGoDirectory = "internal"
	DefaultSyncerGeneratedGoFilename  = "syncer.go"
	DefaultSyncerConfigFileName       = ".syncer.yaml"
)

const (
	FxTagSyncers = `group:"syncers"`
)

Variables

var Module = fx.Module("syncer",
	fx.Provide(
		fx.Annotate(
			NewRegistry,
			fx.As(new(Registry)),
			fx.ParamTags(FxTagSyncers),
		),
	),
)

Types

type Detector

type Detector interface {
	DetectDrift(ctx context.Context, runData *RunData) (*files.System[*files.StateWithChangeReason], error)
	Name() config.Name
	Priority() Priority
}

type ErrSyncerAlreadyRegistered

type ErrSyncerAlreadyRegistered struct {
	Name string
}

func (*ErrSyncerAlreadyRegistered) Error

func (e *ErrSyncerAlreadyRegistered) Error() string

type Priority

type Priority int

func (Priority) String

func (p Priority) String() string

type Registry

type Registry interface {
	Registered() []Detector
	Get(name config.Name) (Detector, bool)
}

func NewRegistry

func NewRegistry(syncers []Detector) (Registry, error)

type RunData

type RunData struct {
	// The root config file
	RootConfig *config.Root
	// The subsection of the config file that is relevant to this run
	RunConfig config.Dynamic
	// The registries of this run
	Registry Registry
	// Where we want to copy destination files to
	DestinationWorkingDir string
}

func (*RunData) AutogenMsg

func (r *RunData) AutogenMsg() string