engine

Documentation

Index

• Variables
• type Build
• type BuildDB
• type BuildDelegate
• type BuildDelegateFactory
  • func NewBuildDelegateFactory(db EngineDB) BuildDelegateFactory
• type BuildLocker
• type Engine
  • func NewDBEngine(engines Engines, buildDB BuildDB, locker BuildLocker) Engine
  • func NewExecEngine(factory exec.Factory, delegateFactory BuildDelegateFactory, db EngineDB) Engine
• type EngineDB
• type Engines
  • func (engines Engines) Lookup(name string) (Engine, bool)
• type UnknownEngineError
  • func (err UnknownEngineError) Error() string

Variables

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

var ErrBuildNotFound = errors.New("build not found")

Types

type Build

type Build interface {
	Metadata() string

	Abort() error
	Resume(lager.Logger)
}

type BuildDB

type BuildDB interface {
	GetBuild(int) (db.Build, error)
	GetBuildEvents(int, uint) (db.EventSource, error)
	StartBuild(int, string, string) (bool, error)

	AbortBuild(int) error
	AbortNotifier(int) (db.Notifier, error)

	FinishBuild(int, db.Status) error
}

type BuildDelegate

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

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

type BuildDelegateFactory

type BuildDelegateFactory interface {
	Delegate(buildID int) BuildDelegate
}

func NewBuildDelegateFactory

func NewBuildDelegateFactory(db EngineDB) BuildDelegateFactory

type BuildLocker

type BuildLocker interface {
	AcquireWriteLockImmediately([]db.NamedLock) (db.Lock, error)
}

type Engine

type Engine interface {
	Name() string

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

func NewDBEngine

func NewDBEngine(engines Engines, buildDB BuildDB, locker BuildLocker) Engine

func NewExecEngine

func NewExecEngine(factory exec.Factory, delegateFactory BuildDelegateFactory, db EngineDB) Engine

type EngineDB

type EngineDB interface {
	SaveBuildEvent(buildID int, event atc.Event) error

	FinishBuild(buildID int, status db.Status) error

	SaveBuildEngineMetadata(buildID int, metadata string) error

	SaveBuildInput(buildID int, input db.BuildInput) (db.SavedVersionedResource, error)
	SaveBuildOutput(buildID int, vr db.VersionedResource) (db.SavedVersionedResource, error)
}

type Engines

type Engines []Engine

func (Engines) Lookup

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

type UnknownEngineError

type UnknownEngineError struct {
	Engine string
}

func (UnknownEngineError) Error

func (err UnknownEngineError) Error() string