_waitfor

README

waitFor - Execution Synchronizer

Documentation

Overview

Package waitformiddleware provides a middleware to defer execution until a condition is fulfilled

Index

• type Middleware
  • func NewMiddleware() Middleware
  • func NewMiddlewareWithLookupImplementation(lookupImplementation func(key string) (string, bool)) Middleware
  • func (waitForMiddleware Middleware) Apply(run *pipeline.Run, next func(*pipeline.Run), ...)
  • func (waitForMiddleware Middleware) String() string

Types

type Middleware

type Middleware struct {
	LookupEnv func(string) (string, bool)
}

Middleware is an execution synchronizer

func NewMiddleware

func NewMiddleware() Middleware

NewMiddleware creates a new middleware instance

func NewMiddlewareWithLookupImplementation

func NewMiddlewareWithLookupImplementation(lookupImplementation func(key string) (string, bool)) Middleware

func (Middleware) Apply

func (waitForMiddleware Middleware) Apply(
	run *pipeline.Run,
	next func(*pipeline.Run),
	executionContext *middleware.ExecutionContext,
)

Apply is where the middleware's logic resides

It adapts the run based on its slice of the run's arguments. It may also trigger side effects such as executing shell commands or full runs of other pipelines. When done, this function should call next in order to continue unwinding the stack.

func (Middleware) String

func (waitForMiddleware Middleware) String() string

String is a human-readable description