shell

Documentation

Index

• Constants
• func BuildScript(t *hm.Task) string
• func BuildScriptFile(t *hm.Task) (string, error)
• func Factory(task *hm.Task) (hm.Runner, error)
• func LogFile(t *hm.Task) string
• func ScriptFile(t *hm.Task) string
• func WriteScriptFile(t *hm.Task, script string) error
• type Args
  • func NewArgs(args ...string) *Args
  • func (a *Args) Add(args ...string) *Args
• type Command
• type Executor
  • func Exec(t *hm.Task, command string, args ...string) *Executor
  • func ExecScript(t *hm.Task) *Executor
  • func (x *Executor) AddArgs(args ...string) *Executor
  • func (x *Executor) LogTo(filename string) *Executor
  • func (x *Executor) Mute() *Executor
  • func (x *Executor) MuteErr() *Executor
  • func (x *Executor) MuteOut() *Executor
  • func (x *Executor) MuteTask() *Executor
  • func (x *Executor) Run(sigCh <-chan os.Signal) (err error)
• type Runner
  • func (r *Runner) Run(sigCh <-chan os.Signal) (hm.TaskResult, error)
  • func (r *Runner) Signature() string
  • func (r *Runner) ValidateArtifacts() bool
• type Target

Constants

const (
	// ExecDriverName is the name of exec-driver
	ExecDriverName = "shell"
)

Functions

func BuildScript

func BuildScript(t *hm.Task) string

BuildScript generates script file according to cmds/script in target

func BuildScriptFile

func BuildScriptFile(t *hm.Task) (string, error)

BuildScriptFile generates the script file using default generated script

func Factory

func Factory(task *hm.Task) (hm.Runner, error)

Factory is runner factory

func LogFile

func LogFile(t *hm.Task) string

LogFile returns the fullpath to log filename

func ScriptFile

func ScriptFile(t *hm.Task) string

ScriptFile returns the filename of script

func WriteScriptFile

func WriteScriptFile(t *hm.Task, script string) error

WriteScriptFile builds the script file with provided script

Types

type Args

type Args struct {
	Args []string
}

Args build arguments

func NewArgs

func NewArgs(args ...string) *Args

NewArgs creates Args

func (*Args) Add

func (a *Args) Add(args ...string) *Args

Add appends arguments

type Command

type Command struct {
	Shell string                 `map:"*"`
	Ext   map[string]interface{} `map:"*"`
}

Command defines a single command to execute

type Executor

type Executor struct {
	Task        *hm.Task
	Cmd         *exec.Cmd
	Console     bool
	Stdout      bool
	Stderr      bool
	LogToTask   bool
	LogFileName string
}

Executor wraps over exec.Cmd with output file

func Exec

func Exec(t *hm.Task, command string, args ...string) *Executor

Exec executes an external command for a task

func ExecScript

func ExecScript(t *hm.Task) *Executor

ExecScript executes generated script

func (*Executor) AddArgs

func (x *Executor) AddArgs(args ...string) *Executor

AddArgs appends more arguments

func (*Executor) LogTo

func (x *Executor) LogTo(filename string) *Executor

LogTo overrides log file name

func (*Executor) Mute

func (x *Executor) Mute() *Executor

Mute disables the output

func (*Executor) MuteErr

func (x *Executor) MuteErr() *Executor

MuteErr disables the stderr

func (*Executor) MuteOut

func (x *Executor) MuteOut() *Executor

MuteOut disables the stdout

func (*Executor) MuteTask

func (x *Executor) MuteTask() *Executor

MuteTask stop sending output to task

func (*Executor) Run

func (x *Executor) Run(sigCh <-chan os.Signal) (err error)

Run starts the executor

type Runner

type Runner struct {
	Task *hm.Task
}

Runner is shell runner

func (*Runner) Run

func (r *Runner) Run(sigCh <-chan os.Signal) (hm.TaskResult, error)

Run implements Runner

func (*Runner) Signature

func (r *Runner) Signature() string

Signature implements Runner

func (*Runner) ValidateArtifacts

func (r *Runner) ValidateArtifacts() bool

ValidateArtifacts implements Runner

type Target

type Target struct {
	Console bool       `map:"console"`
	Env     []string   `map:"env"`
	Cmds    []*Command `map:"cmds"`
	Script  string     `map:"script"`
}

Target defines the schema of shell commands in target