feat: removal of deprecated hcl attributes skip, retryable_errors (#5033)

* feat: removal of deprecated hcl attributes

* removal of deprecated hcl attributes

* added retries validation

* added migration guide

* Failing tests fixes

* Integration test fix

* docs attributes fixes

* Add tests for missing functionality

* chore: tests simplification

* chrore: tests simplifications

* improved error checking

* docs: deprecation docs cleanup

* PR comments

* Fixed links

Author: denis256

cli/commands/run/errors.go

@@ -2,7 +2,6 @@ package run
 
 import (
 	"fmt"
-	"strings"
 
 	"github.com/gruntwork-io/terragrunt/options"
 )
@@ -50,13 +49,7 @@ func (err ModuleIsProtected) Error() string {
 	return fmt.Sprintf("Unit is protected by the prevent_destroy flag in %s. Set it to false or remove it to allow destruction of the unit.", err.Opts.TerragruntConfigPath)
 }
 
-type MaxRetriesExceeded struct {
-	Opts *options.TerragruntOptions
-}
-
-func (err MaxRetriesExceeded) Error() string {
-	return fmt.Sprintf("Exhausted retries (%v) for command %v %v", err.Opts.RetryMaxAttempts, err.Opts.TFPath, strings.Join(err.Opts.TerraformCliArgs, " "))
-}
+// Legacy retry error removed in favor of error handling via options.Errors
 
 type RunAllDisabledErr struct {
 	command string

cli/commands/run/run.go

@@ -10,7 +10,6 @@ import (
 	"regexp"
 	"strings"
 	"sync"
-	"time"
 
 	"github.com/gruntwork-io/terragrunt/internal/runner"
 
@@ -147,15 +146,6 @@ func run(ctx context.Context, l log.Logger, opts *options.TerragruntOptions, r *
 		return target.runErrorCallback(l, opts, terragruntConfig, err)
 	}
 
-	if terragruntConfig.Skip != nil && *terragruntConfig.Skip {
-		l.Infof(
-			"Skipping terragrunt module %s due to skip = true.",
-			opts.TerragruntConfigPath,
-		)
-
-		return nil
-	}
-
 	// We merge the OriginalIAMRoleOptions into the one from the config, because the CLI passed IAMRoleOptions has
 	// precedence.
 	opts.IAMRoleOptions = options.MergeIAMRoleOptions(
@@ -181,27 +171,6 @@ func run(ctx context.Context, l log.Logger, opts *options.TerragruntOptions, r *
 		opts.DownloadDir = terragruntConfig.DownloadDir
 	}
 
-	// Override the default value of retryable errors using the value set in the config file
-	if terragruntConfig.RetryableErrors != nil {
-		opts.RetryableErrors = terragruntConfig.RetryableErrors
-	}
-
-	if terragruntConfig.RetryMaxAttempts != nil {
-		if *terragruntConfig.RetryMaxAttempts < 1 {
-			return fmt.Errorf("cannot have less than 1 max retry, but you specified %d", *terragruntConfig.RetryMaxAttempts)
-		}
-
-		opts.RetryMaxAttempts = *terragruntConfig.RetryMaxAttempts
-	}
-
-	if terragruntConfig.RetrySleepIntervalSec != nil {
-		if *terragruntConfig.RetrySleepIntervalSec < 0 {
-			return fmt.Errorf("cannot sleep for less than 0 seconds, but you specified %d", *terragruntConfig.RetrySleepIntervalSec)
-		}
-
-		opts.RetrySleepInterval = time.Duration(*terragruntConfig.RetrySleepIntervalSec) * time.Second
-	}
-
 	updatedTerragruntOptions := opts
 
 	sourceURL, err := config.GetTerraformSourceURL(opts, terragruntConfig)
@@ -365,7 +334,8 @@ func runTerragruntWithConfig(
 	}
 
 	return RunActionWithHooks(ctx, l, "terraform", opts, cfg, r, func(ctx context.Context) error {
-		runTerraformError := RunTerraformWithRetry(ctx, l, opts, r)
+		// Execute the underlying command once; retries and ignores are handled by outer RunWithErrorHandling
+		out, runTerraformError := tf.RunCommandWithOutput(ctx, l, opts, opts.TerraformCliArgs...)
 
 		var lockFileError error
 		if ShouldCopyLockFile(opts.TerraformCliArgs, cfg.Terraform) {
@@ -379,6 +349,13 @@ func runTerragruntWithConfig(
 			lockFileError = config.CopyLockFile(l, opts, opts.WorkingDir, originalOpts.WorkingDir)
 		}
 
+		// If command failed, log a helpful message
+		if runTerraformError != nil {
+			if out == nil {
+				l.Errorf("%s invocation failed in %s", opts.TerraformImplementation, opts.WorkingDir)
+			}
+		}
+
 		return multierror.Append(runTerraformError, lockFileError).ErrorOrNil()
 	})
 }
@@ -493,54 +470,6 @@ func SetTerragruntInputsAsEnvVars(l log.Logger, opts *options.TerragruntOptions,
 	return nil
 }
 
-func RunTerraformWithRetry(ctx context.Context, l log.Logger, opts *options.TerragruntOptions, r *report.Report) error {
-	// Retry the command configurable time with sleep in between
-	for range opts.RetryMaxAttempts {
-		if out, err := tf.RunCommandWithOutput(ctx, l, opts, opts.TerraformCliArgs...); err != nil {
-			if out == nil || !IsRetryable(opts, out) {
-				l.Errorf("%s invocation failed in %s", opts.TerraformImplementation, opts.WorkingDir)
-
-				return err
-			} else {
-				l.Infof("Encountered an error eligible for retrying. Sleeping %v before retrying.\n", opts.RetrySleepInterval)
-				// Reset the exit code to success so that we can retry the command
-				if exitCode := tf.DetailedExitCodeFromContext(ctx); exitCode != nil {
-					exitCode.ResetSuccess()
-
-					// Also assume this retry will succeed for now. If it doesn't, we'll update this later.
-					if err := r.EndRun(
-						opts.WorkingDir,
-						report.WithResult(report.ResultSucceeded),
-						report.WithReason(report.ReasonRetrySucceeded),
-					); err != nil {
-						l.Errorf("Error ending run for unit %s: %v", opts.WorkingDir, err)
-					}
-				}
-
-				select {
-				case <-time.After(opts.RetrySleepInterval):
-					// try again
-				case <-ctx.Done():
-					return errors.New(ctx.Err())
-				}
-			}
-		} else {
-			return nil
-		}
-	}
-
-	return errors.New(MaxRetriesExceeded{opts})
-}
-
-// IsRetryable checks whether there was an error and if the output matches any of the configured RetryableErrors
-func IsRetryable(opts *options.TerragruntOptions, out *util.CmdOutput) bool {
-	if !opts.AutoRetry {
-		return false
-	}
-	// When -json is enabled, Terraform will send all output, errors included, to stdout.
-	return util.MatchesAny(opts.RetryableErrors, out.Stderr.String()) || util.MatchesAny(opts.RetryableErrors, out.Stdout.String())
-}
-
 // Prepare for running 'terraform init' by initializing remote state storage and adding backend configuration arguments
 // to the TerraformCliArgs
 func prepareInitCommand(ctx context.Context, l log.Logger, terragruntOptions *options.TerragruntOptions, terragruntConfig *config.TerragruntConfig) error {

cli/commands/run/run_test.go

@@ -1,15 +1,13 @@
 package run_test
 
 import (
-	"bytes"
 	"os"
 	"path/filepath"
 	"testing"
 
 	"github.com/gruntwork-io/terragrunt/cli/commands/run"
 	"github.com/gruntwork-io/terragrunt/config"
 	"github.com/gruntwork-io/terragrunt/internal/errors"
-	"github.com/gruntwork-io/terragrunt/internal/report"
 	"github.com/gruntwork-io/terragrunt/options"
 	"github.com/gruntwork-io/terragrunt/pkg/log"
 	"github.com/gruntwork-io/terragrunt/test/helpers/logger"
@@ -160,120 +158,7 @@ func TestTerragruntTerraformCodeCheck(t *testing.T) {
 	}
 }
 
-func TestErrorRetryableOnStdoutError(t *testing.T) {
-	t.Parallel()
-
-	tgOptions, err := options.NewTerragruntOptionsForTest("")
-	require.NoError(t, err)
-
-	retryableErrors := []string{".*error.*"}
-	tgOptions.RetryableErrors = retryableErrors
-	tgOptions.AutoRetry = true
-
-	out := new(util.CmdOutput)
-	out.Stderr = *bytes.NewBufferString("error is here")
-
-	retryable := run.IsRetryable(tgOptions, out)
-	require.True(t, retryable, "The error should have retried")
-}
-
-func TestErrorMultipleRetryableOnStderrError(t *testing.T) {
-	t.Parallel()
-
-	tgOptions, err := options.NewTerragruntOptionsForTest("")
-	require.NoError(t, err)
-
-	retryableErrors := []string{"no match", ".*error.*"}
-	tgOptions.RetryableErrors = retryableErrors
-	tgOptions.AutoRetry = true
-
-	out := new(util.CmdOutput)
-	out.Stderr = *bytes.NewBufferString("error is here")
-
-	retryable := run.IsRetryable(tgOptions, out)
-	require.True(t, retryable, "The error should have retried")
-}
-
-func TestEmptyRetryablesOnStderrError(t *testing.T) {
-	t.Parallel()
-
-	tgOptions, err := options.NewTerragruntOptionsForTest("")
-	require.NoError(t, err)
-
-	retryableErrors := []string{}
-	tgOptions.RetryableErrors = retryableErrors
-	tgOptions.AutoRetry = true
-
-	out := new(util.CmdOutput)
-	out.Stderr = *bytes.NewBufferString("error is here")
-
-	retryable := run.IsRetryable(tgOptions, out)
-	require.False(t, retryable, "The error should not have retried, the list of retryable errors was empty")
-}
-
-func TestErrorRetryableOnStderrError(t *testing.T) {
-	t.Parallel()
-
-	tgOptions, err := options.NewTerragruntOptionsForTest("")
-	require.NoError(t, err)
-
-	retryableErrors := []string{".*error.*"}
-	tgOptions.RetryableErrors = retryableErrors
-	tgOptions.AutoRetry = true
-
-	out := new(util.CmdOutput)
-	out.Stderr = *bytes.NewBufferString("error is here")
-
-	retryable := run.IsRetryable(tgOptions, out)
-	require.True(t, retryable, "The error should have retried")
-}
-
-func TestErrorNotRetryableOnStdoutError(t *testing.T) {
-	t.Parallel()
-
-	tgOptions, err := options.NewTerragruntOptionsForTest("")
-	require.NoError(t, err)
-
-	retryableErrors := []string{"not the error"}
-	tgOptions.RetryableErrors = retryableErrors
-	tgOptions.AutoRetry = true
-
-	out := new(util.CmdOutput)
-	out.Stdout = *bytes.NewBufferString("error is here")
-
-	retryable := run.IsRetryable(tgOptions, out)
-	require.False(t, retryable, "The error should not retry")
-}
-
-func TestErrorNotRetryableOnStderrError(t *testing.T) {
-	t.Parallel()
-
-	tgOptions, err := options.NewTerragruntOptionsForTest("")
-	require.NoError(t, err)
-
-	retryableErrors := []string{"not the error"}
-	tgOptions.RetryableErrors = retryableErrors
-	tgOptions.AutoRetry = true
-
-	out := new(util.CmdOutput)
-	out.Stderr = *bytes.NewBufferString("error is here")
-
-	retryable := run.IsRetryable(tgOptions, out)
-	require.False(t, retryable, "The error should not retry")
-}
-
-func TestTerragruntHandlesCatastrophicTerraformFailure(t *testing.T) {
-	t.Parallel()
-
-	tgOptions, err := options.NewTerragruntOptionsForTest("")
-	require.NoError(t, err)
-
-	// Use a path that doesn't exist to induce error
-	tgOptions.TFPath = "i-dont-exist"
-	l := logger.CreateLogger()
-	err = run.RunTerraformWithRetry(t.Context(), l, tgOptions, report.NewReport())
-	require.Error(t, err)
-}
+// Legacy retry tests removed; retries now handled via errors blocks
 
 func TestToTerraformEnvVars(t *testing.T) {
 	t.Parallel()