engine

Documentation

Index

• Variables
• type Build
• type BuildDelegate
• type BuildDelegateFactory
  • func NewBuildDelegateFactory() BuildDelegateFactory
• type Engine
  • func NewDBEngine(engines Engines) Engine
  • func NewExecEngine(factory exec.Factory, delegateFactory BuildDelegateFactory, ...) Engine
  • func NewExecV1DummyEngine() Engine
• type Engines
  • func (engines Engines) Lookup(name string) (Engine, bool)
• type StepMetadata
  • func (metadata StepMetadata) Env() []string
• type UnknownEngineError
  • func (err UnknownEngineError) Error() string

Variables

var ErrBuildNotActive = errors.New("build not yet active")

Types

type Build

type Build interface {
	Metadata() string

	PublicPlan(lager.Logger) (atc.PublicBuildPlan, error)

	Abort(lager.Logger) error
	Resume(lager.Logger)
}

type BuildDelegate

type BuildDelegate interface {
	InputDelegate(lager.Logger, atc.GetPlan, event.OriginID) exec.GetDelegate
	ExecutionDelegate(lager.Logger, atc.TaskPlan, event.OriginID) exec.TaskDelegate
	OutputDelegate(lager.Logger, atc.PutPlan, event.OriginID) exec.PutDelegate

	Finish(lager.Logger, error, exec.Success, bool)
}

type BuildDelegateFactory

type BuildDelegateFactory interface {
	Delegate(db.Build) BuildDelegate
}

func NewBuildDelegateFactory

func NewBuildDelegateFactory() BuildDelegateFactory

type Engine

type Engine interface {
	Name() string

	CreateBuild(lager.Logger, db.Build, atc.Plan) (Build, error)
	LookupBuild(lager.Logger, db.Build) (Build, error)
}

func NewDBEngine

func NewDBEngine(engines Engines) Engine

func NewExecEngine

func NewExecEngine(
	factory exec.Factory,
	delegateFactory BuildDelegateFactory,
	teamDBFactory db.TeamDBFactory,
	externalURL string,
) Engine

func NewExecV1DummyEngine

func NewExecV1DummyEngine() Engine

type Engines

type Engines []Engine

func (Engines) Lookup

func (engines Engines) Lookup(name string) (Engine, bool)

type StepMetadata

type StepMetadata struct {
	BuildID int

	PipelineName string
	JobName      string
	BuildName    string
	ExternalURL  string
}

func (StepMetadata) Env

func (metadata StepMetadata) Env() []string

type UnknownEngineError

type UnknownEngineError struct {
	Engine string
}

func (UnknownEngineError) Error

func (err UnknownEngineError) Error() string