localexec

Documentation

Overview

Package localexec provides constructs for uniform execution of local processes, specifically conversion from model.Cmd to exec.Cmd.

Index

• func OneShotToLogger(ctx context.Context, execer Execer, cmd model.Cmd) error
• type Env
  • func DefaultEnv(port model.WebPort, host model.WebHost) *Env
  • func EmptyEnv() *Env
  • func (e *Env) Add(k, v string)
  • func (e *Env) ExecCmd(cmd model.Cmd, l logger.Logger) (*exec.Cmd, error)
• type Execer
• type FakeCall
  • func (f FakeCall) String() string
• type FakeExecer
  • func NewFakeExecer(t testing.TB) *FakeExecer
  • func (f *FakeExecer) Calls() []FakeCall
  • func (f *FakeExecer) RegisterCommand(cmd string, exitCode int, stdout string, stderr string)
  • func (f *FakeExecer) RegisterCommandBytes(cmd string, exitCode int, stdout []byte, stderr []byte)
  • func (f *FakeExecer) RegisterCommandError(cmd string, err error)
  • func (f *FakeExecer) Run(ctx context.Context, cmd model.Cmd, runIO RunIO) (exitCode int, err error)
• type OneShotResult
  • func OneShot(ctx context.Context, execer Execer, cmd model.Cmd) (OneShotResult, error)
• type ProcessExecer
  • func NewProcessExecer(env *Env) *ProcessExecer
  • func (p ProcessExecer) Run(ctx context.Context, cmd model.Cmd, runIO RunIO) (int, error)
• type RunIO

Functions

func OneShotToLogger

func OneShotToLogger(ctx context.Context, execer Execer, cmd model.Cmd) error

Types

type Env

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

Common environment for local exec commands.

func DefaultEnv

func DefaultEnv(port model.WebPort, host model.WebHost) *Env

func EmptyEnv

func EmptyEnv() *Env

func (*Env) Add

func (e *Env) Add(k, v string)

func (*Env) ExecCmd

func (e *Env) ExecCmd(cmd model.Cmd, l logger.Logger) (*exec.Cmd, error)

ExecCmd creates a stdlib exec.Cmd instance suitable for execution by the local engine.

The resulting command will inherit the parent process (i.e. `tilt`) environment, then have command specific environment overrides applied, and finally, additional conditional environment to improve logging output.

NOTE: To avoid confusion with ExecCmdContext, this method accepts a logger instance directly rather than using logger.Get(ctx); the returned exec.Cmd from this function will NOT be associated with any context.

type Execer

type Execer interface {
	// Run executes a command and waits for it to complete.
	//
	// If the context is canceled before the process terminates, the process will be killed.
	Run(ctx context.Context, cmd model.Cmd, runIO RunIO) (int, error)
}

type FakeCall

type FakeCall struct {
	Cmd      model.Cmd
	ExitCode int
	Error    error
}

func (FakeCall) String

func (f FakeCall) String() string

type FakeExecer

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

func NewFakeExecer

func NewFakeExecer(t testing.TB) *FakeExecer

func (*FakeExecer) Calls

func (f *FakeExecer) Calls() []FakeCall

func (*FakeExecer) RegisterCommand

func (f *FakeExecer) RegisterCommand(cmd string, exitCode int, stdout string, stderr string)

RegisterCommand adds or replaces a command to the FakeExecer.

If the output strings are not newline terminated, a newline will automatically be added. If this behavior is not desired, use `RegisterCommandBytes`.

func (*FakeExecer) RegisterCommandBytes

func (f *FakeExecer) RegisterCommandBytes(cmd string, exitCode int, stdout []byte, stderr []byte)

RegisterCommandBytes adds or replaces a command to the FakeExecer.

The output values will be used exactly as-is, so can be used to simulate processes that do not newline terminate etc.

func (*FakeExecer) RegisterCommandError

func (f *FakeExecer) RegisterCommandError(cmd string, err error)

func (*FakeExecer) Run

func (f *FakeExecer) Run(ctx context.Context, cmd model.Cmd, runIO RunIO) (exitCode int, err error)

type OneShotResult

type OneShotResult struct {
	// ExitCode from the process
	ExitCode int
	// Stdout from the process
	Stdout []byte
	// Stderr from the process
	Stderr []byte
}

OneShotResult includes details about command execution.

func OneShot

func OneShot(ctx context.Context, execer Execer, cmd model.Cmd) (OneShotResult, error)

type ProcessExecer

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

func NewProcessExecer

func NewProcessExecer(env *Env) *ProcessExecer

func (ProcessExecer) Run

func (p ProcessExecer) Run(ctx context.Context, cmd model.Cmd, runIO RunIO) (int, error)

type RunIO

type RunIO struct {
	// Stdin for the process
	Stdin io.Reader
	// Stdout for the process
	Stdout io.Writer
	// Stderr for the process
	Stderr io.Writer
}