command

README

Command

Executes a command with a timeout.

Documentation

Index

• func ExecForJSON(command string, args []string, obj interface{}, timeout time.Duration, log Log) error
• type Log
• type Program
  • func (p Program) ArgsWith(args []string) []string
• type Result
  • func Exec(name string, args []string, timeout time.Duration, log Log) (Result, error)
  • func ExecWithEnv(name string, args []string, env []string, timeout time.Duration, log Log) (Result, error)
  • func (r Result) CombinedOutput() string

Functions

func ExecForJSON

func ExecForJSON(command string, args []string, obj interface{}, timeout time.Duration, log Log) error

ExecForJSON runs a command (with timeout) expecting JSON output with obj interface

Types

type Log

type Log interface {
	Debugf(s string, args ...interface{})
	Infof(s string, args ...interface{})
	Warningf(s string, args ...interface{})
	Errorf(s string, args ...interface{})
}

Log is the logging interface for the command package

type Program

type Program struct {
	Path string
	Args []string
}

Program is a program at path with arguments

func (Program) ArgsWith

func (p Program) ArgsWith(args []string) []string

ArgsWith returns program args with passed in args

type Result

type Result struct {
	Stdout  bytes.Buffer
	Stderr  bytes.Buffer
	Process *os.Process
}

Result is the result of running a command

func Exec

func Exec(name string, args []string, timeout time.Duration, log Log) (Result, error)

Exec runs a command and returns the stdout/err output and error if any

func ExecWithEnv

func ExecWithEnv(name string, args []string, env []string, timeout time.Duration, log Log) (Result, error)

ExecWithEnv runs a command with an environment and returns the stdout/err output and error if any

func (Result) CombinedOutput

func (r Result) CombinedOutput() string

CombinedOutput returns Stdout and Stderr as a single string.