cli

Documentation

Index

• Constants
• func RunCaptureWithArgs(cmd Executable, args []string, env map[string]string) (stdout, stderr string, err error)
• func RunWithArgs(cmd Executable, args []string, env map[string]string) error
• func WriteDemoConfig(vals map[string]string) (string, error)
• type Executable
• type Executor
  • func PrepareBaseCmd(cmd *cobra.Command, envPrefix, defautRoot string) Executor
  • func (e Executor) Execute() error
• type ExitCoder

Constants

const (
	RootFlag     = "root"
	HomeFlag     = "home"
	TraceFlag    = "trace"
	OutputFlag   = "output"
	EncodingFlag = "encoding"
)

Functions

func RunCaptureWithArgs

func RunCaptureWithArgs(cmd Executable, args []string, env map[string]string) (stdout, stderr string, err error)

RunCaptureWithArgs executes the given command with the specified command line args and environmental variables set. It returns string fields representing output written to stdout and stderr, additionally any error from cmd.Execute() is also returned

func RunWithArgs

func RunWithArgs(cmd Executable, args []string, env map[string]string) error

RunWithArgs executes the given command with the specified command line args and environmental variables set. It returns any error returned from cmd.Execute()

func WriteDemoConfig

func WriteDemoConfig(vals map[string]string) (string, error)

WriteDemoConfig writes a toml file with the given values. It returns the RootDir the config.toml file is stored in, or an error if writing was impossible

Types

type Executable

type Executable interface {
	Execute() error
}

Executable is the minimal interface to *corba.Command, so we can wrap if desired before the test

type Executor

type Executor struct {
	*cobra.Command
	Exit func(int) // this is os.Exit by default, override in tests
}

Executor wraps the cobra Command with a nicer Execute method

func PrepareBaseCmd

func PrepareBaseCmd(cmd *cobra.Command, envPrefix, defautRoot string) Executor

PrepareBaseCmd is meant for tendermint and other servers

func (Executor) Execute

func (e Executor) Execute() error

execute adds all child commands to the root command sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

type ExitCoder

type ExitCoder interface {
	ExitCode() int
}