validate

Documentation

Index

• func Bytes(name string, content []byte) error
• func Entrypoint(path string) ([]string, error)
• func EntrypointWithContext(ctx context.Context, path string) ([]string, error)
• func EntrypointWithOptions(ctx context.Context, path string, opts Options) ([]string, error)
• func File(path string) error
• func FileWithContext(ctx context.Context, path string) error
• func FileWithOptions(ctx context.Context, path string, opts Options) error
• func SupportedWorkflowRoles() []string
• func SupportedWorkflowVersion() string
• func Workflow(name string, wf *config.Workflow) error
• func WorkflowImportRule() string
• func WorkflowInvariantNotes() []string
• func WorkflowTopLevelModes() []string
• func Workspace(root string) ([]string, error)
• func WorkspaceWithContext(ctx context.Context, root string) ([]string, error)
• func WorkspaceWithOptions(ctx context.Context, root string, opts Options) ([]string, error)
• type Finding
  • func AnalyzeFiles(paths []string) ([]Finding, error)
  • func AnalyzeFilesWithContext(ctx context.Context, paths []string) ([]Finding, error)
• type Issue
• type Options
• type ValidationError
  • func (e *ValidationError) Error() string
  • func (e *ValidationError) ValidationIssues() []Issue

Functions

func Bytes

func Bytes(name string, content []byte) error

func Entrypoint

func Entrypoint(path string) ([]string, error)

Entrypoint validates a scenario entrypoint and its imported components. It is a convenience wrapper for callers that do not own a request context.

func EntrypointWithContext

func EntrypointWithContext(ctx context.Context, path string) ([]string, error)

func EntrypointWithOptions

func EntrypointWithOptions(ctx context.Context, path string, opts Options) ([]string, error)

func File

func File(path string) error

File validates workflow structure and semantic rules. It is a convenience wrapper for CLI-style callers that do not own a request context.

func FileWithContext

func FileWithContext(ctx context.Context, path string) error

func FileWithOptions

func FileWithOptions(ctx context.Context, path string, opts Options) error

func SupportedWorkflowRoles

func SupportedWorkflowRoles() []string

func SupportedWorkflowVersion

func SupportedWorkflowVersion() string

func Workflow

func Workflow(name string, wf *config.Workflow) error

func WorkflowImportRule

func WorkflowImportRule() string

func WorkflowInvariantNotes

func WorkflowInvariantNotes() []string

func WorkflowTopLevelModes

func WorkflowTopLevelModes() []string

func Workspace

func Workspace(root string) ([]string, error)

Workspace validates every scenario entrypoint under a workflow root. It is a convenience wrapper for callers that do not own a request context.

func WorkspaceWithContext

func WorkspaceWithContext(ctx context.Context, root string) ([]string, error)

func WorkspaceWithOptions

func WorkspaceWithOptions(ctx context.Context, root string, opts Options) ([]string, error)

Types

type Finding

type Finding struct {
	Severity string `json:"severity"`
	Code     string `json:"code"`
	Message  string `json:"message"`
	Hint     string `json:"hint,omitempty"`
	Path     string `json:"path,omitempty"`
	Phase    string `json:"phase,omitempty"`
	StepID   string `json:"stepId,omitempty"`
	Kind     string `json:"kind,omitempty"`
}

func AnalyzeFiles

func AnalyzeFiles(paths []string) ([]Finding, error)

func AnalyzeFilesWithContext

func AnalyzeFilesWithContext(ctx context.Context, paths []string) ([]Finding, error)

type Issue

type Issue struct {
	Code         string
	Severity     string
	File         string
	Path         string
	StepID       string
	StepKind     string
	Message      string
	Expected     string
	Actual       string
	SourceRef    string
	SuggestedFix string
}

type Options

type Options struct {
	VarsFiles []string
}

type ValidationError

type ValidationError struct {
	Message string
	Issues  []Issue
}

func (*ValidationError) Error

func (e *ValidationError) Error() string

func (*ValidationError) ValidationIssues

func (e *ValidationError) ValidationIssues() []Issue