pipeline

README

go-command-pipeline

Small Go utility that executes high-level actions in a pipeline fashion

Usage

import pipeline "github.com/ccremer/go-command-pipeline"

func main() {
	p := pipeline.NewPipeline()
	p.WithSteps(
		pipeline.NewStepWithPredicate("clone repository", CloneGitRepository(), pipeline.Not(DirExists("my-repo"))),
		pipeline.NewStep("checkout branch", CheckoutBranch()),
		pipeline.NewStep("pull", Pull()),
	)
	result := p.Run()
	if !result.IsSuccessful() {
		log.Fatal(result.Err)
	}
}

Documentation

Index

• type ActionFunc
  • func Abort() ActionFunc
• type Handler
• type Logger
• type Pipeline
  • func NewPipeline() *Pipeline
  • func NewPipelineWithLogger(logger Logger) *Pipeline
  • func (p *Pipeline) AddStep(step Step) *Pipeline
  • func (p *Pipeline) AsNestedStep(name string, predicate Predicate) Step
  • func (p *Pipeline) Run() Result
  • func (p *Pipeline) WithAbortHandler(handler Handler) *Pipeline
  • func (p *Pipeline) WithSteps(steps ...Step) *Pipeline
• type Predicate
  • func And(p1, p2 Predicate) Predicate
  • func Bool(v bool) Predicate
  • func False() Predicate
  • func Not(predicate Predicate) Predicate
  • func True() Predicate
• type Result
  • func (r Result) IsSuccessful() bool
• type Step
  • func NewIfElseStep(name string, predicate Predicate, trueAction, falseAction ActionFunc) Step
  • func NewStep(name string, action ActionFunc) Step
  • func NewStepWithPredicate(name string, action ActionFunc, predicate Predicate) Step

Types

type ActionFunc

type ActionFunc func() Result

func Abort

func Abort() ActionFunc

type Handler

type Handler func(result Result)

type Logger

type Logger interface {
	Log(message, name string)
}

type Pipeline

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

func NewPipeline

func NewPipeline() *Pipeline

func NewPipelineWithLogger

func NewPipelineWithLogger(logger Logger) *Pipeline

func (*Pipeline) AddStep

func (p *Pipeline) AddStep(step Step) *Pipeline

func (*Pipeline) AsNestedStep

func (p *Pipeline) AsNestedStep(name string, predicate Predicate) Step

func (*Pipeline) Run

func (p *Pipeline) Run() Result

func (*Pipeline) WithAbortHandler

func (p *Pipeline) WithAbortHandler(handler Handler) *Pipeline

func (*Pipeline) WithSteps

func (p *Pipeline) WithSteps(steps ...Step) *Pipeline

type Predicate

type Predicate func(step Step) bool

func And

func And(p1, p2 Predicate) Predicate

func Bool

func Bool(v bool) Predicate

func False

func False() Predicate

func Not

func Not(predicate Predicate) Predicate

func True

func True() Predicate

type Result

type Result struct {
	Abort bool
	Err   error
}

func (Result) IsSuccessful

func (r Result) IsSuccessful() bool

type Step

type Step struct {
	Name string
	F    ActionFunc
	P    Predicate
}

func NewIfElseStep

func NewIfElseStep(name string, predicate Predicate, trueAction, falseAction ActionFunc) Step

func NewStep

func NewStep(name string, action ActionFunc) Step

func NewStepWithPredicate

func NewStepWithPredicate(name string, action ActionFunc, predicate Predicate) Step