execcmd

Documentation

Index

• func ExecCmd(ctx context.Context, command string, args ...string) error
• func ExecCmdContainer(ctx context.Context, le *logrus.Entry, dockerClient client.APIClient, ...) error
• func InspectExecExit(ctx context.Context, inspector ExecInspector, execID string) error
• func NewInStream(in io.Reader, closeReader bool) io.ReadCloser
• func NewOutStream(le *logrus.Entry, out io.Writer) io.Writer
• type CommandExitError
  • func NewCommandExitError(exitCode int) *CommandExitError
  • func (e *CommandExitError) Error() string
  • func (e *CommandExitError) ExitCode() int
• type CommonStream
  • func (s *CommonStream) FD() uintptr
  • func (s *CommonStream) IsTerminal() bool
  • func (s *CommonStream) RestoreTerminal() error
  • func (s *CommonStream) SetIsTerminal(isTerminal bool)
  • func (s *CommonStream) SetRawMode() error
• type ExecInspector
• type HijackedIOStreamer
  • func NewHijackedIOStreamer(le *logrus.Entry, resp types.HijackedResponse, useTTY bool) *HijackedIOStreamer
  • func (h *HijackedIOStreamer) Stream(ctx context.Context) error
• type InStream
  • func (i *InStream) Close() error
  • func (i *InStream) IsTTY() bool
  • func (i *InStream) Read(p []byte) (int, error)
• type OutStream
  • func (o *OutStream) GetTTYSize() (uint, uint)
  • func (o *OutStream) Write(p []byte) (int, error)

Functions

func ExecCmd

func ExecCmd(ctx context.Context, command string, args ...string) error

ExecCmd executes a local command with inherited standard output and error.

func ExecCmdContainer

func ExecCmdContainer(
	ctx context.Context,
	le *logrus.Entry,
	dockerClient client.APIClient,
	containerID string,
	userID string,
	stdIn io.Reader,
	stdOut io.Writer,
	stdErr io.Writer,
	cmd string,
	args ...string,
) error

ExecCmdContainer executes a command in a Docker container and returns its exit status.

func InspectExecExit

func InspectExecExit(ctx context.Context, inspector ExecInspector, execID string) error

InspectExecExit returns an error when the Docker exec process did not exit successfully.

func NewInStream

func NewInStream(in io.Reader, closeReader bool) io.ReadCloser

NewInStream constructs an input stream around a reader.

func NewOutStream

func NewOutStream(le *logrus.Entry, out io.Writer) io.Writer

NewOutStream constructs an output stream around a writer.

Types

type CommandExitError

type CommandExitError struct {
	// contains filtered or unexported fields
}

CommandExitError reports a non-zero Docker exec exit status.

func NewCommandExitError

func NewCommandExitError(exitCode int) *CommandExitError

NewCommandExitError constructs an error for a non-zero Docker exec exit status.

func (*CommandExitError) Error

func (e *CommandExitError) Error() string

Error returns the command exit error message.

func (*CommandExitError) ExitCode

func (e *CommandExitError) ExitCode() int

ExitCode returns the Docker exec exit status.

type CommonStream

type CommonStream struct {
	// contains filtered or unexported fields
}

CommonStream tracks terminal state shared by input and output streams.

func (*CommonStream) FD

func (s *CommonStream) FD() uintptr

FD returns the stream file descriptor.

func (*CommonStream) IsTerminal

func (s *CommonStream) IsTerminal() bool

IsTerminal reports whether the stream is connected to a terminal.

func (*CommonStream) RestoreTerminal

func (s *CommonStream) RestoreTerminal() error

RestoreTerminal restores the terminal mode saved by SetRawMode.

func (*CommonStream) SetIsTerminal

func (s *CommonStream) SetIsTerminal(isTerminal bool)

SetIsTerminal overrides whether the stream is connected to a terminal.

func (*CommonStream) SetRawMode

func (s *CommonStream) SetRawMode() error

SetRawMode places the terminal in raw mode.

type ExecInspector

type ExecInspector interface {
	ContainerExecInspect(context.Context, string) (container.ExecInspect, error)
}

ExecInspector inspects the state of a Docker exec process.

type HijackedIOStreamer

type HijackedIOStreamer struct {
	InputStream  io.ReadCloser
	OutputStream io.Writer
	ErrorStream  io.Writer
	Resp         types.HijackedResponse
	TTY          bool
	// contains filtered or unexported fields
}

HijackedIOStreamer copies input and output over a Docker hijacked connection.

func NewHijackedIOStreamer

func NewHijackedIOStreamer(
	le *logrus.Entry,
	resp types.HijackedResponse,
	useTTY bool,
) *HijackedIOStreamer

NewHijackedIOStreamer constructs a streamer for a Docker hijacked connection.

func (*HijackedIOStreamer) Stream

func (h *HijackedIOStreamer) Stream(ctx context.Context) error

Stream copies stdin, stdout, and stderr until the command, input, or context ends.

type InStream

type InStream struct {
	CommonStream
	// contains filtered or unexported fields
}

InStream reads command input and optionally owns the underlying reader.

func (*InStream) Close

func (i *InStream) Close() error

Close closes the underlying reader when ownership was requested.

func (*InStream) IsTTY

func (i *InStream) IsTTY() bool

IsTTY reports whether the input is a terminal.

func (*InStream) Read

func (i *InStream) Read(p []byte) (int, error)

Read reads from the underlying input.

type OutStream

type OutStream struct {
	CommonStream
	// contains filtered or unexported fields
}

OutStream writes command output and exposes terminal dimensions.

func (*OutStream) GetTTYSize

func (o *OutStream) GetTTYSize() (uint, uint)

GetTTYSize returns the terminal height and width in characters.

func (*OutStream) Write

func (o *OutStream) Write(p []byte) (int, error)

Write writes output to the underlying writer.