cli

Documentation

Overview

Package cli contains utilities to work with IO streams.

Index

• Variables
• func Run(fn func() error)
• type IOStreams
  • func NewTestIOStreams() (streams IOStreams, in *bytes.Buffer, out *bytes.Buffer, errOut *bytes.Buffer)

Variables

var DefaultIOStreams = IOStreams{
	In:     os.Stdin,
	Out:    os.Stdout,
	ErrOut: os.Stderr,
}

DefaultIOStreams provides the default streams for os.Stdin, os.Stdout and os.Stderr.

Functions

func Run

func Run(fn func() error)

Run runs fn and handles returned errors by exiting the program with a suitable exit code.

Types

type IOStreams

type IOStreams struct {
	In     io.Reader
	Out    io.Writer
	ErrOut io.Writer
}

IOStreams is a holder for input and output streams. Commands should use this instead of directly relying on os.Stdin, os.Stdout and os.Stderr to make it possible to replace the streams in tests.

func NewTestIOStreams

func NewTestIOStreams() (streams IOStreams, in *bytes.Buffer, out *bytes.Buffer, errOut *bytes.Buffer)

NewTestIOStreams provides IOStreams that use a *bytes.Buffer. This can be used in tests to make assertions on command output as well as control the input stream. Returns IOStreams and *bytes.Buffer for in, out and errOut.