exec

Documentation

Index

• func NewSchemaBox() *packr.Box
• type Action
  • func (a Action) GetSteps() []builder.ExecutableStep
  • func (a *Action) UnmarshalYAML(unmarshal func(interface{}) error) error
• type ExecuteOptions
• type Instruction
• type Mixin
  • func New() *Mixin
  • func (m *Mixin) Execute(opts ExecuteOptions) error
  • func (m *Mixin) GetSchema() (string, error)
  • func (m *Mixin) PrintSchema() error
  • func (m *Mixin) PrintVersion(opts version.Options) error
• type Output
  • func (o Output) GetFilePath() string
  • func (o Output) GetJsonPath() string
  • func (o Output) GetName() string
  • func (o Output) GetRegex() string
• type Step
  • func (s Step) GetArguments() []string
  • func (s Step) GetCommand() string
  • func (s Step) GetFlags() builder.Flags
  • func (s Step) GetOutputs() []builder.Output
• type TestMixin
  • func NewTestMixin(t *testing.T) *TestMixin

Functions

func NewSchemaBox

func NewSchemaBox() *packr.Box

Types

type Action

type Action struct {
	Steps []Step // using UnmarshalYAML so that we don't need a custom type per action
}

func (Action) GetSteps

func (a Action) GetSteps() []builder.ExecutableStep

func (*Action) UnmarshalYAML

func (a *Action) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML takes any yaml in this form ACTION: - exec: ... and puts the steps into the Action.Steps field

type ExecuteOptions

type ExecuteOptions struct {
	File string
}

ExecOptions represent the options for any exec command

type Instruction

type Instruction struct {
	Description string        `yaml:"description"`
	Command     string        `yaml:"command"`
	Arguments   []string      `yaml:"arguments,omitempty"`
	Flags       builder.Flags `yaml:"flags,omitempty"`
	Outputs     []Output      `yaml:"outputs,omitempty"`
}

type Mixin

type Mixin struct {
	*context.Context
	// contains filtered or unexported fields
}

Exec is the logic behind the exec mixin

func New

func New() *Mixin

New exec mixin client, initialized with useful defaults.

func (*Mixin) Execute

func (m *Mixin) Execute(opts ExecuteOptions) error

func (*Mixin) GetSchema

func (m *Mixin) GetSchema() (string, error)

func (*Mixin) PrintSchema

func (m *Mixin) PrintSchema() error

func (*Mixin) PrintVersion

func (m *Mixin) PrintVersion(opts version.Options) error

type Output

type Output struct {
	Name     string `yaml:"name"`
	FilePath string `yaml:"path,omitempty"`
	JsonPath string `yaml:"jsonPath,omitempty"`
	Regex    string `yaml:"regex,omitempty"`
}

func (Output) GetFilePath

func (o Output) GetFilePath() string

func (Output) GetJsonPath

func (o Output) GetJsonPath() string

func (Output) GetName

func (o Output) GetName() string

func (Output) GetRegex

func (o Output) GetRegex() string

type Step

type Step struct {
	Instruction `yaml:"exec"`
}

func (Step) GetArguments

func (s Step) GetArguments() []string

func (Step) GetCommand

func (s Step) GetCommand() string

func (Step) GetFlags

func (s Step) GetFlags() builder.Flags

func (Step) GetOutputs

func (s Step) GetOutputs() []builder.Output

type TestMixin

type TestMixin struct {
	*Mixin
	TestContext *context.TestContext
}

func NewTestMixin

func NewTestMixin(t *testing.T) *TestMixin

NewTestMixin initializes a helm mixin, with the output buffered, and an in-memory file system.