shell

Documentation

Index

• type ErrEmptyCommand
  • func (e *ErrEmptyCommand) Error() string
• type Shell
  • func New(spec ShellSpec) (*Shell, error)
  • func (s *Shell) Condition(source string) (bool, error)
  • func (s *Shell) ConditionFromSCM(source string, scm scm.Scm) (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.Scm, dryRun bool) (changed bool, commands []string, message string, err error)
• type ShellSpec

Types

type ErrEmptyCommand

type ErrEmptyCommand struct{}

func (*ErrEmptyCommand) Error

func (e *ErrEmptyCommand) Error() string

type Shell

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

func New

func New(spec ShellSpec) (*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) 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.Scm) (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.Scm, dryRun bool) (changed bool, commands []string, message string, err error)

type ShellSpec

type ShellSpec struct {
	Command string
}