exec

Documentation

Index

• Variables
• type Aggregate
  • func (a Aggregate) Using(prev Step, repo *SourceRepository) Step
• type ArtifactDestination
• type ArtifactSource
• type Conditional
  • func (c *Conditional) Release() error
  • func (c *Conditional) Result(x interface{}) bool
  • func (c *Conditional) Run(signals <-chan os.Signal, ready chan<- struct{}) error
  • func (c Conditional) Using(prev Step, repo *SourceRepository) Step
• type ExitStatus
• type Factory
  • func NewGardenFactory(workerClient worker.Client, resourceTracker resource.Tracker, ...) Factory
• type FileConfigSource
  • func (configSource FileConfigSource) FetchConfig(repo *SourceRepository) (atc.TaskConfig, error)
• type FileNotFoundError
  • func (err FileNotFoundError) Error() string
• type GetDelegate
• type HijackedProcess
• type IOConfig
• type Identity
  • func (Identity) Using(prev Step, repo *SourceRepository) Step
• type MergedConfigSource
  • func (configSource MergedConfigSource) FetchConfig(source *SourceRepository) (atc.TaskConfig, error)
• type MissingInputsError
  • func (err MissingInputsError) Error() string
• type NoopStep
  • func (NoopStep) Release() error
  • func (NoopStep) Result(interface{}) bool
  • func (NoopStep) Run(<-chan os.Signal, chan<- struct{}) error
  • func (NoopStep) StreamFile(path string) (io.ReadCloser, error)
  • func (NoopStep) StreamTo(ArtifactDestination) error
• type Privileged
• type PutDelegate
• type ResourceDelegate
• type SourceName
• type SourceRepository
  • func NewSourceRepository() *SourceRepository
  • func (repo *SourceRepository) RegisterSource(name SourceName, source ArtifactSource)
  • func (repo *SourceRepository) SourceFor(name SourceName) (ArtifactSource, bool)
  • func (repo *SourceRepository) StreamFile(path string) (io.ReadCloser, error)
  • func (repo *SourceRepository) StreamTo(dest ArtifactDestination) error
• type StaticConfigSource
  • func (configSource StaticConfigSource) FetchConfig(*SourceRepository) (atc.TaskConfig, error)
• type Step
• type StepFactory
  • func Compose(a StepFactory, b StepFactory) StepFactory
  • func HookedCompose(step StepFactory, next StepFactory, failure StepFactory, success StepFactory, ...) StepFactory
  • func Timeout(step StepFactory, duration atc.Duration) StepFactory
  • func Try(step StepFactory) StepFactory
• type Success
• type TaskConfigSource
• type TaskDelegate
• type UUIDGenFunc
• type UnknownArtifactSourceError
  • func (err UnknownArtifactSourceError) Error() string
• type UnspecifiedArtifactSourceError
  • func (err UnspecifiedArtifactSourceError) Error() string
• type VersionInfo

Variables

var ErrInterrupted = errors.New("interrupted")

var ErrStepTimedOut = errors.New("process-exceeded-timeout-limit")

Types

type Aggregate

type Aggregate []StepFactory

func (Aggregate) Using

func (a Aggregate) Using(prev Step, repo *SourceRepository) Step

type ArtifactDestination

type ArtifactDestination interface {
	StreamIn(string, io.Reader) error
}

type ArtifactSource

type ArtifactSource interface {
	StreamTo(ArtifactDestination) error
	StreamFile(path string) (io.ReadCloser, error)
}

type Conditional

type Conditional struct {
	Conditions  atc.Conditions
	StepFactory StepFactory
	// contains filtered or unexported fields
}

func (*Conditional) Release

func (c *Conditional) Release() error

func (*Conditional) Result

func (c *Conditional) Result(x interface{}) bool

func (*Conditional) Run

func (c *Conditional) Run(signals <-chan os.Signal, ready chan<- struct{}) error

func (Conditional) Using

func (c Conditional) Using(prev Step, repo *SourceRepository) Step

type ExitStatus

type ExitStatus int

type Factory

type Factory interface {
	Get(SourceName, worker.Identifier, GetDelegate, atc.ResourceConfig, atc.Params, atc.Tags, atc.Version) StepFactory
	Put(worker.Identifier, PutDelegate, atc.ResourceConfig, atc.Tags, atc.Params) StepFactory
	// Delete(atc.ResourceConfig, atc.Params, atc.Version) Step
	Task(SourceName, worker.Identifier, TaskDelegate, Privileged, atc.Tags, TaskConfigSource) StepFactory

	DependentGet(SourceName, worker.Identifier, GetDelegate, atc.ResourceConfig, atc.Tags, atc.Params) StepFactory
}

func NewGardenFactory

func NewGardenFactory(
	workerClient worker.Client,
	resourceTracker resource.Tracker,
	uuidGenerator UUIDGenFunc,
) Factory

type FileConfigSource

type FileConfigSource struct {
	Path string
}

func (FileConfigSource) FetchConfig

func (configSource FileConfigSource) FetchConfig(repo *SourceRepository) (atc.TaskConfig, error)

type FileNotFoundError

type FileNotFoundError struct {
	Path string
}

func (FileNotFoundError) Error

func (err FileNotFoundError) Error() string

type GetDelegate

type GetDelegate interface {
	ResourceDelegate
}

type HijackedProcess

type HijackedProcess interface {
	Wait() (int, error)
	SetTTY(atc.HijackTTYSpec) error
}

type IOConfig

type IOConfig struct {
	Stdin  io.Reader
	Stdout io.Writer
	Stderr io.Writer
}

type Identity

type Identity struct{}

func (Identity) Using

func (Identity) Using(prev Step, repo *SourceRepository) Step

type MergedConfigSource

type MergedConfigSource struct {
	A TaskConfigSource
	B TaskConfigSource
}

func (MergedConfigSource) FetchConfig

func (configSource MergedConfigSource) FetchConfig(source *SourceRepository) (atc.TaskConfig, error)

type MissingInputsError

type MissingInputsError struct {
	Inputs []string
}

func (MissingInputsError) Error

func (err MissingInputsError) Error() string

type NoopStep

type NoopStep struct{}

func (NoopStep) Release

func (NoopStep) Release() error

func (NoopStep) Result

func (NoopStep) Result(interface{}) bool

func (NoopStep) Run

func (NoopStep) Run(<-chan os.Signal, chan<- struct{}) error

func (NoopStep) StreamFile

func (NoopStep) StreamFile(path string) (io.ReadCloser, error)

func (NoopStep) StreamTo

func (NoopStep) StreamTo(ArtifactDestination) error

type Privileged

type Privileged bool

type PutDelegate

type PutDelegate interface {
	ResourceDelegate
}

type ResourceDelegate

type ResourceDelegate interface {
	Completed(ExitStatus, *VersionInfo)
	Failed(error)

	Stdout() io.Writer
	Stderr() io.Writer
}

type SourceName

type SourceName string

type SourceRepository

type SourceRepository struct {
	// contains filtered or unexported fields
}

func NewSourceRepository

func NewSourceRepository() *SourceRepository

func (*SourceRepository) RegisterSource

func (repo *SourceRepository) RegisterSource(name SourceName, source ArtifactSource)

func (*SourceRepository) SourceFor

func (repo *SourceRepository) SourceFor(name SourceName) (ArtifactSource, bool)

func (*SourceRepository) StreamFile

func (repo *SourceRepository) StreamFile(path string) (io.ReadCloser, error)

func (*SourceRepository) StreamTo

func (repo *SourceRepository) StreamTo(dest ArtifactDestination) error

type StaticConfigSource

type StaticConfigSource struct {
	Config atc.TaskConfig
}

func (StaticConfigSource) FetchConfig

func (configSource StaticConfigSource) FetchConfig(*SourceRepository) (atc.TaskConfig, error)

type Step

type Step interface {
	ifrit.Runner

	Release() error
	Result(interface{}) bool
}

type StepFactory

type StepFactory interface {
	Using(Step, *SourceRepository) Step
}

func Compose

func Compose(a StepFactory, b StepFactory) StepFactory

func HookedCompose

func HookedCompose(
	step StepFactory,
	next StepFactory,
	failure StepFactory,
	success StepFactory,
	ensure StepFactory,
) StepFactory

func Timeout

func Timeout(
	step StepFactory,
	duration atc.Duration,
) StepFactory

func Try

func Try(
	step StepFactory,
) StepFactory

type Success

type Success bool

type TaskConfigSource

type TaskConfigSource interface {
	FetchConfig(*SourceRepository) (atc.TaskConfig, error)
}

type TaskDelegate

type TaskDelegate interface {
	Initializing(atc.TaskConfig)
	Started()

	Finished(ExitStatus)
	Failed(error)

	Stdout() io.Writer
	Stderr() io.Writer
}

type UUIDGenFunc

type UUIDGenFunc func() string

type UnknownArtifactSourceError

type UnknownArtifactSourceError struct {
	SourceName SourceName
}

func (UnknownArtifactSourceError) Error

func (err UnknownArtifactSourceError) Error() string

type UnspecifiedArtifactSourceError

type UnspecifiedArtifactSourceError struct {
	Path string
}

func (UnspecifiedArtifactSourceError) Error

func (err UnspecifiedArtifactSourceError) Error() string

type VersionInfo

type VersionInfo struct {
	Version  atc.Version
	Metadata []atc.MetadataField
}