command

Documentation

Index

• Variables
• func Confirm(msg string) bool
• func ConfirmContinue(target string, ids ...int64) bool
• func FlattenErrors(errors []error) error
• func FlattenErrorsWithPrefix(errors []error, pref string) error
• func GetParamTemplateValue(o InputOption) (string, error)
• func IsEmpty(object interface{}) bool
• func StringIDs(ids []int64) []string
• func UniqIDs(elements []int64) []int64
• func ValidateBetween(fieldName string, object interface{}, min int, max int) []error
• func ValidateConflictValues(fieldName string, object interface{}, values map[string]interface{}) []error
• func ValidateConflicts(fieldName string, object interface{}, values map[string]interface{}) []error
• func ValidateIPv4Address(fieldName string, object interface{}) []error
• func ValidateIPv6Address(fieldName string, object interface{}) []error
• func ValidateInStrValues(fieldName string, object interface{}, allowValues ...string) []error
• func ValidateInputOption(o InputOption) []error
• func ValidateOutputOption(o output.Option) []error
• func ValidateRequired(fieldName string, object interface{}) []error
• func ValidateSakuraID(fieldName string, object interface{}) []error
• func ValidateSetProhibited(fieldName string, object interface{}) []error
• type Context
  • func NewContext(flagContext FlagContext, args []string, formater interface{}) Context
• type FlagContext
• type InputOption
• type Option
  • func (o *Option) Validate(skipAuth bool) []error
• type OutputTypeHolder

Variables

var (
	DefaultZone       = "tk1a"
	DefaultOutputType = "table"
)

var GlobalFlags = []cli.Flag{
	&cli.StringFlag{
		Name:        "token",
		Usage:       "API Token of SakuraCloud",
		EnvVars:     []string{"SAKURACLOUD_ACCESS_TOKEN"},
		DefaultText: "none",
		Destination: &GlobalOption.AccessToken,
	},
	&cli.StringFlag{
		Name:        "secret",
		Usage:       "API Secret of SakuraCloud",
		EnvVars:     []string{"SAKURACLOUD_ACCESS_TOKEN_SECRET"},
		DefaultText: "none",
		Destination: &GlobalOption.AccessTokenSecret,
	},
	&cli.StringFlag{
		Name:        "zone",
		Usage:       "Target zone of SakuraCloud",
		EnvVars:     []string{"SAKURACLOUD_ZONE"},
		Value:       DefaultZone,
		DefaultText: DefaultZone,
		Destination: &GlobalOption.Zone,
	},
	&cli.StringFlag{
		Name:        "config",
		Aliases:     []string{"profile"},
		Usage:       "Config(Profile) name",
		EnvVars:     []string{"USACLOUD_PROFILE"},
		Destination: &GlobalOption.ProfileName,
	},
	&cli.StringFlag{
		Name:        "api-root-url",
		Hidden:      true,
		EnvVars:     []string{"USACLOUD_API_ROOT_URL"},
		Destination: &GlobalOption.APIRootURL,
	},
	&cli.StringFlag{
		Name:        "default-output-type",
		EnvVars:     []string{"USACLOUD_DEFAULT_OUTPUT_TYPE"},
		Destination: &GlobalOption.DefaultOutputType,
		Value:       DefaultOutputType,
		Hidden:      true,
	},
	&cli.StringSliceFlag{
		Name:   "zones",
		Hidden: true,
	},
	&cli.BoolFlag{
		Name:        "trace",
		Usage:       "Flag of SakuraCloud debug-mode",
		EnvVars:     []string{"SAKURACLOUD_TRACE_MODE"},
		Destination: &GlobalOption.TraceMode,
		Value:       false,
		Hidden:      true,
	},
}

var GlobalOption = &Option{
	In:       os.Stdin,
	Out:      colorable.NewColorableStdout(),
	Progress: colorable.NewColorableStderr(),
	Err:      colorable.NewColorableStderr(),
}

Functions

func Confirm

func Confirm(msg string) bool

func ConfirmContinue

func ConfirmContinue(target string, ids ...int64) bool

func FlattenErrors

func FlattenErrors(errors []error) error

func FlattenErrorsWithPrefix

func FlattenErrorsWithPrefix(errors []error, pref string) error

func GetParamTemplateValue

func GetParamTemplateValue(o InputOption) (string, error)

func IsEmpty

func IsEmpty(object interface{}) bool

IsEmpty is copied from github.com/stretchr/testify/assert/assetions.go

func StringIDs

func StringIDs(ids []int64) []string

func UniqIDs

func UniqIDs(elements []int64) []int64

func ValidateBetween

func ValidateBetween(fieldName string, object interface{}, min int, max int) []error

func ValidateConflictValues

func ValidateConflictValues(fieldName string, object interface{}, values map[string]interface{}) []error

func ValidateConflicts

func ValidateConflicts(fieldName string, object interface{}, values map[string]interface{}) []error

func ValidateIPv4Address

func ValidateIPv4Address(fieldName string, object interface{}) []error

func ValidateIPv6Address

func ValidateIPv6Address(fieldName string, object interface{}) []error

func ValidateInStrValues

func ValidateInStrValues(fieldName string, object interface{}, allowValues ...string) []error

func ValidateInputOption

func ValidateInputOption(o InputOption) []error

func ValidateOutputOption

func ValidateOutputOption(o output.Option) []error

func ValidateRequired

func ValidateRequired(fieldName string, object interface{}) []error

func ValidateSakuraID

func ValidateSakuraID(fieldName string, object interface{}) []error

func ValidateSetProhibited

func ValidateSetProhibited(fieldName string, object interface{}) []error

Types

type Context

type Context interface {
	GetOutput() output.Output
	GetAPIClient() *api.Client
	Args() []string
	NArgs() int
	FlagContext
}

func NewContext

func NewContext(flagContext FlagContext, args []string, formater interface{}) Context

type FlagContext

type FlagContext interface {
	IsSet(name string) bool
}

type InputOption

type InputOption interface {
	GetParamTemplate() string
	GetParamTemplateFile() string
}

type Option

type Option struct {
	AccessToken       string
	AccessTokenSecret string
	Zone              string
	ProfileName       string
	Zones             []string
	APIRootURL        string
	TraceMode         bool
	Format            string
	DefaultOutputType string
	In                io.Reader
	Out               io.Writer
	Progress          io.Writer
	Err               io.Writer
	Validated         bool
	Valid             bool
	ValidationResults []error
}

func (*Option) Validate

func (o *Option) Validate(skipAuth bool) []error

type OutputTypeHolder

type OutputTypeHolder interface {
	GetOutputType() string
	SetOutputType(string)
}