plotexec

Documentation

Index

• Constants
• func Exec(ctx context.Context, wsSet workspace.WorkspaceSet, ...) (wfapi.PlotResults, error)
• func OrderSteps(ctx context.Context, plot wfapi.Plot) ([]wfapi.StepName, error)
• func OrderStepsAll(ctx context.Context, plot wfapi.Plot) ([]wfapi.StepName, error)

Constants

const LOG_TAG = "│  plot"

const LOG_TAG_END = "└─ plot"

const LOG_TAG_MID = "├─ plot"

const LOG_TAG_START = "┌─ plot"

Functions

func Exec

func Exec(ctx context.Context, wsSet workspace.WorkspaceSet, plotCapsule wfapi.PlotCapsule, config wfapi.PlotExecConfig) (wfapi.PlotResults, error)

Execute a PlotCapsule using the provided WorkspaceSet

Errors:

• warpforge-error-plot-invalid -- when the provided plot input is invalid
• warpforge-error-catalog-missing-entry -- when a referenced catalog reference cannot be found
• warpforge-error-git -- when a git related error occurs during a git ingest
• warpforge-error-io -- when an IO error occurs during conversion
• warpforge-error-catalog-parse -- when parsing of catalog files fails
• warpforge-error-catalog-invalid -- when the catalog contains invalid data
• warpforge-error-plot-step-failed -- when execution of a plot step fails
• warpforge-error-workspace -- when home workspace is missing or cannot be opened

func OrderSteps

func OrderSteps(ctx context.Context, plot wfapi.Plot) ([]wfapi.StepName, error)

Return the ordered list of steps for a single plot. Errors:

• warpforge-error-plot-invalid -- when the plot is not a DAG

func OrderStepsAll

func OrderStepsAll(ctx context.Context, plot wfapi.Plot) ([]wfapi.StepName, error)

Return the ordered list of steps for a plot, recursing into nested plots.

Errors:

• warpforge-error-plot-invalid -- when the provided plot is malformed