engine

Documentation

Overview

Package engine defines the Engine struct, which execute registered pipelines.

Index

• type Engine
  • func (e *Engine) Execute(stage stages.Stage, mediator stages.Mediator) stages.Mediator
  • func (e *Engine) ExecuteStage(stage stages.Stage)
  • func (e *Engine) RunOnce() *Result
• type Result
  • func (r *Result) IsSucceeded() bool

Types

type Engine

type Engine struct {
	Resources    *pipelines.Resources
	MonitorCh    *chan stages.Mediator
	Opts         *config.Opts
	EnvVariables *config.EnvVariables
}

Engine executes the its pipeline.

func (*Engine) Execute

func (e *Engine) Execute(stage stages.Stage, mediator stages.Mediator) stages.Mediator

Execute executes a stage using the supplied mediator

func (*Engine) ExecuteStage

func (e *Engine) ExecuteStage(stage stages.Stage)

ExecuteStage executes the supplied stage

func (*Engine) RunOnce

func (e *Engine) RunOnce() *Result

RunOnce executes the pipeline and the cleanup prccedures.

type Result

type Result struct {
	Pipeline *stages.Mediator
	Cleanup  *stages.Mediator
}

Result stores the output in pipelines.

func (*Result) IsSucceeded

func (r *Result) IsSucceeded() bool

IsSucceeded shows the pipeline finished successfully or not.