commands

type CMDRunnerOptions struct {
	// RunAsAdmin : True to run commands as admin
	RunAsAdmin bool
}

type Command struct {
	// Cmd : command string
	Cmd string
	// GetOutput : get output of command
	GetOutput bool
	// ForceNoSudo : force the command to not be run with sudo
	ForceNoSudo bool
	// IgnoreTerminal : command can be executed without using a terminal, useful for windows
	IgnoreTerminal bool
}

type CommandRunner interface {
	BuildDockerComposeUpCMD(options DockerComposeUpOptions) Command

	BuildDockerComposePullCMD(options DockerComposePullOptions) Command

	BuildDockerComposeCreateCMD(options DockerComposeCreateOptions) Command

	BuildDockerComposeBuildCMD(options DockerComposeBuildOptions) Command

	BuildDockerPSCMD(options DockerPSOptions) Command

	BuildDockerComposePSCMD(options DockerComposePsOptions) Command

	BuildDockerComposeLogsCMD(options DockerComposeLogsOptions) Command

	BuildDockerComposeVersionCMD() Command

	BuildDockerBuildCMD(options DockerBuildOptions) Command

	BuildDockerPullCMD(options DockerBuildOptions) Command

	BuildDockerInspectCMD(options DockerInspectOptions) Command

	BuildDockerComposeDownCMD(options DockerComposeDownOptions) Command

	BuildCreateFileCMD(options CreateFileOptions) Command

	BuildEchoToFileCMD(options EchoToFileOptions) Command

	BuildOpenTextEditor(options OpenTextEditorOptions) Command

	RunCMD(cmd Command) (string, int, error)

	RunScript(script ScriptFile) (string, error)
}

type CreateFileOptions struct {
	// FileName : path to file
	FileName string
}

type DockerBuildOptions struct {
	// Path : path to dockerfile
	Path string
	// Tag : docker build --tag tag
	Tag string
	// Args : docker --build-arg tags
	Args map[string]string
}

type DockerComposeBuildOptions struct {
	// Path to the docker-compose.yaml
	Path string
	// Services names
	Services []string
}

type DockerComposeCreateOptions struct {
	// Path to the docker-compose.yaml
	Path string
	// Services names
	Services []string
}

type DockerComposeDownOptions struct {
	// Path : path to docker-compose.yaml
	Path string
}

type DockerComposeLogsOptions struct {
	// Path : path to docker-compose.yaml
	Path string
	// Services : services names
	Services []string
	// Follow : use with --follow
	Follow bool
	// Tail : if greater than 0 and Follow is False used for --tail
	Tail int
}

type DockerComposePsOptions struct {
	// Path : path to docker-compose.yaml
	Path string
	// Services : use with --services to display services
	Services bool
	// Quiet : use with --quiet to display only IDs
	Quiet bool
	// ServiceName: Service argument
	ServiceName string
	// FilterRunning : use with --filter status=running
	FilterRunning bool
}

type DockerComposePullOptions struct {
	// Path to the docker-compose.yaml
	Path string
	// Services names
	Services []string
}

type DockerComposeUpOptions struct {
	// Path : path to docker-compose.yaml
	Path string
	// Services : services names
	Services []string
}

type DockerInspectOptions struct {
	// Name : docker object name
	Name string
	// Format : Go template for --format flag
	Format string
}

type DockerPSOptions struct {
	// All : use with --all
	All bool
}

type EchoToFileOptions struct {
	// FileName : path to file
	FileName string
	// Content : content to be written to file
	Content string
}

type OpenTextEditorOptions struct {
	// FilePath path to the file to open
	FilePath string
}

type ScriptFile struct {
	// Tmp : script template
	Tmp *template.Template
	// getOutput : get output of the script
	GetOutput bool
	// Data: template data object
	Data interface{}
}

type UnixCMDRunner struct {
	RunWithSudo bool
}