shell

Documentation

Index

• type ErrEmptyCommand
  • func (e *ErrEmptyCommand) Error() string
• type ExecutionFailedError
  • func (e *ExecutionFailedError) Error() string
• type MockCommandExecutor
  • func (mce *MockCommandExecutor) ExecuteCommand(cmd command) (commandResult, error)
• type Shell
  • func New(spec interface{}) (*Shell, error)
  • func (s *Shell) Changelog() string
  • func (s *Shell) Condition(source string) (bool, error)
  • func (s *Shell) ConditionFromSCM(source string, scm scm.ScmHandler) (bool, error)
  • func (s *Shell) Source(workingDir string) (string, error)
  • func (s *Shell) Target(source string, dryRun bool) (bool, error)
  • func (s *Shell) TargetFromSCM(source string, scm scm.ScmHandler, dryRun bool) (bool, []string, string, error)
• type Spec

Types

type ErrEmptyCommand

type ErrEmptyCommand struct{}

func (*ErrEmptyCommand) Error

func (e *ErrEmptyCommand) Error() string

type ExecutionFailedError

type ExecutionFailedError struct{}

func (*ExecutionFailedError) Error

func (e *ExecutionFailedError) Error() string

type MockCommandExecutor

type MockCommandExecutor struct {
	GotCommand command
	Result     commandResult
	Err        error
}

MockCommandExecutor is a stub implementation of the `commandExecutor` interface to be used in our test suite. It stores the received `command` and returns the preconfigured `result` and `err`.

func (*MockCommandExecutor) ExecuteCommand

func (mce *MockCommandExecutor) ExecuteCommand(cmd command) (commandResult, error)

type Shell

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

Shell defines a resource of kind "shell"

func New

func New(spec interface{}) (*Shell, error)

New returns a reference to a newly initialized Shell object from a ShellSpec or an error if the provided ShellSpec triggers a validation error.

func (*Shell) Changelog

func (s *Shell) Changelog() string

Changelog returns the changelog for this resource, or an empty string if not supported

func (*Shell) Condition

func (s *Shell) Condition(source string) (bool, error)

Condition tests if the provided command (concatenated with the source) is executed with success

func (*Shell) ConditionFromSCM

func (s *Shell) ConditionFromSCM(source string, scm scm.ScmHandler) (bool, error)

ConditionFromSCM tests if the provided command (concatenated with the source) is executed with success from the SCM root directory

func (*Shell) Source

func (s *Shell) Source(workingDir string) (string, error)

Source returns the stdout of the shell command if its exit code is 0 otherwise an error is returned with the content of stderr

func (*Shell) Target

func (s *Shell) Target(source string, dryRun bool) (bool, error)

func (*Shell) TargetFromSCM

func (s *Shell) TargetFromSCM(source string, scm scm.ScmHandler, dryRun bool) (bool, []string, string, error)

type Spec

type Spec struct {
	Command string
}

Spec defines a specification for a "shell" resource parsed from an updatecli manifest file