common

Documentation

Index

• Constants
• func CartesianProduct(mapOfLists map[string][]interface{}) []map[string]interface{}
• func CloneIfRequired(refName plumbing.ReferenceName, input NewGitCloneExecutorInput, ...) (*git.Repository, error)
• func CopyDir(source string, dest string) (err error)
• func CopyFile(source string, dest string) (err error)
• func Dryrun(ctx context.Context) bool
• func FindGitRef(file string) (string, error)
• func FindGitRevision(file string) (shortSha string, sha string, err error)
• func FindGithubRepo(file string) (string, error)
• func Logger(ctx context.Context) logrus.FieldLogger
• func NewLineWriter(handlers ...LineHandler) io.Writer
• func WithDryrun(ctx context.Context, dryrun bool) context.Context
• func WithLogger(ctx context.Context, logger logrus.FieldLogger) context.Context
• type Conditional
  • func (c Conditional) Not() Conditional
• type Drawing
  • func (d *Drawing) Draw(writer io.Writer, centerOnWidth int)
  • func (d *Drawing) GetWidth() int
• type Executor
  • func NewConditionalExecutor(conditional Conditional, trueExecutor Executor, falseExecutor Executor) Executor
  • func NewDebugExecutor(format string, args ...interface{}) Executor
  • func NewErrorExecutor(err error) Executor
  • func NewGitCloneExecutor(input NewGitCloneExecutorInput) Executor
  • func NewInfoExecutor(format string, args ...interface{}) Executor
  • func NewParallelExecutor(executors ...Executor) Executor
  • func NewPipelineExecutor(executors ...Executor) Executor
  • func (e Executor) ChannelError(errChan chan error) Executor
  • func (e Executor) Finally(finally Executor) Executor
  • func (e Executor) If(conditional Conditional) Executor
  • func (e Executor) IfBool(conditional bool) Executor
  • func (e Executor) IfNot(conditional Conditional) Executor
  • func (e Executor) Then(then Executor) Executor
• type LineHandler
• type NewGitCloneExecutorInput
• type Pen
  • func NewPen(style Style, color int) *Pen
  • func (p *Pen) DrawArrow() *Drawing
  • func (p *Pen) DrawBoxes(labels ...string) *Drawing
• type Style
• type Warning
  • func Warningf(format string, args ...interface{}) Warning
  • func (w Warning) Error() string

Constants

const (
	StyleDoubleLine = iota
	StyleSingleLine
	StyleDashedLine
	StyleNoLine
)

Styles

Functions

func CartesianProduct

func CartesianProduct(mapOfLists map[string][]interface{}) []map[string]interface{}

CartesianProduct takes map of lists and returns list of unique tuples

func CloneIfRequired

func CloneIfRequired(refName plumbing.ReferenceName, input NewGitCloneExecutorInput, logger log.FieldLogger) (*git.Repository, error)

func CopyDir

func CopyDir(source string, dest string) (err error)

CopyDir recursive copy of directory

func CopyFile

func CopyFile(source string, dest string) (err error)

CopyFile copy file

func Dryrun

func Dryrun(ctx context.Context) bool

Dryrun returns true if the current context is dryrun

func FindGitRef

func FindGitRef(file string) (string, error)

FindGitRef get the current git ref

func FindGitRevision

func FindGitRevision(file string) (shortSha string, sha string, err error)

FindGitRevision get the current git revision

func FindGithubRepo

func FindGithubRepo(file string) (string, error)

FindGithubRepo get the repo

func Logger

func Logger(ctx context.Context) logrus.FieldLogger

Logger returns the appropriate logger for current context

func NewLineWriter

func NewLineWriter(handlers ...LineHandler) io.Writer

NewLineWriter creates a new instance of a line writer

func WithDryrun

func WithDryrun(ctx context.Context, dryrun bool) context.Context

WithDryrun adds a value to the context for dryrun

func WithLogger

func WithLogger(ctx context.Context, logger logrus.FieldLogger) context.Context

WithLogger adds a value to the context for the logger

Types

type Conditional

type Conditional func(ctx context.Context) bool

Conditional define contract for the conditional predicate

func (Conditional) Not

func (c Conditional) Not() Conditional

Not return an inverted conditional

type Drawing

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

Drawing struct

func (*Drawing) Draw

func (d *Drawing) Draw(writer io.Writer, centerOnWidth int)

Draw to writer

func (*Drawing) GetWidth

func (d *Drawing) GetWidth() int

GetWidth of drawing

type Executor

type Executor func(ctx context.Context) error

Executor define contract for the steps of a workflow

func NewConditionalExecutor

func NewConditionalExecutor(conditional Conditional, trueExecutor Executor, falseExecutor Executor) Executor

NewConditionalExecutor creates a new executor based on conditions

func NewDebugExecutor

func NewDebugExecutor(format string, args ...interface{}) Executor

NewDebugExecutor is an executor that logs messages

func NewErrorExecutor

func NewErrorExecutor(err error) Executor

NewErrorExecutor creates a new executor that always errors out

func NewGitCloneExecutor

func NewGitCloneExecutor(input NewGitCloneExecutorInput) Executor

NewGitCloneExecutor creates an executor to clone git repos

func NewInfoExecutor

func NewInfoExecutor(format string, args ...interface{}) Executor

NewInfoExecutor is an executor that logs messages

func NewParallelExecutor

func NewParallelExecutor(executors ...Executor) Executor

NewParallelExecutor creates a new executor from a parallel of other executors

func NewPipelineExecutor

func NewPipelineExecutor(executors ...Executor) Executor

NewPipelineExecutor creates a new executor from a series of other executors

func (Executor) ChannelError

func (e Executor) ChannelError(errChan chan error) Executor

ChannelError sends error to errChan rather than returning error

func (Executor) Finally

func (e Executor) Finally(finally Executor) Executor

Finally adds an executor to run after other executor

func (Executor) If

func (e Executor) If(conditional Conditional) Executor

If only runs this executor if conditional is true

func (Executor) IfBool

func (e Executor) IfBool(conditional bool) Executor

IfBool only runs this executor if conditional is true

func (Executor) IfNot

func (e Executor) IfNot(conditional Conditional) Executor

IfNot only runs this executor if conditional is true

func (Executor) Then

func (e Executor) Then(then Executor) Executor

Then runs another executor if this executor succeeds

type LineHandler

type LineHandler func(line string) bool

LineHandler is a callback function for handling a line

type NewGitCloneExecutorInput

type NewGitCloneExecutorInput struct {
	URL string
	Ref string
	Dir string
}

NewGitCloneExecutorInput the input for the NewGitCloneExecutor

type Pen

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

Pen struct

func NewPen

func NewPen(style Style, color int) *Pen

NewPen creates a new pen

func (*Pen) DrawArrow

func (p *Pen) DrawArrow() *Drawing

DrawArrow between boxes

func (*Pen) DrawBoxes

func (p *Pen) DrawBoxes(labels ...string) *Drawing

DrawBoxes to draw boxes

type Style

type Style int

Style is a specific style

type Warning

type Warning struct {
	Message string
}

Warning that implements `error` but safe to ignore

func Warningf

func Warningf(format string, args ...interface{}) Warning

Warningf create a warning

func (Warning) Error

func (w Warning) Error() string

Error the contract for error