execute

Documentation

Overview

Package execute tries it's best to run complex, sometimes multiline bash commands.

Index

• Variables
• func Command(cmdString string, stdOut io.Writer, stdErr io.Writer, envs map[string]string) (int, error)
• func CommandNoWait(cmdString string, stdOut io.Writer, stdErr io.Writer, envs map[string]string) (*exec.Cmd, error)
• func GetExitStatus(waitError error) int
• func WaitNoop(interrupt chan os.Signal, cmd *exec.Cmd)
• type SSH
  • func NewSSH(conf *SSHConfig, stdin io.Reader, stdout, stderr io.Writer) (*SSH, error)
  • func (s *SSH) RunCommand(cmd string, envs map[string]string) error
• type SSHConfig

Variables

var (
	// Debug prints the command being run if set to true.
	Debug = false
)

Functions

func Command

func Command(cmdString string, stdOut io.Writer, stdErr io.Writer, envs map[string]string) (int, error)

Command just executes a given cmd string to the supplied io.Writer writers. If optional envs is passed in then the expanded values will be used vs the os versions.

func CommandNoWait

func CommandNoWait(cmdString string, stdOut io.Writer, stdErr io.Writer, envs map[string]string) (*exec.Cmd, error)

CommandNoWait starts the given command but does not wait for it to finish. It returns the created exec.Command which can be used with Wait.

func GetExitStatus

func GetExitStatus(waitError error) int

GetExitStatus determines the exit status code of an err from a command that was run.

func WaitNoop

func WaitNoop(interrupt chan os.Signal, cmd *exec.Cmd)

WaitNoop accepts and waits on any signal and returns on kill signals.

Types

type SSH

type SSH struct {
	Config *SSHConfig
	Stdin  io.Reader
	Stdout io.Writer
	Stderr io.Writer
}

SSH holds the ssh configuration and io.

func NewSSH

func NewSSH(conf *SSHConfig, stdin io.Reader, stdout, stderr io.Writer) (*SSH, error)

NewSSH will initialize a new ssh configuration for use with RunCommand. This assumes an ssh agent is available and the proper keys have been added with ssh-add. You can check added keys with ssh-add -L

func (*SSH) RunCommand

func (s *SSH) RunCommand(cmd string, envs map[string]string) error

RunCommand will execute a command using the input environment variables. It will establish a new session on every call.

type SSHConfig

type SSHConfig struct {
	Host         string `json:"host" yaml:"host"`
	Port         int    `json:"port" yaml:"port"`
	User         string `json:"user" yaml:"user"`
	ProxyHost    string `json:"proxy_host,omitempty" yaml:"proxy_host,omitempty"`
	ProxyPort    int    `json:"proxy_port,omitempty" yaml:"proxy_port,omitempty"`
	ProxyUser    string `json:"proxy_user,omitempty" yaml:"proxy_user,omitempty"`
	IdentityFile string `json:"identity_file,omitempty" yaml:"identity_file,omitempty"`
}

SSHConfig is an individual ssh configuration for creating a connection.