pipeline

package
v0.30.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 6, 2021 License: GPL-2.0, GPL-3.0 Imports: 13 Imported by: 0

Documentation

Overview

Provides a model representing a pipeline definition that defines default arguments for a pipeline identifier

Provides a representation of a yaml pipeline file as a Go struct

Provides models to represent pipeline files and runs

Provides a model representing a pipeline run

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DefaultSettings 

type DefaultSettings struct {
	Command string
	Dir     string
}

type File 

type File struct {
	Default  DefaultSettings
	FileName string
	Hooks    HookDefinitions
	Import   []string
	// in pipeline files, each command can have arbitrary parameters
	// it may also have "steps"
	// each step can be either a string referencing another pipeline
	// or a dictionary containing additional parameters
	Public  map[string]map[string]interface{}
	Private map[string]map[string]interface{}
}

Note that this struct does not have exactly the same structure as the yaml file

type HookDefinitions 

type HookDefinitions = map[string][]string

type PipelineDefinition 

type PipelineDefinition struct {
	BuiltIn             bool
	DefinitionArguments map[string]interface{}
	FileName            string
	Public              bool
}

func NewPipelineDefinition 

func NewPipelineDefinition(
	arguments map[string]interface{},
	pipelineFileName string,
	isPublic bool,
	isBuiltIn bool,
) *PipelineDefinition

type PipelineDefinitionsLookup 

type PipelineDefinitionsLookup = map[string][]PipelineDefinition

func MergePipelineDefinitions 

func MergePipelineDefinitions(definition1 PipelineDefinitionsLookup, definition2 PipelineDefinitionsLookup) PipelineDefinitionsLookup

type PipelineFileImportSkeleton 

type PipelineFileImportSkeleton struct {
	Import []string
}

type PipelineRunLogger 

type PipelineRunLogger struct {
	Indentation int

	ErrorCallback func(error)
	// contains filtered or unexported fields
}

func NewClosedPipelineRunLoggerWithErrors 

func NewClosedPipelineRunLoggerWithErrors(errors *multierror.Error) *PipelineRunLogger

func NewClosedPipelineRunLoggerWithResult 

func NewClosedPipelineRunLoggerWithResult(buffer *bytes.Buffer) *PipelineRunLogger

func NewPipelineRunLogger 

func NewPipelineRunLogger(run *Run, indentation int) *PipelineRunLogger

func (*PipelineRunLogger) AddReaderEntry 

func (logger *PipelineRunLogger) AddReaderEntry(reader io.Reader)

func (*PipelineRunLogger) AddWriteCloserEntry 

func (logger *PipelineRunLogger) AddWriteCloserEntry() io.WriteCloser

func (*PipelineRunLogger) AllErrorMessages 

func (logger *PipelineRunLogger) AllErrorMessages() []string

func (*PipelineRunLogger) Bytes 

func (logger *PipelineRunLogger) Bytes() []byte

func (*PipelineRunLogger) Close 

func (logger *PipelineRunLogger) Close()

func (*PipelineRunLogger) Closed 

func (logger *PipelineRunLogger) Closed() bool

func (*PipelineRunLogger) Completed 

func (logger *PipelineRunLogger) Completed() bool

func (*PipelineRunLogger) Debug 

func (logger *PipelineRunLogger) Debug(entry *logrus.Entry)

func (*PipelineRunLogger) DebugCount 

func (logger *PipelineRunLogger) DebugCount() int

func (*PipelineRunLogger) DebugWithFields 

func (logger *PipelineRunLogger) DebugWithFields(logFields ...fields.LogEntryField)

func (*PipelineRunLogger) Error 

func (logger *PipelineRunLogger) Error(err error, logFields ...fields.LogEntryField)

func (*PipelineRunLogger) ErrorCount 

func (logger *PipelineRunLogger) ErrorCount() int

func (*PipelineRunLogger) Info 

func (logger *PipelineRunLogger) Info(entry *logrus.Entry)

func (*PipelineRunLogger) InfoCount 

func (logger *PipelineRunLogger) InfoCount() int

func (*PipelineRunLogger) InfoWithFields 

func (logger *PipelineRunLogger) InfoWithFields(logFields ...fields.LogEntryField)

func (*PipelineRunLogger) LastError 

func (logger *PipelineRunLogger) LastError() error

func (*PipelineRunLogger) Level 

func (logger *PipelineRunLogger) Level() logrus.Level

func (*PipelineRunLogger) PossibleError 

func (logger *PipelineRunLogger) PossibleError(err error)

func (*PipelineRunLogger) PossibleErrorWithExplanation 

func (logger *PipelineRunLogger) PossibleErrorWithExplanation(err error, explanation string)

func (*PipelineRunLogger) Reader 

func (logger *PipelineRunLogger) Reader() io.Reader

func (*PipelineRunLogger) SetLevel 

func (logger *PipelineRunLogger) SetLevel(level logrus.Level)

func (*PipelineRunLogger) StderrOutput 

func (logger *PipelineRunLogger) StderrOutput(message string, logFields ...fields.LogEntryField)

func (*PipelineRunLogger) String 

func (logger *PipelineRunLogger) String() string

func (*PipelineRunLogger) Summary 

func (logger *PipelineRunLogger) Summary() string

func (*PipelineRunLogger) Trace 

func (logger *PipelineRunLogger) Trace(entry *logrus.Entry)

func (*PipelineRunLogger) TraceCount 

func (logger *PipelineRunLogger) TraceCount() int

func (*PipelineRunLogger) TraceWithFields 

func (logger *PipelineRunLogger) TraceWithFields(logFields ...fields.LogEntryField)

func (*PipelineRunLogger) Wait 

func (logger *PipelineRunLogger) Wait()

func (*PipelineRunLogger) Warn 

func (logger *PipelineRunLogger) Warn(entry *logrus.Entry)

func (*PipelineRunLogger) WarnCount 

func (logger *PipelineRunLogger) WarnCount() int

func (*PipelineRunLogger) WarnWithFields 

func (logger *PipelineRunLogger) WarnWithFields(logFields ...fields.LogEntryField)

type Run 

type Run struct {

	// if the identifier has been defined before, this will be the resolved reference to the definition
	Definition *PipelineDefinition
	// an optional identifier - note that anonymous pipes without identifier can have invocation arguments, but no definition
	Identifier *string
	// the invocation arguments are what is passed to the pipe at the time of invocation / run creation
	InvocationArguments map[string]interface{}

	Stdin    *datastream.ComposableDataStream
	Stdout   *datastream.ComposableDataStream
	Stderr   *datastream.ComposableDataStream
	ExitCode *int

	Log *PipelineRunLogger

	Parent *Run

	LogClosingWaitGroup *sync.WaitGroup

	Synchronous    bool
	StartWaitGroup *sync.WaitGroup
	// contains filtered or unexported fields
}

A pipeline run contains everything needed to actually execute the invocation of a pipe the middleware operates on these objects, triggering further runs or shell invocations there are three steps to this process:

  1. Setup In the setup phase the arguments, connections between inputs and outputs, etc. of each run are defined.
  2. Finalization After the setup, finalize() is called to prevent any further changes to input/output connections.
  3. Execution The shell command is executed and data is piped through the defined input/output connections. Note that some middleware might start additional runs in the execution phase. For example, the `when` middleware for conditional execution will trigger runs based on whether the result of previous runs satisfies a certain condition

func NewPipelineRun 

func NewPipelineRun(
	identifier *string,
	invocationArguments map[string]interface{},
	definition *PipelineDefinition,
	parent *Run,
) (*Run, error)

func (*Run) AddCancelHook 

func (run *Run) AddCancelHook(cancelHook func() error)

func (*Run) ArgumentAtPath 

func (run *Run) ArgumentAtPath(path ...string) (interface{}, error)

func (*Run) ArgumentAtPathIncludingParents 

func (run *Run) ArgumentAtPathIncludingParents(path ...string) (interface{}, error)

func (*Run) ArgumentsCopy 

func (run *Run) ArgumentsCopy() map[string]interface{}

func (*Run) Cancel 

func (run *Run) Cancel() error

func (*Run) Cancelled 

func (run *Run) Cancelled() bool

func (*Run) Close 

func (run *Run) Close()

func (*Run) Completed 

func (run *Run) Completed() bool

func (*Run) SetArgumentAtPath 

func (run *Run) SetArgumentAtPath(value interface{}, path ...string) error

func (*Run) SetArguments 

func (run *Run) SetArguments(value map[string]interface{})

func (*Run) String 

func (run *Run) String() string

func (*Run) Wait 

func (run *Run) Wait()

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.