command

Documentation

Index

• func NewTestConfigFn(cfgFile string, logFile string) func() *TestConfig
• type Command
  • func New[T config.Config](cli string, short string, long string, noargs bool, ...) *Command[T]
  • func (c *Command[T]) Execute(ctx context.Context, commandType Type) int
• type SetupCommand
• type TestCommandHarness
  • func NewTestCommandHarness(t *testing.T, fn testCommandFn) *TestCommandHarness
  • func (h *TestCommandHarness) Execute(ctx context.Context, args []string) int
  • func (h *TestCommandHarness) Stderr() string
  • func (h *TestCommandHarness) Stdout() string
• type TestConfig
  • func (c *TestConfig) DefaultConfigDir() (string, error)
  • func (c *TestConfig) DefaultConfigFile() string
  • func (c *TestConfig) DefaultLogDir() (string, error)
  • func (c *TestConfig) DefaultLogFile() string
  • func (c *TestConfig) GetConfigFile() string
  • func (c *TestConfig) GetLogFile() string
  • func (_ *TestConfig) GlobalRequiredFlags(cmd *cobra.Command) error
  • func (_ *TestConfig) RootPersistentFlags(flags *pflag.FlagSet)
  • func (c *TestConfig) SetConfigFile(cfg string)
  • func (c *TestConfig) SetLogFile(l string)
  • func (_ *TestConfig) Validate() error
• type Type

Functions

func NewTestConfigFn

func NewTestConfigFn(cfgFile string, logFile string) func() *TestConfig

Types

type Command

type Command[T config.Config] struct {
	// contains filtered or unexported fields
}

func New

func New[T config.Config](cli string, short string, long string, noargs bool, version *version.Version[T], newConfig config.New[T], setupCommands []SetupCommand[T]) *Command[T]

func (*Command[T]) Execute

func (c *Command[T]) Execute(ctx context.Context, commandType Type) int

type SetupCommand

type SetupCommand[T config.Config] func(cmd *cobra.Command, ch *cmdutils.Helper[T])

type TestCommandHarness

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

func NewTestCommandHarness

func NewTestCommandHarness(t *testing.T, fn testCommandFn) *TestCommandHarness

func (*TestCommandHarness) Execute

func (h *TestCommandHarness) Execute(ctx context.Context, args []string) int

func (*TestCommandHarness) Stderr

func (h *TestCommandHarness) Stderr() string

func (*TestCommandHarness) Stdout

func (h *TestCommandHarness) Stdout() string

type TestConfig

type TestConfig struct {

	// Common configuration values.
	Format  string
	Debug   bool
	NoColor bool `mapstructure:"no-color"`
	// contains filtered or unexported fields
}

func (*TestConfig) DefaultConfigDir

func (c *TestConfig) DefaultConfigDir() (string, error)

func (*TestConfig) DefaultConfigFile

func (c *TestConfig) DefaultConfigFile() string

func (*TestConfig) DefaultLogDir

func (c *TestConfig) DefaultLogDir() (string, error)

func (*TestConfig) DefaultLogFile

func (c *TestConfig) DefaultLogFile() string

func (*TestConfig) GetConfigFile

func (c *TestConfig) GetConfigFile() string

func (*TestConfig) GetLogFile

func (c *TestConfig) GetLogFile() string

func (*TestConfig) GlobalRequiredFlags

func (_ *TestConfig) GlobalRequiredFlags(cmd *cobra.Command) error

func (*TestConfig) RootPersistentFlags

func (_ *TestConfig) RootPersistentFlags(flags *pflag.FlagSet)

func (*TestConfig) SetConfigFile

func (c *TestConfig) SetConfigFile(cfg string)

func (*TestConfig) SetLogFile

func (c *TestConfig) SetLogFile(l string)

func (*TestConfig) Validate

func (_ *TestConfig) Validate() error

type Type

type Type int

const (
	Interactive Type = iota
	Noninteractive
)