cook

Documentation

Index

• Variables
• func CookRecipeEnvelope(envelope types.RecipeEnvelope) error
• func GenerateJobID() string
• func RegisterEC(n *nats.EncodedConn)
• func RequisitesAreMet(step types.Step, completionMap map[types.StepID]types.StepCompletion) (bool, error)
• func ResolveRecipeFilePath(basepath string, recipeID types.RecipeName) (string, error)
• func SendCookEvent(sproutID string, recipeID types.RecipeName, JID string) error
• func SummarizeSteps(steps []types.SproutStepCompletion) map[string]types.Summary

Variables

var (
	ErrNoRecipe      = errors.New("no recipe")
	ErrInvalidFormat = errors.New("invalid recipe format")
	ErrDuplicateKey  = errors.New("duplicate key in joined maps")
)

var (
	ErrStalled         = errors.New("no steps are in progress")
	ErrRequisiteNotMet = errors.New("requisite not met")
)

Functions

func CookRecipeEnvelope

func CookRecipeEnvelope(envelope types.RecipeEnvelope) error

func GenerateJobID

func GenerateJobID() string

func RegisterEC

func RegisterEC(n *nats.EncodedConn)

func RequisitesAreMet

func RequisitesAreMet(step types.Step, completionMap map[types.StepID]types.StepCompletion) (bool, error)

RequisitesAreMet returns true if all of the requisites for the given step are met All top-level requisites are ANDed together, and meta states can be combined with an ANY clauses to use OR logic instead

func ResolveRecipeFilePath

func ResolveRecipeFilePath(basepath string, recipeID types.RecipeName) (string, error)

func SendCookEvent

func SendCookEvent(sproutID string, recipeID types.RecipeName, JID string) error

func SummarizeSteps

func SummarizeSteps(steps []types.SproutStepCompletion) map[string]types.Summary