progress

Documentation

Index

• func EraseAndRender(out FileWriteFlusher, r Renderer, prevNumLines int) (int, error)
• func Render(ctx context.Context, out FileWriteFlusher, r DynamicRenderer) (int, error)
• type DynamicRenderer
  • func ListeningChangeSetRenderer(streamer StackSubscriber, stackName, description string, changes []Renderer, ...) DynamicRenderer
  • func ListeningECSServiceResourceRenderer(streamer StackSubscriber, ecsDescriber stream.ECSServiceDescriber, ...) DynamicRenderer
  • func ListeningEnvControllerRenderer(conf EnvControllerConfig) DynamicRenderer
  • func ListeningResourceRenderer(streamer StackSubscriber, logicalID, description string, ...) DynamicRenderer
  • func ListeningRollingUpdateRenderer(streamer ECSServiceSubscriber, opts RenderOptions) DynamicRenderer
  • func ListeningStackRenderer(streamer StackSubscriber, stackName, description string, ...) DynamicRenderer
  • func ListeningStackSetRenderer(streamer StackSetSubscriber, title string, opts RenderOptions) DynamicRenderer
  • func MultiRenderer(renderers ...DynamicRenderer) DynamicRenderer
• type ECSServiceRendererOpts
• type ECSServiceSubscriber
• type EnvControllerConfig
• type FileWriteFlusher
• type FileWriter
• type RenderOptions
  • func NestedRenderOptions(opts RenderOptions) RenderOptions
• type Renderer
  • func LineRenderer(text string, padding int) Renderer
• type ResourceRendererOpts
• type Spinner
  • func NewSpinner(w io.Writer) *Spinner
  • func (s *Spinner) Start(label string)
  • func (s *Spinner) Stop(label string)
• type StackSetSubscriber
• type StackSubscriber
• type TabbedFileWriter
  • func NewTabbedFileWriter(fw FileWriter) *TabbedFileWriter
  • func (w *TabbedFileWriter) Write(p []byte) (n int, err error)
• type WriteFlusher

Functions

func EraseAndRender

func EraseAndRender(out FileWriteFlusher, r Renderer, prevNumLines int) (int, error)

EraseAndRender erases prevNumLines from out and then renders r.

func Render

func Render(ctx context.Context, out FileWriteFlusher, r DynamicRenderer) (int, error)

Render renders r periodically to out and returns the last number of lines written to out. Render stops when there the ctx is canceled or r is done listening to new events. While Render is executing, the terminal cursor is hidden and updates are written in-place.

Types

type DynamicRenderer

type DynamicRenderer interface {
	Renderer
	Done() <-chan struct{}
}

DynamicRenderer is a Renderer that can notify that its internal states are Done updating. DynamicRenderer is implemented by components that listen to events from a streamer and update their state.

func ListeningChangeSetRenderer

func ListeningChangeSetRenderer(streamer StackSubscriber, stackName, description string, changes []Renderer, opts RenderOptions) DynamicRenderer

ListeningChangeSetRenderer returns a component that listens for CloudFormation resource events from a stack mutated with a changeSet until the streamer stops.

func ListeningECSServiceResourceRenderer

func ListeningECSServiceResourceRenderer(streamer StackSubscriber, ecsDescriber stream.ECSServiceDescriber, logicalID, description string, opts ECSServiceRendererOpts) DynamicRenderer

ListeningECSServiceResourceRenderer is a ListeningResourceRenderer for the ECS service cloudformation resource and a ListeningRollingUpdateRenderer to render deployments.

func ListeningEnvControllerRenderer

func ListeningEnvControllerRenderer(conf EnvControllerConfig) DynamicRenderer

ListeningEnvControllerRenderer returns a component that listens and can render CloudFormation resource events from the EnvControllerAction and the environment stack.

func ListeningResourceRenderer

func ListeningResourceRenderer(streamer StackSubscriber, logicalID, description string, opts ResourceRendererOpts) DynamicRenderer

ListeningResourceRenderer returns a tab-separated component that listens for CloudFormation stack events for a particular resource.

func ListeningRollingUpdateRenderer

func ListeningRollingUpdateRenderer(streamer ECSServiceSubscriber, opts RenderOptions) DynamicRenderer

ListeningRollingUpdateRenderer renders ECS rolling update deployments.

func ListeningStackRenderer

func ListeningStackRenderer(streamer StackSubscriber, stackName, description string, resourceDescriptions map[string]string, opts RenderOptions) DynamicRenderer

ListeningStackRenderer returns a component that listens for CloudFormation resource events from a stack mutated with CreateStack or UpdateStack until the stack is completed.

func ListeningStackSetRenderer

func ListeningStackSetRenderer(streamer StackSetSubscriber, title string, opts RenderOptions) DynamicRenderer

ListeningStackSetRenderer renders a component that listens for CloudFormation stack set events until the streamer stops.

func MultiRenderer

func MultiRenderer(renderers ...DynamicRenderer) DynamicRenderer

MultiRenderer returns a Renderer that's the concatenation of the input renderers. The renderers are rendered sequentially, and the MultiRenderer is only Done once all renderers are Done.

type ECSServiceRendererOpts

type ECSServiceRendererOpts struct {
	Group      *errgroup.Group
	Ctx        context.Context
	RenderOpts RenderOptions
}

ECSServiceRendererOpts is optional configuration for a listening ECS service renderer.

type ECSServiceSubscriber

type ECSServiceSubscriber interface {
	Subscribe() <-chan stream.ECSService
}

ECSServiceSubscriber is the interface to subscribe channels to ECS service descriptions.

type EnvControllerConfig

type EnvControllerConfig struct {
	// Common configuration.
	Description string
	RenderOpts  RenderOptions

	// Env controller action configuration.
	ActionStreamer  StackSubscriber
	ActionLogicalID string

	// Env stack configuration.
	EnvStreamer     StackSubscriber
	CancelEnvStream context.CancelFunc
	EnvStackName    string
	EnvResources    map[string]string
}

EnvControllerConfig holds the required parameters to create an environment controller component.

type FileWriteFlusher

type FileWriteFlusher interface {
	FileWriter
	WriteFlusher
}

FileWriteFlusher is the interface that groups a FileWriter and WriteFlusher.

type FileWriter

type FileWriter interface {
	io.Writer
	Fd() uintptr
}

FileWriter is the interface grouping an io.Writer with the file descriptor method Fd. Files in the OS, like os.Stderr, implement the FileWriter interface.

type RenderOptions

type RenderOptions struct {
	Padding int // Leading spaces before rendering the component.
}

RenderOptions holds optional style configuration for renderers.

func NestedRenderOptions

func NestedRenderOptions(opts RenderOptions) RenderOptions

NestedRenderOptions takes a RenderOptions and returns the same RenderOptions but with additional padding.

type Renderer

type Renderer interface {
	Render(out io.Writer) (numLines int, err error)
}

Renderer is the interface to print a component to a writer. It returns the number of lines printed and the error if any.

func LineRenderer

func LineRenderer(text string, padding int) Renderer

LineRenderer returns a Renderer that can display a single line of text.

type ResourceRendererOpts

type ResourceRendererOpts struct {
	StartEvent *stream.StackEvent // Specify the starting event for the resource instead of "[not started]".
	RenderOpts RenderOptions
}

ResourceRendererOpts is optional configuration for a listening CloudFormation resource renderer.

type Spinner

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

Spinner represents an indicator that an asynchronous operation is taking place.

For short operations, less than 4 seconds, display only the spinner with the Start and Stop methods. For longer operations, display intermediate progress events using the Events method.

func NewSpinner

func NewSpinner(w io.Writer) *Spinner

NewSpinner returns a spinner that outputs to w.

func (*Spinner) Start

func (s *Spinner) Start(label string)

Start starts the spinner suffixed with a label.

func (*Spinner) Stop

func (s *Spinner) Stop(label string)

Stop stops the spinner and replaces it with a label.

type StackSetSubscriber

type StackSetSubscriber interface {
	Subscribe() <-chan stream.StackSetOpEvent
}

StackSetSubscriber is the interface to subscribe channels to a CloudFormation stack set event stream.

type StackSubscriber

type StackSubscriber interface {
	Subscribe() <-chan stream.StackEvent
}

StackSubscriber is the interface to subscribe to a CloudFormation stack event stream.

type TabbedFileWriter

type TabbedFileWriter struct {
	FileWriter
	WriteFlusher
}

TabbedFileWriter is a FileWriter that also implements the WriteFlusher interface. A TabbedFileWriter can properly align text separated by the '\t' character.

func NewTabbedFileWriter

func NewTabbedFileWriter(fw FileWriter) *TabbedFileWriter

NewTabbedFileWriter takes a file as input and returns a FileWriteFlusher that can properly write tab-separated text to it.

func (*TabbedFileWriter) Write

func (w *TabbedFileWriter) Write(p []byte) (n int, err error)

type WriteFlusher

type WriteFlusher interface {
	io.Writer
	Flush() error
}

WriteFlusher is the interface grouping an io.Writer with the Flush method. Flush allows writing buffered writes from Writer all at once.