exec

Documentation

Overview

Package exec provides an interface to execute certain commands.

Package exec provides an interface to execute certain commands.

Package exec is a generated GoMock package.

Package exec provides an interface to execute certain commands.

Package exec provides an interface to execute certain commands.

Package exec provides an interface to execute certain commands.

Package exec provides an interface to execute certain commands.

Index

• type Cmd
  • func NewCmd() *Cmd
  • func (c *Cmd) InteractiveRun(name string, args []string) error
  • func (c *Cmd) Run(name string, args []string, opts ...CmdOption) error
• type CmdOption
  • func Stderr(writer io.Writer) CmdOption
  • func Stdin(r io.Reader) CmdOption
  • func Stdout(writer io.Writer) CmdOption
• type Dockerfile
  • func NewDockerfile(fs afero.Fs, path string) *Dockerfile
  • func (df *Dockerfile) GetExposedPorts() ([]uint16, error)
  • func (df *Dockerfile) GetHealthCheck() (*HealthCheck, error)
• type ErrInvalidPort
  • func (e ErrInvalidPort) Error() string
• type ErrNoExpose
  • func (e ErrNoExpose) Error() string
• type ErrOutdatedSSMPlugin
  • func (e ErrOutdatedSSMPlugin) Error() string
• type ErrSSMPluginNotExist
  • func (e ErrSSMPluginNotExist) Error() string
• type HealthCheck
• type MockcmdRunner
  • func NewMockcmdRunner(ctrl *gomock.Controller) *MockcmdRunner
  • func (m *MockcmdRunner) EXPECT() *MockcmdRunnerMockRecorder
  • func (m *MockcmdRunner) Run() error
• type MockcmdRunnerMockRecorder
  • func (mr *MockcmdRunnerMockRecorder) Run() *gomock.Call
• type MockhttpClient
  • func NewMockhttpClient(ctrl *gomock.Controller) *MockhttpClient
  • func (m *MockhttpClient) EXPECT() *MockhttpClientMockRecorder
  • func (m *MockhttpClient) Get(url string) (*http.Response, error)
• type MockhttpClientMockRecorder
  • func (mr *MockhttpClientMockRecorder) Get(url interface{}) *gomock.Call
• type Mockrunner
  • func NewMockrunner(ctrl *gomock.Controller) *Mockrunner
  • func (m *Mockrunner) EXPECT() *MockrunnerMockRecorder
  • func (m *Mockrunner) InteractiveRun(name string, args []string) error
  • func (m *Mockrunner) Run(name string, args []string, options ...CmdOption) error
• type MockrunnerMockRecorder
  • func (mr *MockrunnerMockRecorder) InteractiveRun(name, args interface{}) *gomock.Call
  • func (mr *MockrunnerMockRecorder) Run(name, args interface{}, options ...interface{}) *gomock.Call
• type SSMPluginCommand
  • func NewSSMPluginCommand(s *session.Session) SSMPluginCommand
  • func (s SSMPluginCommand) InstallLatestBinary() error
  • func (s SSMPluginCommand) StartSession(ssmSess *ecs.Session) error
  • func (s SSMPluginCommand) ValidateBinary() error

Types

type Cmd

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

Cmd runs external commands, it wraps the exec.Command function from the stdlib so that running external commands can be unit tested.

func NewCmd

func NewCmd() *Cmd

NewCmd returns a Cmd that can run external commands. By default the output of the commands is piped to stderr.

func (*Cmd) InteractiveRun

func (c *Cmd) InteractiveRun(name string, args []string) error

InteractiveRun runs the input command that starts a child process.

func (*Cmd) Run

func (c *Cmd) Run(name string, args []string, opts ...CmdOption) error

Run starts the named command and waits until it finishes.

type CmdOption

type CmdOption func(cmd *exec.Cmd)

CmdOption is a type alias to configure a command.

func Stderr

func Stderr(writer io.Writer) CmdOption

Stderr sets the internal *exec.Cmd's Stderr field.

func Stdin

func Stdin(r io.Reader) CmdOption

Stdin sets the internal *exec.Cmd's Stdin field.

func Stdout

func Stdout(writer io.Writer) CmdOption

Stdout sets the internal *exec.Cmd's Stdout field.

type Dockerfile

type Dockerfile struct {
	ExposedPorts []portConfig
	HealthCheck  *HealthCheck
	// contains filtered or unexported fields
}

Dockerfile represents a parsed Dockerfile.

func NewDockerfile

func NewDockerfile(fs afero.Fs, path string) *Dockerfile

NewDockerfile returns an empty Dockerfile.

func (*Dockerfile) GetExposedPorts

func (df *Dockerfile) GetExposedPorts() ([]uint16, error)

GetExposedPorts returns a uint16 slice of exposed ports found in the Dockerfile.

func (*Dockerfile) GetHealthCheck

func (df *Dockerfile) GetHealthCheck() (*HealthCheck, error)

GetHealthCheck parses the HEALTHCHECK instruction from the Dockerfile and returns it. If the HEALTHCHECK is NONE or there is no instruction, returns nil.

type ErrInvalidPort

type ErrInvalidPort struct {
	Match string
}

ErrInvalidPort means that while there was a port provided, it was out of bounds or unparseable

func (ErrInvalidPort) Error

func (e ErrInvalidPort) Error() string

type ErrNoExpose

type ErrNoExpose struct {
	Dockerfile string
}

ErrNoExpose means there were no documented EXPOSE statements in the given dockerfile.

func (ErrNoExpose) Error

func (e ErrNoExpose) Error() string

type ErrOutdatedSSMPlugin

type ErrOutdatedSSMPlugin struct {
	CurrentVersion string
	LatestVersion  string
}

ErrOutdatedSSMPlugin means the ssm plugin is not up-to-date.

func (ErrOutdatedSSMPlugin) Error

func (e ErrOutdatedSSMPlugin) Error() string

type ErrSSMPluginNotExist

type ErrSSMPluginNotExist struct{}

ErrSSMPluginNotExist means the ssm plugin is not installed.

func (ErrSSMPluginNotExist) Error

func (e ErrSSMPluginNotExist) Error() string

type HealthCheck

type HealthCheck struct {
	Interval    time.Duration
	Timeout     time.Duration
	StartPeriod time.Duration
	Retries     int
	Cmd         []string
}

HealthCheck represents health check options for a Dockerfile.

type MockcmdRunner

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

MockcmdRunner is a mock of cmdRunner interface.

func NewMockcmdRunner

func NewMockcmdRunner(ctrl *gomock.Controller) *MockcmdRunner

NewMockcmdRunner creates a new mock instance.

func (*MockcmdRunner) EXPECT

func (m *MockcmdRunner) EXPECT() *MockcmdRunnerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockcmdRunner) Run

func (m *MockcmdRunner) Run() error

Run mocks base method.

type MockcmdRunnerMockRecorder

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

MockcmdRunnerMockRecorder is the mock recorder for MockcmdRunner.

func (*MockcmdRunnerMockRecorder) Run

func (mr *MockcmdRunnerMockRecorder) Run() *gomock.Call

Run indicates an expected call of Run.

type MockhttpClient

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

MockhttpClient is a mock of httpClient interface.

func NewMockhttpClient

func NewMockhttpClient(ctrl *gomock.Controller) *MockhttpClient

NewMockhttpClient creates a new mock instance.

func (*MockhttpClient) EXPECT

func (m *MockhttpClient) EXPECT() *MockhttpClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockhttpClient) Get

func (m *MockhttpClient) Get(url string) (*http.Response, error)

Get mocks base method.

type MockhttpClientMockRecorder

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

MockhttpClientMockRecorder is the mock recorder for MockhttpClient.

func (*MockhttpClientMockRecorder) Get

func (mr *MockhttpClientMockRecorder) Get(url interface{}) *gomock.Call

Get indicates an expected call of Get.

type Mockrunner

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

Mockrunner is a mock of runner interface.

func NewMockrunner

func NewMockrunner(ctrl *gomock.Controller) *Mockrunner

NewMockrunner creates a new mock instance.

func (*Mockrunner) EXPECT

func (m *Mockrunner) EXPECT() *MockrunnerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*Mockrunner) InteractiveRun

func (m *Mockrunner) InteractiveRun(name string, args []string) error

InteractiveRun mocks base method.

func (*Mockrunner) Run

func (m *Mockrunner) Run(name string, args []string, options ...CmdOption) error

Run mocks base method.

type MockrunnerMockRecorder

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

MockrunnerMockRecorder is the mock recorder for Mockrunner.

func (*MockrunnerMockRecorder) InteractiveRun

func (mr *MockrunnerMockRecorder) InteractiveRun(name, args interface{}) *gomock.Call

InteractiveRun indicates an expected call of InteractiveRun.

func (*MockrunnerMockRecorder) Run

func (mr *MockrunnerMockRecorder) Run(name, args interface{}, options ...interface{}) *gomock.Call

Run indicates an expected call of Run.

type SSMPluginCommand

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

SSMPluginCommand represents commands that can be run to trigger the ssm plugin.

func NewSSMPluginCommand

func NewSSMPluginCommand(s *session.Session) SSMPluginCommand

NewSSMPluginCommand returns a SSMPluginCommand.

func (SSMPluginCommand) InstallLatestBinary

func (s SSMPluginCommand) InstallLatestBinary() error

InstallLatestBinary installs the latest ssm plugin.

func (SSMPluginCommand) StartSession

func (s SSMPluginCommand) StartSession(ssmSess *ecs.Session) error

StartSession starts a session using the ssm plugin.

func (SSMPluginCommand) ValidateBinary

func (s SSMPluginCommand) ValidateBinary() error

ValidateBinary validates if the ssm plugin exists and needs update.