runtime

type Archiver interface {
	Archive(srcPath string, preservePath bool) error
	Close()
}

type Client struct {
	// Config contains the runtime configuration for the application
	Config *config.Config

	// Executor is the task invoker
	Executor *Executor
}

type EventHandler interface {
	// Register a task with the handler
	Register(task *Task)
	// Unregister a task from the handler
	Unregister(task *Task)
	// OnEvent is invoked by a task when execution state changes
	OnEvent(task *Task, e TaskEvent)
	// Close the handler
	Close()
	// AddRuntimeData makes realtime statistics available to the handler
	AddRuntimeData(data *TaskStatistics)
}

type Executor struct {
	// Environment is a mapping of all environment variables passed to each task on execution (except parallel tasks)
	Environment map[string]string

	// Tasks is a list of all Task objects that will be invoked
	Tasks []*Task

	// Statistics contains runtime statistics of all planned tasks
	Statistics *TaskStatistics
	// contains filtered or unexported fields
}

type Task struct {
	Id uuid.UUID

	// Config is the user-defined values parsed from the run yaml
	Config config.TaskConfig

	Options *config.Options

	// Command represents all non-Config items used to Execute and track task progress
	Command command

	// Children is a list of all sub-Tasks that should be run concurrently
	Children []*Task

	// TaskStatus is the last known TaskStatus value that represents the entire list of child commands
	Status TaskStatus

	// Started indicates whether the Task has been attempted to run
	Started bool

	// Completed indicates whether the Task has been finished execution
	Completed bool

	// FailedChildren is a list of Tasks with a non-zero return value
	FailedChildren int
	// contains filtered or unexported fields
}

type TaskEvent struct {
	// Task is the task which the command was run from
	Task *Task

	// Status is the current pending/running/error/success TaskStatus of the command
	Status TaskStatus

	// Stdout is a single line from standard out (optional)
	Stdout string

	// Stderr is a single line from standard error (optional)
	Stderr string

	// Completed indicates if the command has exited
	Complete bool

	// todo: remove return code from an event
	// ReturnCode is the sub-process return code value upon completion
	ReturnCode int
}

type TaskStatistics struct {
	// Failed is a list of Task objects with non-zero return codes upon invocation
	Failed []*Task

	// Running indicates the number of actively running Tasks
	Running int

	// Completed is a list of Task objects that have been invoked (regardless of the return code value)
	Completed []*Task

	// Total indicates the number of tasks that can be run (Note: this is not necessarily the same number of tasks planned to be run)
	Total int
}

type TaskStatus int32