task

Documentation

Index

• Constants
• Variables
• func NewCmdCfg() *cmd.Cfg
• func NewPipelineCfg() *pipeline.Cfg
• type Cfg
  • func NewCfg() *Cfg
  • func (c *Cfg) Add(typ StepType, cfg interface{}) *Cfg
  • func (c *Cfg) Defer(typ StepType, cfg interface{}) *Cfg
  • func (c *Cfg) SetID(id string) *Cfg
  • func (c *Cfg) SetType(t Type) *Cfg
• type Cmd
  • func NewCmdStep() *Cmd
  • func (c *Cmd) GetCfg() interface{}
  • func (c *Cmd) Init() error
  • func (c *Cmd) Start() error
  • func (c *Cmd) Stop() error
  • func (c *Cmd) Type() interface{}
• type Collector
• type Hook
• type HookExtraData
• type Pipeline
  • func NewPipelineStep() *Pipeline
  • func (p *Pipeline) GetCfg() interface{}
  • func (p *Pipeline) Init() error
  • func (p *Pipeline) Start() error
  • func (p *Pipeline) Stop() error
  • func (p *Pipeline) Type() interface{}
• type Result
• type Step
• type StepCfg
• type StepHook
• type StepType
• type Task
  • func New() *Task
  • func (t *Task) CurDeferStep() Step
  • func (t *Task) CurStep() Step
  • func (t *Task) DeferSteps() []Step
  • func (t *Task) GetCfg() interface{}
  • func (t *Task) Init() error
  • func (t *Task) RegisterCollector(c Collector)
  • func (t *Task) RegisterDeferStepDoneHook(hook ...StepHook)
  • func (t *Task) RegisterStepDoneHook(hook ...StepHook)
  • func (t *Task) Result() interface{}
  • func (t *Task) Start() error
  • func (t *Task) Steps() []Step
  • func (t *Task) Stop() error
  • func (t *Task) Store(k string, v any) error
  • func (t *Task) Type() interface{}
• type Type

Constants

const PluginTypeTask plugin.Type = "task"

Variables

var CreateBaseStep = newBase

Functions

func NewCmdCfg

func NewCmdCfg() *cmd.Cfg

func NewPipelineCfg

func NewPipelineCfg() *pipeline.Cfg

Types

type Cfg

type Cfg struct {
	ID              string     `json:"id"              validate:"required,min=1" yaml:"id"`
	Type            Type       `json:"type"            validate:"required"       yaml:"type"`
	Steps           []*StepCfg `json:"steps"           validate:"required,min=1" yaml:"steps"`
	DeferSteps      []*StepCfg `json:"deferSteps"      yaml:"deferSteps"`
	CurStepIdx      int        `json:"curStepIdx"      yaml:"curStepIdx"`
	CurDeferStepIdx int        `json:"curDeferStepIdx" yaml:"curDeferStepIdx"`
}

func NewCfg

func NewCfg() *Cfg

func (*Cfg) Add

func (c *Cfg) Add(typ StepType, cfg interface{}) *Cfg

func (*Cfg) Defer

func (c *Cfg) Defer(typ StepType, cfg interface{}) *Cfg

func (*Cfg) SetID

func (c *Cfg) SetID(id string) *Cfg

func (*Cfg) SetType

func (c *Cfg) SetType(t Type) *Cfg

type Cmd

type Cmd struct {
	Step
	*cmd.Cfg
}

func NewCmdStep

func NewCmdStep() *Cmd

func (*Cmd) GetCfg

func (c *Cmd) GetCfg() interface{}

func (*Cmd) Init

func (c *Cmd) Init() error

func (*Cmd) Start

func (c *Cmd) Start() error

func (*Cmd) Stop

func (c *Cmd) Stop() error

func (*Cmd) Type

func (c *Cmd) Type() interface{}

type Collector

type Collector func(*Task) interface{}

type Hook

type Hook func(*Task, error, *HookExtraData)

type HookExtraData

type HookExtraData struct {
	Submitted  bool
	SubmitWait bool
}

type Pipeline

type Pipeline struct {
	Step
	*pipeline.Cfg
	// contains filtered or unexported fields
}

func NewPipelineStep

func NewPipelineStep() *Pipeline

func (*Pipeline) GetCfg

func (p *Pipeline) GetCfg() interface{}

func (*Pipeline) Init

func (p *Pipeline) Init() error

func (*Pipeline) Start

func (p *Pipeline) Start() error

func (*Pipeline) Stop

func (p *Pipeline) Stop() error

func (*Pipeline) Type

func (p *Pipeline) Type() interface{}

type Result

type Result struct {
	Cfg            *Cfg                     `json:"cfg"            yaml:"cfg"`
	Data           map[string]interface{}   `json:"data"           yaml:"data"`
	StepsData      []map[string]interface{} `json:"stepsData"      yaml:"stepsData"`
	DeferStepsData []map[string]interface{} `json:"deferStepsData" yaml:"deferStepsData"`
}

type Step

type Step interface {
	runner.Runner
	plugin.Plugin
	GetTask() *Task
	SetTask(*Task)
}

type StepCfg

type StepCfg struct {
	Type StepType    `json:"type" validate:"required" yaml:"type"`
	Cfg  interface{} `json:"cfg"  validate:"required" yaml:"cfg"`
}

type StepHook

type StepHook func(*Task, int, Step)

type StepType

type StepType string

const StepTypeCmd StepType = "cmd"

const StepTypePipeline StepType = "pipeline"

type Task

type Task struct {
	runner.Runner
	plugin.Plugin
	*Cfg
	// contains filtered or unexported fields
}

func New

func New() *Task

func (*Task) CurDeferStep

func (t *Task) CurDeferStep() Step

func (*Task) CurStep

func (t *Task) CurStep() Step

func (*Task) DeferSteps

func (t *Task) DeferSteps() []Step

func (*Task) GetCfg

func (t *Task) GetCfg() interface{}

func (*Task) Init

func (t *Task) Init() error

func (*Task) RegisterCollector

func (t *Task) RegisterCollector(c Collector)

func (*Task) RegisterDeferStepDoneHook

func (t *Task) RegisterDeferStepDoneHook(hook ...StepHook)

func (*Task) RegisterStepDoneHook

func (t *Task) RegisterStepDoneHook(hook ...StepHook)

func (*Task) Result

func (t *Task) Result() interface{}

func (*Task) Start

func (t *Task) Start() error

func (*Task) Steps

func (t *Task) Steps() []Step

func (*Task) Stop

func (t *Task) Stop() error

func (*Task) Store

func (t *Task) Store(k string, v any) error

func (*Task) Type

func (t *Task) Type() interface{}

type Type

type Type string