entity

type AffixMappig struct {
	TargetName     string
	AffixedNetwork string
	CommandName    string
}

type ArgParserFacade interface {
	Parse(conf *Supfile, initialArgs *InitialArgs, helpMenu HelpDisplayer) (*PlayBook, error)
}

type ClientFacade interface {
	GetConnection() *ssh.Client
	GetSSHConfig() *ssh.ClientConfig
	Connect(host NetworkHost) error
	SetConnection(*ssh.Client)
	Run(task *Task) error
	Wait() error
	Close() error
	Prefix() (string, int)
	Write(p []byte) (n int, err error)
	WriteClose() error
	Stdin() io.WriteCloser
	Stderr() io.Reader
	Stdout() io.Reader
	Signal(os.Signal) error
	Upload(src string, dest string) error
	Download(src string, dest string, silent bool) error
	GenerateOnRemote(data []byte, dest string) error
	GetHost() string
	GetTube() string
	SetTube(name string)
	GetInventory() *Inventory
	GetShell() string
}

type Command struct {
	Name   string    `yaml:"-"`      // Command name.
	Desc   string    `yaml:"desc"`   // Command description.
	Local  string    `yaml:"local"`  // Command(s) to be run locally.
	Run    string    `yaml:"run"`    // Command(s) to be run remotelly.
	Script string    `yaml:"script"` // Load command(s) from script and run it remotelly.
	Upload []*Upload `yaml:"upload"` // See Upload struct.
	// Copy     *CopyOrder  `yaml:"copy"`   // See Upload struct.
	Stdin    bool        `yaml:"stdin"`  // Attach localhost STDOUT to remote commands' STDIN?
	Once     bool        `yaml:"once"`   // The command should be run "once" (on one host only).
	Serial   int         `yaml:"serial"` // Max number of clients processing a task in parallel.
	Fetch    *FetchOrder `yaml:"fetch" ` // See Fetch struct.
	Sudo     bool        `yaml:"sudo" `  // Run command(s) as root?
	SudoPass string      `yaml:"sudo_pass"`
	Env      EnvList     `yaml:"env"`

	// API backward compatibility. Will be deprecated in v1.0.
	RunOnce bool `yaml:"run_once"` // The command should be run once only.
}

type Commands struct {
	Names []string
	Cmds  map[string]Command
}

type ConnectOrder struct {
	Host         string // will contain ip:port
	ClientConfig *ssh.ClientConfig
}

type CopyOrder struct {
	Src string `yaml:"src"`
	Dst string `yaml:"dst"`
}

type EnvList struct {
	// contains filtered or unexported fields
}

type EnvVar struct {
	Key   string
	Value string
}

type ErrMustUpdate struct {
	Msg string
}

type ErrTask struct {
	Task   *Task
	Reason string
}

type ErrUnsupportedSupfileVersion struct {
	Msg string
}

type FetchOrder struct {
	Host string `yaml:"host"`
	Src  string `yaml:"src"`
	Dst  string `yaml:"dst"`
}

type FlagStringSlice []string

type HelpDisplayer struct {
	ShowNetwork bool
	ShowCmd     bool
	// ShowTarget   bool
	ShowMakeMode bool
	Color        bool
}

type HostNamespace struct {
	EnvStore map[string]string
}

type InitState struct {
	Conf        *Supfile
	InitialArgs *InitialArgs
}

type InitialArgs struct {
	Supfile     string
	EnvVars     FlagStringSlice
	SshConfig   string
	OnlyHosts   string
	ExceptHosts string

	Debug         bool
	DisablePrefix bool

	ShowVersion  bool
	ShowExample  bool
	ShowHelp     bool
	DisableColor bool
	CommandArgs  []string
}

type Inventory struct {
	Bash    bool
	Sh      bool
	Arch    string
	Home    string
	User    string
	OsType  string
	IsLocal bool
}

type Network struct {
	Env       EnvList       `yaml:"env"`
	Inventory string        `yaml:"inventory"`
	Hosts     []NetworkHost `yaml:"hosts"`
	Bastion   string        `yaml:"bastion"` // Jump host for the environment

	// Should these live on Hosts too? We'd have to change []string to struct, even in Supfile.
	User         string `yaml:"user"`
	Password     string `yaml:"pass" `
	IdentityFile string `yaml:"id_file"`
	Name         string
}

type NetworkHost struct {
	Host     string  `yaml:"host"`
	User     string  `yaml:"user"`
	Password string  `yaml:"pass"`
	Tube     string  `yaml:"tube"`
	Env      EnvList `yaml:"env"`
	Sudo     bool    `yaml:"sudo" default:"false"`
}

type Networks struct {
	Names []string
	Nets  map[string]Network
}

type Play struct {
	Network  *Network
	Commands []*Command
}

type PlayBook struct {
	// contains filtered or unexported fields
}

type ShellCheckFacade interface {
	Check(cmd string, cmdName string) error
	AddNumbers(data []byte) []byte
}

type Supfile struct {
	Networks Networks `yaml:"networks"`
	Commands Commands `yaml:"commands"`
	Targets  Targets  `yaml:"targets"`
	Env      EnvList  `yaml:"env"`
	Version  string   `yaml:"version"`
	Desc     string   `yaml:"desc"`
}

type Targets struct {
	Names []string
	// contains filtered or unexported fields
}

type Task struct {
	Run     string
	Input   io.Reader
	Clients []ClientFacade
	TTY     bool
	Sudo    bool `yaml:"sudo" default:"false"`
	Env     EnvList
}

type Upload struct {
	Src string `yaml:"src"`
	Dst string `yaml:"dst"`
	Exc string `yaml:"exclude"`
}