exec

Documentation

Overview

Package exec provides utilities to execute commands.

Index

• func Exec(ctx context.Context, name string, args ...string) error
• func IsRunning(pid int) bool
• func KillProcess(pid int) error
• func LookPath(file string) (string, error)
• func ParseVersionFromBinary(ctx context.Context, path string) (version.Version, error)
• func ParseVersionFromImage(ctx context.Context, runtime string, image string, command string) (version.Version, error)
• func WithAllWriteTo(ctx context.Context, w io.Writer) context.Context
• func WithAllWriteToErrOut(ctx context.Context) context.Context
• func WithDir(ctx context.Context, dir string) context.Context
• func WithEnv(ctx context.Context, env []string) context.Context
• func WithFork(ctx context.Context, fork bool) context.Context
• func WithIOStreams(ctx context.Context, streams IOStreams) context.Context
• func WithPipeStdin(ctx context.Context, pipeStdin bool) context.Context
• func WithReadFrom(ctx context.Context, r io.Reader) context.Context
• func WithReadWriter(ctx context.Context, rw io.ReadWriter) context.Context
• func WithStdIO(ctx context.Context) context.Context
• func WithUser(ctx context.Context, uid, gid *int64) context.Context
• func WithWriteTo(ctx context.Context, w io.Writer) context.Context
• type Cmd
  • func Command(ctx context.Context, name string, args ...string) (cmd *Cmd, err error)
• type IOStreams
• type Options
  • func GetExecOptions(ctx context.Context) *Options

Functions

func Exec

func Exec(ctx context.Context, name string, args ...string) error

Exec executes the given command and returns the output.

func IsRunning

func IsRunning(pid int) bool

IsRunning returns true if the process is running.

func KillProcess

func KillProcess(pid int) error

KillProcess kills the process with the given pid.

func LookPath

func LookPath(file string) (string, error)

LookPath is a wrapper around exec.LookPath.

func ParseVersionFromBinary

func ParseVersionFromBinary(ctx context.Context, path string) (version.Version, error)

ParseVersionFromBinary parses the version from the binary.

func ParseVersionFromImage

func ParseVersionFromImage(ctx context.Context, runtime string, image string, command string) (version.Version, error)

ParseVersionFromImage parses the version from the image.

func WithAllWriteTo

func WithAllWriteTo(ctx context.Context, w io.Writer) context.Context

WithAllWriteTo returns a context with the given io.Writer as the In, Out, and ErrOut streams.

func WithAllWriteToErrOut

func WithAllWriteToErrOut(ctx context.Context) context.Context

WithAllWriteToErrOut returns a context with the given io.Writer as the ErrOut stream.

func WithDir

func WithDir(ctx context.Context, dir string) context.Context

WithDir returns a context with the given working directory.

func WithEnv

func WithEnv(ctx context.Context, env []string) context.Context

WithEnv returns a context with the given environment variables.

func WithFork

func WithFork(ctx context.Context, fork bool) context.Context

WithFork returns a context with the given fork option.

func WithIOStreams

func WithIOStreams(ctx context.Context, streams IOStreams) context.Context

WithIOStreams returns a context with the given IOStreams.

func WithPipeStdin

func WithPipeStdin(ctx context.Context, pipeStdin bool) context.Context

WithPipeStdin returns a context with the given pipeStdin option.

func WithReadFrom

func WithReadFrom(ctx context.Context, r io.Reader) context.Context

WithReadFrom returns a context with the given io.Reader as the In stream.

func WithReadWriter

func WithReadWriter(ctx context.Context, rw io.ReadWriter) context.Context

WithReadWriter returns a context with the given io.ReadWriter as the In and Out streams.

func WithStdIO

func WithStdIO(ctx context.Context) context.Context

WithStdIO returns a context with the standard IOStreams.

func WithUser

func WithUser(ctx context.Context, uid, gid *int64) context.Context

WithUser returns a context with the given username and group name.

func WithWriteTo

func WithWriteTo(ctx context.Context, w io.Writer) context.Context

WithWriteTo returns a context with the given io.Writer as the Out stream.

Types

type Cmd

type Cmd = exec.Cmd

func Command

func Command(ctx context.Context, name string, args ...string) (cmd *Cmd, err error)

Command executes the given command and return the command.

type IOStreams

type IOStreams struct {
	// In think, os.Stdin
	In io.Reader
	// Out think, os.Stdout
	Out io.Writer
	// ErrOut think, os.Stderr
	ErrOut io.Writer
}

IOStreams contains the standard streams.

type Options

type Options struct {
	// Dir is the working directory of the command.
	Dir string
	// Env is the environment variables of the command.
	Env []string
	// UID is the user id of the command
	UID *int64
	// GID is the group id of the command
	GID *int64
	// IOStreams contains the standard streams.
	IOStreams
	// PipeStdin is true if the command's stdin should be piped.
	PipeStdin bool
	// Fork is true if the command should be forked.
	Fork bool
}

Options is the options for executing a command.

func GetExecOptions

func GetExecOptions(ctx context.Context) *Options

GetExecOptions returns the ExecOptions for the given context.