config

type Cmd struct {
	Name        string            `yaml:"name" toml:"name"`
	Copy        CopyInternal      `yaml:"copy" toml:"copy"`
	MCopy       []CopyInternal    `yaml:"mcopy" toml:"mcopy"` // multiple copy commands, implemented internally
	Sync        SyncInternal      `yaml:"sync" toml:"sync"`
	MSync       []SyncInternal    `yaml:"msync" toml:"msync"` // multiple sync commands, implemented internally
	Delete      DeleteInternal    `yaml:"delete" toml:"delete"`
	MDelete     []DeleteInternal  `yaml:"mdelete" toml:"mdelete"` // multiple delete commands, implemented internally
	Wait        WaitInternal      `yaml:"wait" toml:"wait"`
	Script      string            `yaml:"script" toml:"script,multiline"`
	Echo        string            `yaml:"echo" toml:"echo"`
	Environment map[string]string `yaml:"env" toml:"env"`
	Options     CmdOptions        `yaml:"options" toml:"options,omitempty"`
	Condition   string            `yaml:"cond" toml:"cond,omitempty"`
	Register    []string          `yaml:"register" toml:"register"` // register variables from command
	OnExit      string            `yaml:"on_exit" toml:"on_exit"`   // script to run on exit

	Secrets    map[string]string `yaml:"-" toml:"-"` // loaded secrets, filled by playbook
	SSHShell   string            `yaml:"-" toml:"-"` // shell to use for ssh commands, filled by playbook
	LocalShell string            `yaml:"-" toml:"-"` // shell to use for local commands, filled by playbooks
}

type CmdOptions struct {
	IgnoreErrors bool     `yaml:"ignore_errors" toml:"ignore_errors"` // ignore errors and continue
	NoAuto       bool     `yaml:"no_auto" toml:"no_auto"`             // don't run command automatically
	Local        bool     `yaml:"local" toml:"local"`                 // run command on localhost
	Sudo         bool     `yaml:"sudo" toml:"sudo"`                   // run command with sudo
	Secrets      []string `yaml:"secrets" toml:"secrets"`             // list of secrets (keys) to load
	OnlyOn       []string `yaml:"only_on" toml:"only_on"`             // only run on these hosts
}

type CopyInternal struct {
	Source  string   `yaml:"src" toml:"src"`         // source must be a file or a glob pattern
	Dest    string   `yaml:"dst" toml:"dst"`         // destination must be a file or a directory
	Mkdir   bool     `yaml:"mkdir" toml:"mkdir"`     // create destination directory if it does not exist
	Force   bool     `yaml:"force" toml:"force"`     // force copy even if source and destination are the same
	Exclude []string `yaml:"exclude" toml:"exclude"` // exclude files matching these patterns
	ChmodX  bool     `yaml:"chmod+x" toml:"chmod+x"` // chmod +x on destination file
}

type DeleteInternal struct {
	Location  string   `yaml:"path" toml:"path"`
	Recursive bool     `yaml:"recur" toml:"recur"`
	Exclude   []string `yaml:"exclude" toml:"exclude"`
}

type Destination struct {
	Name string   `yaml:"name" toml:"name"`
	Host string   `yaml:"host" toml:"host"`
	Port int      `yaml:"port" toml:"port"`
	User string   `yaml:"user" toml:"user"`
	Tags []string `yaml:"tags" toml:"tags"`
}

type InventoryData struct {
	Groups map[string][]Destination `yaml:"groups" toml:"groups"`
	Hosts  []Destination            `yaml:"hosts" toml:"hosts"`
}

type Overrides struct {
	User         string
	Inventory    string
	Environment  map[string]string
	AdHocCommand string
	SSHShell     string
}

type PlayBook struct {
	User       string            `yaml:"user" toml:"user"`               // ssh user
	SSHKey     string            `yaml:"ssh_key" toml:"ssh_key"`         // ssh key
	SSHShell   string            `yaml:"ssh_shell" toml:"ssh_shell"`     // ssh shell to use
	LocalShell string            `yaml:"local_shell" toml:"local_shell"` // local shell to use
	Inventory  string            `yaml:"inventory" toml:"inventory"`     // inventory file or url
	Targets    map[string]Target `yaml:"targets" toml:"targets"`         // list of targets/environments
	Tasks      []Task            `yaml:"tasks" toml:"tasks"`             // list of tasks
	// contains filtered or unexported fields
}

type SecretsProvider interface {
	Get(key string) (string, error)
}

type SimplePlayBook struct {
	User       string     `yaml:"user" toml:"user"`                 // ssh user
	SSHKey     string     `yaml:"ssh_key" toml:"ssh_key"`           // ssh key
	SSHShell   string     `yaml:"ssh_shell" toml:"ssh_shell"`       // ssh shell to uses
	LocalShell string     `yaml:"local_shell" toml:"local_shell"`   // local shell to use
	Inventory  string     `yaml:"inventory" toml:"inventory"`       // inventory file or url
	Targets    []string   `yaml:"targets" toml:"targets"`           // list of names
	Target     string     `yaml:"target" toml:"target"`             // a single target to run task on
	Task       []Cmd      `yaml:"task" toml:"task"`                 // single task is a list of commands
	Options    CmdOptions `yaml:"options" toml:"options,omitempty"` // options for all commands
}

type SyncInternal struct {
	Source  string   `yaml:"src" toml:"src"`         // source must be a directory
	Dest    string   `yaml:"dst" toml:"dst"`         // destination must be a directory
	Delete  bool     `yaml:"delete" toml:"delete"`   // delete files in destination that are not in source
	Exclude []string `yaml:"exclude" toml:"exclude"` // exclude files matching these patterns
	Force   bool     `yaml:"force" toml:"force"`     // force sync even if source and destination are the same
}

type Target struct {
	Name   string        `yaml:"-" toml:"-"`           // name of target, set from the map key
	Hosts  []Destination `yaml:"hosts" toml:"hosts"`   // direct list of hosts to run commands on, no need to use inventory
	Groups []string      `yaml:"groups" toml:"groups"` // list of groups to run commands on, matches to inventory
	Names  []string      `yaml:"names" toml:"names"`   // list of host names to run commands on, matches to inventory
	Tags   []string      `yaml:"tags" toml:"tags"`     // list of tags to run commands on, matches to inventory
}

type Task struct {
	Name     string     `yaml:"name" toml:"name"` // name of task, mandatory
	User     string     `yaml:"user" toml:"user"`
	Commands []Cmd      `yaml:"commands" toml:"commands"`
	OnError  string     `yaml:"on_error" toml:"on_error"`
	Targets  []string   `yaml:"targets" toml:"targets"`           // optional list of targets to run task on, names or groups
	Options  CmdOptions `yaml:"options" toml:"options,omitempty"` // options for all commands
}

type WaitInternal struct {
	Timeout       time.Duration `yaml:"timeout" toml:"timeout"`
	CheckDuration time.Duration `yaml:"interval" toml:"interval"`
	Command       string        `yaml:"cmd" toml:"cmd,multiline"`
}