compiler

Documentation

Overview

Package compiler contains code to compile manifests into executable plans.

Only POSIX shell and bash are currently supported.

Index

• func AppendPlan(ctx context.Context, planFile string, info operator.Info, ...) error
• func GetOperation(op operator.Interface) (operator.Interface, error)
• func Operators() []operator.Interface
• type Compiler
  • func New() *Compiler
  • func (c *Compiler) Compile(ctx context.Context, m *manifest.Manifest) (*Plan, error)
• type Plan
  • func (p Plan) All() ([]*Plan, error)
  • func (p Plan) RealOps() []operator.Interface
  • func (p Plan) TextSummary(w io.Writer, prevs, currs []state.State) error

Functions

func AppendPlan

func AppendPlan(ctx context.Context, planFile string, info operator.Info, cobraCmd *cobra.Command, args []string) error

func GetOperation

func GetOperation(op operator.Interface) (operator.Interface, error)

GetOperation returns the original implementation of an operator's interface.

func Operators

func Operators() []operator.Interface

Operators returns a list of all available operators.

Types

type Compiler

type Compiler struct {
	// contains filtered or unexported fields
}

func New

func New() *Compiler

func (*Compiler) Compile

func (c *Compiler) Compile(ctx context.Context, m *manifest.Manifest) (*Plan, error)

type Plan

type Plan struct {
	Name         string               `json:"name"`
	Operations   []operator.Interface `json:"operations"`
	Plans        []*Plan              `json:"plans,omitempty"`
	Dependencies []*Plan              `json:"dependencies,omitempty"`
}

func (Plan) All

func (p Plan) All() ([]*Plan, error)

func (Plan) RealOps

func (p Plan) RealOps() []operator.Interface

func (Plan) TextSummary

func (p Plan) TextSummary(w io.Writer, prevs, currs []state.State) error