runner

type Collector interface {
	// Collect will read from the given io.Reader and store what was read as an
	// artifact under the given name. The number of bytes read from the given
	// io.Reader are returned, along with any errors that occur.
	Collect(string, io.Reader) (int64, error)
}

type Driver interface {
	// Each driver should implement the io.Writer interface, so that the driver
	// can write the output of what it's doing to the underlying io.Writer
	// implementation, for example os.Stdout.
	io.Writer

	// Create should create the Driver, and prepare it so it will be ready for
	// Jobs to be executed on it. It takes a context that will be used to cancel
	// out of the creation of the Driver quickly. The env slice of strings are
	// the environment variables that will be set on the driver, the strings in
	// the slice are formatted as key=value. The given Placer will be used to
	// place the given objects in the driver.
	Create(context.Context, []string, Passthrough, Placer) error

	// Execute should run the given Job on the Driver, and use the given
	// Collector, to collect any Artifacts for that Job. If the Job fails then
	// it should be marked as failed via the Failed method.
	Execute(*Job, Collector)

	// Destroy should render the driver unusable for executing Jobs, and clear
	// up any resources that may have been created via the Driver.
	Destroy()
}

type Job struct {
	io.Writer

	// Stage is the name of the Stage to which the Job belongs.
	Stage string

	// Name is the name of the Job.
	Name string

	// Commands is the list of the commands that should be executed in the
	// Driver when the Job is executed.
	Commands []string

	// Artifacts is the Passthrough that denotes how Artifacts in the Driver
	// should map to the host.
	Artifacts Passthrough

	// Status is the Status of the Job once it has completed execution.
	Status Status
	// contains filtered or unexported fields
}

type Passthrough struct {
	Values map[string]string
}

type Placer interface {
	// Place will take the object of the given name and write its contents to
	// the given io.Writer. The number of bytes written from the given
	// io.Writer are returned, along with any errors that occur.
	Place(string, io.Writer) (int64, error)

	// Stat will return the os.FileInfo of the object of the given name.
	Stat(string) (os.FileInfo, error)
}

type Runner struct {
	io.Writer

	// Env is a slice of environment variables to set during job exectuion. The
	// variables are expected to be formatted as key=value.
	Env []string

	// Objects are the files we want to place into the driver during Job
	// execution.
	Objects Passthrough

	// Placer is what to use for placing objects into the driver during Job
	// execution.
	Placer Placer

	// Collect is what to use for collecting artifacts from the driver during
	// Job execution.
	Collector Collector

	// Status is the status of the Runner was a run has been completed.
	Status Status
	// contains filtered or unexported fields
}

type Stage struct {

	// Name is the name of the Stage. Stage names are unqiue to a runner.
	Name string

	// CanFail denotes whether or not it is acceptable for a Stage to fail.
	// This is applied to each Job that is added to a Stage.
	CanFail bool
	// contains filtered or unexported fields
}

type Status uint8