workflows

Documentation

Index

• Constants
• Variables
• func DeepMap(input any, transform func(el string) (any, error)) (any, error)
• func GenerateJSONSchema() ([]byte, error)
• func WFYamlSpec(t *testing.T, name, owner string) string
• type DependencyGraph
  • func ParseDependencyGraph(yamlWorkflow string) (*DependencyGraph, error)
• type StepDefinition
• type StepInputs
• type Vertex
  • func (v *Vertex) VID() string
• type WorkflowSpec
  • func ParseWorkflowSpecYaml(data string) (WorkflowSpec, error)
  • func (w *WorkflowSpec) CID() string
  • func (w *WorkflowSpec) Steps() []StepDefinition
  • func (w *WorkflowSpec) String() string

Constants

const (
	KeywordTrigger = "trigger"
)

Variables

var (
	InterpolationTokenRe = regexp.MustCompile(`^\$\((\S+)\)$`)
)

Functions

func DeepMap

func DeepMap(input any, transform func(el string) (any, error)) (any, error)

DeepMap recursively applies a transformation function over each string within:

• a map[string]any
• a []any
• a string

func GenerateJSONSchema

func GenerateJSONSchema() ([]byte, error)

func WFYamlSpec

func WFYamlSpec(t *testing.T, name, owner string) string

WFYamlSpec generates a validate yaml spec for a workflow for the given name and owner

Types

type DependencyGraph

type DependencyGraph struct {
	ID string
	graph.Graph[string, *Vertex]

	Triggers []*StepDefinition

	Spec *WorkflowSpec
}

DependencyGraph is an intermediate representation of a workflow wherein all the graph vertices are represented and validated. It is a static representation of the workflow dependencies.

func ParseDependencyGraph

func ParseDependencyGraph(yamlWorkflow string) (*DependencyGraph, error)

type StepDefinition

type StepDefinition struct {
	ID     string
	Ref    string
	Inputs StepInputs
	Config map[string]any

	CapabilityType capabilities.CapabilityType
}

StepDefinition is the parsed representation of a step in a workflow.

Within the workflow spec, they are called "Capability Properties".

type StepInputs

type StepInputs struct {
	OutputRef string
	Mapping   map[string]any
}

type Vertex

type Vertex struct {
	StepDefinition
	Dependencies []string
}

func (*Vertex) VID

func (v *Vertex) VID() string

VID is an identifier for a Vertex that can be used to uniquely identify it in a graph. it represents the notion `hash` in the graph package AddVertex method. we refrain from naming it `hash` to avoid confusion with the hash function.

type WorkflowSpec

type WorkflowSpec struct {
	Name      string
	Owner     string
	Triggers  []StepDefinition
	Actions   []StepDefinition
	Consensus []StepDefinition
	Targets   []StepDefinition
	// contains filtered or unexported fields
}

WorkflowSpec is the parsed representation of a workflow. It is a derived representation of the yaml spec. Marshalling this struct is not guaranteed to produce the original yaml spec. Access the original yaml spec using the `String` method.

func ParseWorkflowSpecYaml

func ParseWorkflowSpecYaml(data string) (WorkflowSpec, error)

func (*WorkflowSpec) CID

func (w *WorkflowSpec) CID() string

CID returns the content hash of the original yaml spec of the workflow.

func (*WorkflowSpec) Steps

func (w *WorkflowSpec) Steps() []StepDefinition

func (*WorkflowSpec) String

func (w *WorkflowSpec) String() string

String returns the original yaml spec of the workflow.