chore: Move log flags off writers (#6403)

Author: yhakbar

internal/cli/commands/commands.go

@@ -469,7 +469,7 @@ func initialSetup(cliCtx *clihelper.Context, l log.Logger, opts *options.Terragr
 		return err
 	}
 
-	if opts.Writers.LogShowAbsPaths {
+	if opts.LogShowAbsPaths {
 		l.Formatter().DisableRelativePaths()
 	}
 

internal/cli/flags/global/flags.go

@@ -116,7 +116,7 @@ func NewFlags(l log.Logger, opts *options.TerragruntOptions, prefix flags.Prefix
 		flags.NewFlag(&clihelper.BoolFlag{
 			Name:        ShowLogAbsPathsFlagName,
 			EnvVars:     tgPrefix.EnvVars(ShowLogAbsPathsFlagName),
-			Destination: &opts.Writers.LogShowAbsPaths,
+			Destination: &opts.LogShowAbsPaths,
 			Usage:       "Show absolute paths in logs.",
 		},
 			flags.WithDeprecatedEnvVars(terragruntPrefix.EnvVars(DeprecatedShowLogAbsPathsFlagName), opts.StrictControls)),

internal/configbridge/bridge.go

@@ -57,6 +57,8 @@ func populateFromOpts(pctx *config.ParsingContext, opts *options.TerragruntOptio
 	pctx.StrictControls = opts.StrictControls
 	pctx.FeatureFlags = opts.FeatureFlags
 	pctx.Writers = opts.Writers
+	pctx.LogShowAbsPaths = opts.LogShowAbsPaths
+	pctx.LogDisableErrorSummary = opts.LogDisableErrorSummary
 	pctx.Env = opts.Env
 	pctx.IAMRoleOptions = opts.IAMRoleOptions
 	pctx.OriginalIAMRoleOptions = opts.OriginalIAMRoleOptions
@@ -88,7 +90,7 @@ func populateFromOpts(pctx *config.ParsingContext, opts *options.TerragruntOptio
 
 // ShellRunOptsFromOpts constructs shell.ShellOptions from TerragruntOptions.
 func ShellRunOptsFromOpts(opts *options.TerragruntOptions) *shell.ShellOptions {
-	return shell.NewShellOptions().
+	s := shell.NewShellOptions().
 		WithWorkingDir(opts.WorkingDir).
 		WithEnv(opts.Env).
 		WithWriters(opts.Writers).
@@ -99,6 +101,10 @@ func ShellRunOptsFromOpts(opts *options.TerragruntOptions) *shell.ShellOptions {
 		WithExperiments(opts.Experiments).
 		WithHeadless(opts.Headless).
 		WithForwardTFStdout(opts.ForwardTFStdout)
+	s.LogShowAbsPaths = opts.LogShowAbsPaths
+	s.LogDisableErrorSummary = opts.LogDisableErrorSummary
+
+	return s
 }
 
 // BackendOptsFromOpts constructs backend.Options from TerragruntOptions.
@@ -138,6 +144,8 @@ func TFRunOptsFromOpts(opts *options.TerragruntOptions) *tf.TFOptions {
 func NewRunOptions(opts *options.TerragruntOptions) *run.Options {
 	runOpts := run.NewOptions()
 	runOpts.Writers = opts.Writers
+	runOpts.LogShowAbsPaths = opts.LogShowAbsPaths
+	runOpts.LogDisableErrorSummary = opts.LogDisableErrorSummary
 	runOpts.TerragruntConfigPath = opts.TerragruntConfigPath
 	runOpts.OriginalTerragruntConfigPath = opts.OriginalTerragruntConfigPath
 	runOpts.WorkingDir = opts.WorkingDir

internal/engine/engine.go

@@ -82,6 +82,9 @@ type ExecutionOptions struct {
 	ForwardTFStdout   bool
 	SuppressStdout    bool
 	AllocatePseudoTty bool
+
+	LogShowAbsPaths        bool
+	LogDisableErrorSummary bool
 }
 
 type engineInstance struct {
@@ -832,10 +835,10 @@ func invoke(
 				Output:          output,
 				WorkingDir:      runOptions.WorkingDir,
 				RootWorkingDir:  runOptions.RootWorkingDir,
-				LogShowAbsPaths: runOptions.Writers.LogShowAbsPaths,
+				LogShowAbsPaths: runOptions.LogShowAbsPaths,
 				Command:         runOptions.Command,
 				Args:            runOptions.Args,
-				DisableSummary:  runOptions.Writers.LogDisableErrorSummary,
+				DisableSummary:  runOptions.LogDisableErrorSummary,
 			}
 
 			return err

internal/runner/common/unit_runner.go

@@ -52,7 +52,7 @@ func (runner *UnitRunner) runTerragrunt(
 	cfg *runcfg.RunConfig,
 	credsGetter *creds.Getter,
 ) error {
-	l.Debugf("Running %s", util.RelPathForLog(opts.RootWorkingDir, runner.Unit.Path(), opts.Writers.LogShowAbsPaths))
+	l.Debugf("Running %s", util.RelPathForLog(opts.RootWorkingDir, runner.Unit.Path(), opts.LogShowAbsPaths))
 
 	defer func() {
 		// Flush buffered output for this unit, if the writer supports it.

internal/runner/run/download_source.go

@@ -100,8 +100,8 @@ func DownloadTerraformSource(
 	if needsModuleCopy {
 		l.Debugf(
 			"Copying files from %s into %s",
-			util.RelPathForLog(opts.WorkingDir, opts.WorkingDir, opts.Writers.LogShowAbsPaths),
-			util.RelPathForLog(opts.RootWorkingDir, terraformSource.WorkingDir, opts.Writers.LogShowAbsPaths),
+			util.RelPathForLog(opts.WorkingDir, opts.WorkingDir, opts.LogShowAbsPaths),
+			util.RelPathForLog(opts.RootWorkingDir, terraformSource.WorkingDir, opts.LogShowAbsPaths),
 		)
 
 		// Always include the .tflint.hcl file, if it exists
@@ -136,7 +136,7 @@ func DownloadTerraformSource(
 		util.RelPathForLog(
 			opts.RootWorkingDir,
 			terraformSource.WorkingDir,
-			opts.Writers.LogShowAbsPaths,
+			opts.LogShowAbsPaths,
 		),
 	)
 	updatedOpts.WorkingDir = terraformSource.WorkingDir
@@ -185,7 +185,7 @@ func DownloadTerraformSourceIfNecessary(
 				util.RelPathForLog(
 					opts.RootWorkingDir,
 					terraformSource.WorkingDir,
-					opts.Writers.LogShowAbsPaths,
+					opts.LogShowAbsPaths,
 				),
 			)
 
@@ -348,8 +348,8 @@ func downloadSource(
 
 	l.Infof(
 		"Downloading Terraform configurations from %s into %s",
-		util.RelPathForLog(opts.RootWorkingDir, canonicalSourceURL, opts.Writers.LogShowAbsPaths),
-		util.RelPathForLog(opts.RootWorkingDir, src.DownloadDir, opts.Writers.LogShowAbsPaths))
+		util.RelPathForLog(opts.RootWorkingDir, canonicalSourceURL, opts.LogShowAbsPaths),
+		util.RelPathForLog(opts.RootWorkingDir, src.DownloadDir, opts.LogShowAbsPaths))
 
 	allowCAS := !opts.NoCAS
 

internal/runner/run/options.go

@@ -88,6 +88,8 @@ type Options struct {
 	DisableBucketUpdate          bool
 	SourceUpdate                 bool
 	ForwardTFStdout              bool
+	LogShowAbsPaths              bool
+	LogDisableErrorSummary       bool
 }
 
 // Clone performs a deep copy of Options.
@@ -192,7 +194,7 @@ func (o *Options) DataDir() string {
 
 // shellRunOptions builds a *shell.ShellOptions from this Options.
 func (o *Options) shellRunOptions() *shell.ShellOptions {
-	return shell.NewShellOptions().
+	s := shell.NewShellOptions().
 		WithWorkingDir(o.WorkingDir).
 		WithEnv(o.Env).
 		WithWriters(o.Writers).
@@ -203,6 +205,10 @@ func (o *Options) shellRunOptions() *shell.ShellOptions {
 		WithExperiments(o.Experiments).
 		WithHeadless(o.Headless).
 		WithForwardTFStdout(o.ForwardTFStdout)
+	s.LogShowAbsPaths = o.LogShowAbsPaths
+	s.LogDisableErrorSummary = o.LogDisableErrorSummary
+
+	return s
 }
 
 // tfRunOptions builds a *tf.TFOptions from this Options.
@@ -237,6 +243,7 @@ func (o *Options) tflintRunOptions() *tflint.TFLintOptions {
 	return &tflint.TFLintOptions{
 		ShellOptions:         o.shellRunOptions(),
 		Writers:              o.Writers,
+		LogShowAbsPaths:      o.LogShowAbsPaths,
 		WorkingDir:           o.WorkingDir,
 		RootWorkingDir:       o.RootWorkingDir,
 		TerragruntConfigPath: o.TerragruntConfigPath,

internal/runner/run/run.go

@@ -295,7 +295,7 @@ func runTerragruntWithConfig(
 			// terragrunt.hcl. However, the default value for the user's working dir, set in options.go, IS just the
 			// parent dir of terragrunt.hcl, so these will likely always be the same.
 			// Use directory from OriginalTerragruntConfigPath to copy locks since WorkingDir point to cache directory
-			lockFileError = runcfg.CopyLockFile(l, opts.RootWorkingDir, opts.Writers.LogShowAbsPaths, opts.WorkingDir, filepath.Dir(opts.OriginalTerragruntConfigPath))
+			lockFileError = runcfg.CopyLockFile(l, opts.RootWorkingDir, opts.LogShowAbsPaths, opts.WorkingDir, filepath.Dir(opts.OriginalTerragruntConfigPath))
 		}
 
 		// If command failed, log a helpful message

internal/runner/runall/runall.go

@@ -203,7 +203,7 @@ func RunAllOnStack(
 	l.Debugf("%s", rnr.GetStack().String())
 
 	isDestroy := opts.TerraformCliArgs.IsDestroyCommand(opts.TerraformCommand)
-	if err := rnr.LogUnitDeployOrder(l, isDestroy, opts.Writers.LogShowAbsPaths, opts.Experiments); err != nil {
+	if err := rnr.LogUnitDeployOrder(l, isDestroy, opts.LogShowAbsPaths, opts.Experiments); err != nil {
 		return err
 	}
 

internal/runner/runnerpool/runner.go

@@ -60,7 +60,7 @@ func CloneUnitOptions(
 
 	// Override logger prefix with display path (relative to discovery context) for cleaner logs
 	// unless --log-show-abs-paths is set
-	if !stackOpts.Writers.LogShowAbsPaths {
+	if !stackOpts.LogShowAbsPaths {
 		clonedLogger = clonedLogger.WithField(placeholders.WorkDirKeyName, unit.DisplayPath())
 	}