shell

Documentation

Index

• Constants
• Variables
• func ContextWithTerraformCommandHook(ctx context.Context, fn RunShellCommandFunc) context.Context
• func ExplainError(err error) string
• func GetExitCode(err error) (int, error)
• func GitLastReleaseTag(ctx context.Context, opts *options.TerragruntOptions, gitRepo *url.URL) (string, error)
• func GitRepoTags(ctx context.Context, opts *options.TerragruntOptions, gitRepo *url.URL) ([]string, error)
• func GitTopLevelDir(ctx context.Context, terragruntOptions *options.TerragruntOptions, path string) (string, error)
• func PrepareConsole(terragruntOptions *options.TerragruntOptions)
• func PromptUserForInput(prompt string, terragruntOptions *options.TerragruntOptions) (string, error)
• func PromptUserForYesNo(prompt string, terragruntOptions *options.TerragruntOptions) (bool, error)
• func RegisterSignalHandler(notifyFn func(os.Signal), sigs ...os.Signal)
• func RunShellCommand(ctx context.Context, terragruntOptions *options.TerragruntOptions, ...) error
• func RunTerraformCommand(ctx context.Context, terragruntOptions *options.TerragruntOptions, ...) error
• type CmdOutput
  • func RunShellCommandWithOutput(ctx context.Context, terragruntOptions *options.TerragruntOptions, ...) (*CmdOutput, error)
  • func RunTerraformCommandWithOutput(ctx context.Context, terragruntOptions *options.TerragruntOptions, ...) (*CmdOutput, error)
• type ProcessExecutionError
  • func (err ProcessExecutionError) Error() string
  • func (err ProcessExecutionError) ExitStatus() (int, error)
• type RunShellCommandFunc
  • func TerraformCommandHookFromContext(ctx context.Context) RunShellCommandFunc
• type SignalsForwarder
  • func NewSignalsForwarder(signals []os.Signal, c *exec.Cmd, logger *logrus.Entry, cmdChannel chan error) SignalsForwarder
  • func (signalChannel *SignalsForwarder) Close() error

Constants

const SignalForwardingDelay = time.Second * 30

The signal can be sent to the main process (only `terragrunt`) as well as the process group (`terragrunt` and `terraform`), for example: kill -INT <pid> # sends SIGINT only to the main process kill -INT -<pid> # sends SIGINT to the process group Since we cannot know how the signal is sent, we should give `terraform` time to gracefully exit if it receives the signal directly from the shell, to avoid sending the second interrupt signal to `terraform`.

const TerraformCommandContextKey ctxKey = iota

Variables

var InterruptSignals []os.Signal = []os.Signal{syscall.SIGTERM, syscall.SIGINT}

Functions

func ContextWithTerraformCommandHook

func ContextWithTerraformCommandHook(ctx context.Context, fn RunShellCommandFunc) context.Context

func ExplainError

func ExplainError(err error) string

ExplainError will try to explain the error to the user, if we know how to do so.

func GetExitCode

func GetExitCode(err error) (int, error)

Return the exit code of a command. If the error does not implement iErrorCode or is not an exec.ExitError or *multierror.Error type, the error is returned.

func GitLastReleaseTag

func GitLastReleaseTag(ctx context.Context, opts *options.TerragruntOptions, gitRepo *url.URL) (string, error)

GitLastReleaseTag - fetch git repository last release tag

func GitRepoTags

func GitRepoTags(ctx context.Context, opts *options.TerragruntOptions, gitRepo *url.URL) ([]string, error)

GitRepoTags - fetch git repository tags from passed url

func GitTopLevelDir

func GitTopLevelDir(ctx context.Context, terragruntOptions *options.TerragruntOptions, path string) (string, error)

GitTopLevelDir - fetch git repository path from passed directory

func PrepareConsole

func PrepareConsole(terragruntOptions *options.TerragruntOptions)

func PromptUserForInput

func PromptUserForInput(prompt string, terragruntOptions *options.TerragruntOptions) (string, error)

Prompt the user for text in the CLI. Returns the text entered by the user.

func PromptUserForYesNo

func PromptUserForYesNo(prompt string, terragruntOptions *options.TerragruntOptions) (bool, error)

Prompt the user for a yes/no response and return true if they entered yes.

func RegisterSignalHandler

func RegisterSignalHandler(notifyFn func(os.Signal), sigs ...os.Signal)

RegisterSignalHandler registers a handler of interrupt signal from the OS. When signal is receiving, it calls the given callback func `notifyFn`.

func RunShellCommand

func RunShellCommand(ctx context.Context, terragruntOptions *options.TerragruntOptions, command string, args ...string) error

Run the given shell command

func RunTerraformCommand

func RunTerraformCommand(ctx context.Context, terragruntOptions *options.TerragruntOptions, args ...string) error

Run the given Terraform command

Types

type CmdOutput

type CmdOutput struct {
	Stdout string
	Stderr string
}

func RunShellCommandWithOutput

func RunShellCommandWithOutput(
	ctx context.Context,
	terragruntOptions *options.TerragruntOptions,
	workingDir string,
	suppressStdout bool,
	allocatePseudoTty bool,
	command string,
	args ...string,
) (*CmdOutput, error)

Run the specified shell command with the specified arguments. Connect the command's stdin, stdout, and stderr to the currently running app. The command can be executed in a custom working directory by using the parameter `workingDir`. Terragrunt working directory will be assumed if empty string.

func RunTerraformCommandWithOutput

func RunTerraformCommandWithOutput(ctx context.Context, terragruntOptions *options.TerragruntOptions, args ...string) (*CmdOutput, error)

Run the given Terraform command, writing its stdout/stderr to the terminal AND returning stdout/stderr to this method's caller

type ProcessExecutionError

type ProcessExecutionError struct {
	Err        error
	StdOut     string
	Stderr     string
	WorkingDir string
}

ProcessExecutionError - error returned when a command fails, contains StdOut and StdErr

func (ProcessExecutionError) Error

func (err ProcessExecutionError) Error() string

func (ProcessExecutionError) ExitStatus

func (err ProcessExecutionError) ExitStatus() (int, error)

type RunShellCommandFunc

type RunShellCommandFunc func(ctx context.Context, opts *options.TerragruntOptions, args []string) error

func TerraformCommandHookFromContext

func TerraformCommandHookFromContext(ctx context.Context) RunShellCommandFunc

type SignalsForwarder

type SignalsForwarder chan os.Signal

func NewSignalsForwarder

func NewSignalsForwarder(signals []os.Signal, c *exec.Cmd, logger *logrus.Entry, cmdChannel chan error) SignalsForwarder

Forwards signals to a command, waiting for the command to finish.

func (*SignalsForwarder) Close

func (signalChannel *SignalsForwarder) Close() error