shell

type CommandExecutor interface {
	Run(string) (*CommandResults, error)
}

type CommandGenerator struct {
	Interpreter string
	Flags       []string
	Dir         string
	Env         []string
	Timeout     *time.Duration
}

type CommandResults struct {
	ResultsContext

	// the exit status of the process
	ExitStatus uint32 `export:"exitstatus"`

	// the stdout data from the process
	Stdout string `export:"stdout"`

	// the stderr data from the process
	Stderr string `export:"stderr"`

	// the stdin data sent to the process
	Stdin string `export:"stdin"`

	State *os.ProcessState
}

type Preparer struct {
	// the shell interpreter that will be used for your scripts. `/bin/sh` is
	// used by default.
	Interpreter string `hcl:"interpreter"`

	// flags to pass to the `interpreter` binary to check validity. For
	// `/bin/sh` this is `-n`
	CheckFlags []string `hcl:"check_flags"`

	// flags to pass to the interpreter at execution time
	ExecFlags []string `hcl:"exec_flags"`

	// the script to run to check if a resource needs to be changed. It should
	// exit with exit code 0 if the resource does not need to be changed, and
	// 1 (or above) otherwise.
	Check string `hcl:"check" nonempty:"true"`

	// the script to run to apply the resource. Normal shell exit code
	// expectations apply (that is, exit code 0 for success, 1 or above for
	// failure.)
	Apply string `hcl:"apply" nonempty:"true"`

	// the amount of time the command will wait before halting forcefully.
	Timeout *time.Duration `hcl:"timeout"`

	// the working directory this command should be run in
	Dir string `hcl:"dir"`

	// any environment variables that should be passed to the command
	Env map[string]string `hcl:"env"`
}

type ResultsContext struct {
	Operation string
	Next      *CommandResults
	Prev      *CommandResults
}

type Shell struct {
	CmdGenerator CommandExecutor

	// the check statement
	CheckStmt string `export:"check"`

	// the apply statement
	ApplyStmt string `export:"apply"`

	// the working directory of the task
	Dir string `export:"dir"`

	// environment variables configured for the task
	Env []string `export:"env"`

	// the status of the task
	Status *CommandResults `re-export-as:"status"`

	// the status of the check phase
	CheckStatus *CommandResults `export:"checkstatus"`

	// the status of the health check
	HealthStatus *resource.HealthStatus `export:"healthstatus"`
	// contains filtered or unexported fields
}