spec

type ActionModel struct {
	ActionName      string    `yaml:"action"`
	ActionAliases   []string  `yaml:"aliases,flow,omitempty"`
	ActionShortDesc string    `yaml:"shortDesc"`
	ActionLongDesc  string    `yaml:"longDesc"`
	ActionMatchers  []ExpFlag `yaml:"matchers,omitempty"`
	ActionFlags     []ExpFlag `yaml:"flags,omitempty"`
	ActionExample   string    `yaml:"example"`

	ActionPrograms []string `yaml:"programs,omitempty"`
	// contains filtered or unexported fields
}

type BaseExpActionCommandSpec struct {
	ActionMatchers []ExpFlagSpec
	ActionFlags    []ExpFlagSpec
	ActionExecutor Executor
	ActionLongDesc string
	ActionExample  string
	ActionPrograms []string
}

type BaseExpModelCommandSpec struct {
	ExpScope   string
	ExpActions []ExpActionCommandSpec
	ExpFlags   []ExpFlagSpec
}

type Channel interface {
	// Run script with args and returns response that wraps the result
	Run(ctx context.Context, script, args string) *Response

	// GetScriptPath return the script path
	GetScriptPath() string
}

type CodeType struct {
	Code int32
	Msg  string
}

type Empty struct{}

type Executor interface {
	// Name is used to identify the ExpExecutor
	Name() string

	// Exec is used to execute the experiment
	Exec(uid string, ctx context.Context, model *ExpModel) *Response

	// SetChannel
	SetChannel(channel Channel)
}

type ExpActionCommandSpec interface {
	// Name returns the action name
	Name() string

	// Aliases returns command alias names
	Aliases() []string

	// ShortDesc returns short description for the action
	ShortDesc() string

	// LongDesc returns full description for the action
	LongDesc() string

	// SetLongDesc
	SetLongDesc(longDesc string)

	// Matchers returns the list of matchers supported by the action
	Matchers() []ExpFlagSpec

	// Flags returns the list of flags supported by the action
	Flags() []ExpFlagSpec

	//Example returns command example
	Example() string

	//Example returns command example
	SetExample(example string)

	// ExpExecutor returns the action command ExpExecutor
	Executor() Executor

	// SetExecutor
	SetExecutor(executor Executor)

	// Programs executed
	Programs() []string
}

type ExpCommandModel struct {
	ExpName         string          `yaml:"target"`
	ExpShortDesc    string          `yaml:"shortDesc"`
	ExpLongDesc     string          `yaml:"longDesc"`
	ExpActions      []ActionModel   `yaml:"actions"`
	ExpExecutor     Executor        `yaml:"-"`
	ExpFlags        []ExpFlag       `yaml:"flags,omitempty"`
	ExpScope        string          `yaml:"scope"`
	ExpPrepareModel ExpPrepareModel `yaml:"prepare,omitempty"`
	ExpSubTargets   []string        `yaml:"subTargets,flow,omitempty"`
}

type ExpFlag struct {
	// Name returns the flag FlagName
	Name string `yaml:"name"`

	// Desc returns the flag description
	Desc string `yaml:"desc"`

	// NoArgs means no arguments
	NoArgs bool `yaml:"noArgs"`

	// Required means necessary or not
	Required bool `yaml:"required"`
	// RequiredWhenDestroyed is true if the flag is necessary when destroying experiment
	RequiredWhenDestroyed bool `yaml:"requiredWhenDestroyed"`
}

type ExpFlagSpec interface {
	// FlagName returns the flag FlagName
	FlagName() string
	// FlagDesc returns the flag description
	FlagDesc() string
	// FlagNoArgs returns true if the flag is bool type
	FlagNoArgs() bool
	// FlagRequired returns true if the flag is necessary when creating experiment
	FlagRequired() bool
	// FlagRequiredWhenDestroyed returns true if the flag is necessary when destroying experiment
	FlagRequiredWhenDestroyed() bool
}

type ExpModel struct {
	// Target is experiment target
	Target string `json:"target,omitempty"`

	// Scope is the experiment scope
	Scope string `json:"scope,omitempty"`

	// ActionName is the experiment action FlagName, for example delay
	ActionName string `json:"action,omitempty"`

	// ActionFlags is the experiment action flags, for example time and offset
	ActionFlags map[string]string `json:"flags,omitempty"`

	// Programs
	ActionPrograms []string `json:"programs,omitempty"`
}

type ExpModelCommandSpec interface {
	// Name returns the target name
	Name() string

	// Scope returns the experiment scope
	Scope() string

	// ShortDesc returns short description for the command
	ShortDesc() string

	// LongDesc returns full description for the command
	LongDesc() string

	// Actions returns the list of actions supported by the command
	Actions() []ExpActionCommandSpec

	// Flags returns the command flags
	Flags() []ExpFlagSpec

	// SetFlags
	SetFlags(flags []ExpFlagSpec)
}

type ExpPrepareModel struct {
	PrepareType     string    `yaml:"type"`
	PrepareFlags    []ExpFlag `yaml:"flags"`
	PrepareRequired bool      `yaml:"required"`
}

type Models struct {
	Version string            `yaml:"version"`
	Kind    string            `yaml:"kind"`
	Models  []ExpCommandModel `yaml:"items"`
}

type Response struct {
	Code    int32       `json:"code"`
	Success bool        `json:"success"`
	Err     string      `json:"error,omitempty"`
	Result  interface{} `json:"result,omitempty"`
}