step

type BufferedStreams ¶

type BufferedStreams struct {
	StdoutBuf bytes.Buffer
	StderrBuf bytes.Buffer
}

BufferedStreams provides an implementation of OutStreams that stores all writes to underlying bytes.Buffer objects.

func (s *BufferedStreams) Stderr() io.Writer

func (s *BufferedStreams) Stdout() io.Writer

type LogStdStreams ¶

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

LogStdStreams is a type of OutStreams that writes to both a stdout/stderr and a log file. Writing to stdout/stderr will also write to the log file. When verbose is false the streams are "not" written to stdout/stderr to match the behavior of the Hub streams.

func NewLogStdStreams(verbose bool) *LogStdStreams

func (s *LogStdStreams) Stderr() io.Writer

func (s *LogStdStreams) Stdout() io.Writer

type OutStreams ¶

type OutStreams interface {
	Stdout() io.Writer
	Stderr() io.Writer
}

type PrettyStatus ¶

type PrettyStatus struct {
	idl.Status
}

PrettyStatus exists only to write a string description of idl.Status to the JSON representation, instead of an integer.

func (p PrettyStatus) MarshalText() ([]byte, error)

func (p *PrettyStatus) UnmarshalText(buf []byte) error

type Step ¶

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

func Begin(step idl.Step, sender idl.MessageSender) (*Step, error)

func New(name idl.Step, sender idl.MessageSender, substepStore SubstepStore, streams OutStreams) *Step

func (s *Step) AlwaysRun(substep idl.Substep, f func(OutStreams) error)

func (s *Step) Err() error

func (s *Step) Run(substep idl.Substep, f func(OutStreams) error)

func (s *Step) RunConditionally(substep idl.Substep, shouldRun bool, f func(OutStreams) error)

func (s *Step) Streams() OutStreams

type SubstepFileStore ¶

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

SubstepFileStore implements SubstepStore by providing persistent storage on disk.

func NewSubstepFileStore() (*SubstepFileStore, error)

func NewSubstepStoreUsingFile(path string) *SubstepFileStore

func (f *SubstepFileStore) Read(step idl.Step, substep idl.Substep) (idl.Status, error)

func (f *SubstepFileStore) ReadStep(step idl.Step) (map[string]PrettyStatus, error)

func (f *SubstepFileStore) Write(step idl.Step, substep idl.Substep, status idl.Status) (err error)

type SubstepStore ¶

type SubstepStore interface {
	Read(idl.Step, idl.Substep) (idl.Status, error)
	Write(idl.Step, idl.Substep, idl.Status) error
}