pipelines

Documentation

Index

• Variables
• type OnGenericFunc
• type OnProfileFunc
• type Pipeline
• type PipelineRunReturnFunc
• type Profile
  • func NewProfile(name string) *Profile
  • func RunProfile(name string, fnOnGenericFunc OnGenericFunc) (*Profile, error)
  • func (profile *Profile) Start()
  • func (profile *Profile) Stop()

Variables

var (
	// ErrBatonNotPresent indicates the wrong type of data structure passed between pipelines. Internal / Programmatic error
	ErrBatonNotPresent = errors.New("right data structure not present between pipelines")
)

Types

type OnGenericFunc

type OnGenericFunc func() error

OnGenericFunc represents a function that returns an error or otherwise

type OnProfileFunc

type OnProfileFunc func(profile *Profile) error

OnProfileFunc is a function executed on the receipt of a given profile

type Pipeline

type Pipeline interface {
	// Runs a bunch of processes based on the given config
	Run(config *config.Config, buildID cidocker.BuildID, myBaton *baton.Baton) PipelineRunReturnFunc

	// GetNames returns the names of the pipelines . Returns a tuple , a key and a long descriptive name
	GetNames() (key string, longName string)
}

Pipeline builds and executes a given set of commands

type PipelineRunReturnFunc

type PipelineRunReturnFunc func(ctx context.Context, log logger.Log) (cidocker.BuildID, error)

PipelineRunReturnFunc represents the functor to return after a pipeline run

type Profile

type Profile struct {
	Name string

	Begin time.Time

	End time.Time

	Duration time.Duration
}

Profile represents the start and end time of a profile

func NewProfile

func NewProfile(name string) *Profile

NewProfile creates a new profile

func RunProfile

func RunProfile(name string, fnOnGenericFunc OnGenericFunc) (*Profile, error)

RunProfile returns a profile along with the status of the function

func (*Profile) Start

func (profile *Profile) Start()

func (*Profile) Stop

func (profile *Profile) Stop()