ss

package
v0.7.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 16, 2024 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	CMD_NAME_DUPLICATE  = "duplicate"
	StashKeyTmpDupApp   = "_tmp_dup_app"
	StashKeyDupAppOwner = "_dup_app_owner_domain_id"
)
View Source 
const (
	CMD_NAME_REPORT = "report"

	StashKeyReportFolder = "_report_folder"
	StashKeyReportName   = "_report_name"
	StashKeyReportResult = "_report_result"
)
View Source 
const CMD_NAME_APPLY_BM = "apply_bm"
View Source 
const CMD_NAME_CLEAR_ALL = "clear_all"
View Source 
const (
	CMD_NAME_DEL_APP = "del_app"
)
View Source 
const CMD_NAME_DEL_FILE = "del_file"
View Source 
const CMD_NAME_MOVE_FILE = "move_file"
View Source 
const CMD_NAME_SELECT = "select"
View Source 
const CMD_NAME_SET_VAR = "set_var"

Variables

This section is empty.

Functions

func RegisterNewTask 

func RegisterNewTask(cmdName string, creator TaskRunnerCreator)

Types

type ApplyBMTask 

type ApplyBMTask struct {
	*CmdTaskBase
	BmTitle string
}

func (*ApplyBMTask) Run 

func (t *ApplyBMTask) Run() *util.Result

type ClearAllTask 

type ClearAllTask struct {
	*CmdTaskBase
}

func (*ClearAllTask) Run 

func (t *ClearAllTask) Run() *util.Result

type CmdTaskBase 

type CmdTaskBase struct {
	Script *Script
	Def    *FuncCmdDef
	Name   string
	Logger *zerolog.Logger
}

func NewCmdTaskBase 

func NewCmdTaskBase(s *Script, d *FuncCmdDef, n string) *CmdTaskBase

func (CmdTaskBase) LogCurrentSelection 

func (b CmdTaskBase) LogCurrentSelection()

func (CmdTaskBase) Validate 

func (b CmdTaskBase) Validate() *util.Result

type Del_AppTask added in v0.6.0 

type Del_AppTask struct {
	*CmdTaskBase
	AppId string
}

func (*Del_AppTask) Run added in v0.6.0 

func (t *Del_AppTask) Run() *util.Result

type Del_FileTask added in v0.6.0 

type Del_FileTask struct {
	*CmdTaskBase
	FilePath string
}

func (*Del_FileTask) Run added in v0.6.0 

func (t *Del_FileTask) Run() *util.Result

type DuplicateTask added in v0.5.1 

type DuplicateTask struct {
	*CmdTaskBase
	AppId      string
	NewAppName string
}

func (*DuplicateTask) Run added in v0.5.1 

func (t *DuplicateTask) Run() *util.Result

type ExecEnv 

type ExecEnv struct {
	EngineConn *engine.Conn
	Doc        *enigma.Doc
	QrsClient  *qrs.Client
	AppID      string
	Log        *zerolog.Logger `json:"-"`

	DeferTasks []TaskRunner
	// contains filtered or unexported fields
}

func NewExecEnv 

func NewExecEnv(cfg *engine.Config, appid string, logger *zerolog.Logger, opts ...ExecEnvOption) (*ExecEnv, *util.Result)

NewExecEnv Note: please call CleanUp() afterwards to close engine connection properly. Script.Run() calls CleanUp() automatically

func (*ExecEnv) CleanUp 

func (env *ExecEnv) CleanUp()

func (*ExecEnv) CreateLogger 

func (env *ExecEnv) CreateLogger() error

func (*ExecEnv) Defer added in v0.6.0 

func (env *ExecEnv) Defer(t TaskRunner)

func (*ExecEnv) DeleteStash added in v0.6.0 

func (env *ExecEnv) DeleteStash(key string)

func (*ExecEnv) GetBookmarkMap 

func (env *ExecEnv) GetBookmarkMap() *util.Result

func (*ExecEnv) GetDimensionByName added in v0.4.1 

func (env *ExecEnv) GetDimensionByName(name string) (*engine.SessionDimensionLayout, bool)

func (*ExecEnv) GetMasterItemsMap added in v0.4.0 

func (env *ExecEnv) GetMasterItemsMap() *util.Result

func (*ExecEnv) GetMeasureByName added in v0.4.1 

func (env *ExecEnv) GetMeasureByName(name string) (*engine.SessionMeasureLayout, bool)

func (*ExecEnv) HasBookmark 

func (env *ExecEnv) HasBookmark(title string) bool

func (*ExecEnv) LogErr 

func (env *ExecEnv) LogErr(ctx string, err error) error

func (*ExecEnv) LogErrMsg 

func (env *ExecEnv) LogErrMsg(ctx, msg string) error

func (*ExecEnv) LogErrorResult 

func (env *ExecEnv) LogErrorResult(res *util.Result) error

func (*ExecEnv) Logger 

func (env *ExecEnv) Logger() *zerolog.Logger

func (*ExecEnv) OpenDoc added in v0.6.0 

func (env *ExecEnv) OpenDoc(appid string) *util.Result

func (*ExecEnv) Stash added in v0.5.1 

func (env *ExecEnv) Stash(key string, v interface{})

func (*ExecEnv) SyncBookmark 

func (env *ExecEnv) SyncBookmark(title string) (bool, *util.Result)

func (*ExecEnv) Unstash added in v0.5.1 

func (env *ExecEnv) Unstash(key string) (interface{}, bool)

func (*ExecEnv) UnstashString added in v0.6.0 

func (env *ExecEnv) UnstashString(key string) (string, bool)

type ExecEnvOption added in v0.5.1 

type ExecEnvOption func(env *ExecEnv) *ExecEnv

func WithQrsClient added in v0.5.1 

func WithQrsClient(c *qrs.Client) ExecEnvOption

type FuncCmdBase 

type FuncCmdBase struct {
	MetaInfo `json:",inline" yaml:",inline"`

	Def *FuncCmdDef `json:"def,omitempty" yaml:"def,omitempty"`
	Env *ExecEnv    `json:"env,omitempty" yaml:"env,omitempty"`
}

TODO: remove FuncCmdBase and use MetaInfo directly

type FuncCmdDef 

type FuncCmdDef struct {
	Cmd         string               `json:"cmd,omitempty" yaml:"cmd,omitempty"`
	Target      string               `json:"target,omitempty" yaml:"target,omitempty"`
	Args        []string             `json:"args,omitempty" yaml:"args,omitempty"`
	FieldValues []*enigma.FieldValue `json:"field_values,omitempty" yaml:"field_values,omitempty"`
	Report      *report.Report       `json:"report,omitempty" yaml:"report,omitempty"`
}

type IFuncCmd 

type IFuncCmd interface {
	Exec() *util.Result
}

type MetaInfo 

type MetaInfo struct {
	ID          string `json:"id,omitempty" yaml:"id,omitempty"`
	Name        string `json:"name,omitempty" yaml:"name,omitempty"`
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
}

type Move_FileTask added in v0.6.0 

type Move_FileTask struct {
	*CmdTaskBase
	SrcPath string
	TgtPath string
}

func (*Move_FileTask) Run added in v0.6.0 

func (t *Move_FileTask) Run() *util.Result

type ReportTask added in v0.5.1 

type ReportTask struct {
	*CmdTaskBase

	Report report.Report
}

func (*ReportTask) Run added in v0.5.1 

func (t *ReportTask) Run() *util.Result

type Request 

type Request struct {
	Id     string
	Script *Script
	Tasks  []TaskRunner
}

func (*Request) ID 

func (r *Request) ID() string

func (*Request) Logger 

func (r *Request) Logger() *zerolog.Logger

func (*Request) Name 

func (r *Request) Name() string

func (*Request) Run 

func (r *Request) Run() (bool, []*util.Result)

type Script 

type Script struct {
	FuncCmdBase `json:",inline" yaml:",inline"`
	AppID       *string       `json:"app_id,omitempty" yaml:"app_id,omitempty"`
	Setup       []*FuncCmdDef `json:"setup,omitempty" yaml:"setup,omitempty"`
	Steps       []*ScriptStep `json:"steps,omitempty" yaml:"steps,omitempty"`
	Cleanup     []*FuncCmdDef `json:"cleanup,omitempty" yaml:"cleanup,omitempty"`
}

func (*Script) CreateExecEnv 

func (ts *Script) CreateExecEnv(cfg *engine.Config, logger *zerolog.Logger, opts ...ExecEnvOption) *util.Result

func (*Script) GenerateTaskRunners 

func (ts *Script) GenerateTaskRunners() ([]TaskRunner, *util.Result)

func (*Script) NewRequest 

func (s *Script) NewRequest() (*Request, *util.Result)

type ScriptStep 

type ScriptStep struct {
	FuncCmdBase `json:",inline" yaml:",inline"`

	Function []*FuncCmdDef `json:"function,omitempty" yaml:"function,omitempty"`
}

func (*ScriptStep) GenerateTaskRunners 

func (tc *ScriptStep) GenerateTaskRunners(ts *Script) ([]TaskRunner, *util.Result)

type SelectTask 

type SelectTask struct {
	*CmdTaskBase
	FieldName   string
	FieldValues []*enigma.FieldValue
}

func (*SelectTask) Run 

func (t *SelectTask) Run() *util.Result

type SetVarTask 

type SetVarTask struct {
	*CmdTaskBase
	VarName  string
	VarValue string
}

func (*SetVarTask) Run 

func (t *SetVarTask) Run() *util.Result

type TaskRunner 

type TaskRunner interface {
	Run() *util.Result
}

func NewApplyBMTask 

func NewApplyBMTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)

func NewClearAllTask 

func NewClearAllTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)

func NewDel_AppTask added in v0.6.0 

func NewDel_AppTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)

func NewDel_FileTask added in v0.6.0 

func NewDel_FileTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)

func NewDuplicateTask added in v0.5.1 

func NewDuplicateTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)

func NewMove_FileTask added in v0.6.0 

func NewMove_FileTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)

func NewReportTask added in v0.5.1 

func NewReportTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)

func NewSelectTask 

func NewSelectTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)

func NewSetVarTask 

func NewSetVarTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)

func NewTaskRunner 

func NewTaskRunner(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)

type TaskRunnerCreator 

type TaskRunnerCreator func(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.