fix: Wrap TF stdout and stderr in JSON #3602
Conversation
| // If the Terraform error matches `httpStatusCacheProviderReg` we ignore it and hide the log from users, otherwise we process the error as is. | ||
| if output, err := shell.RunTerraformCommandWithOutput(ctx, cloneOpts, cloneOpts.TerraformCliArgs...); err != nil && len(errWriter.Msgs()) == 0 { | ||
| return output, err | ||
| if err != nil && httpStatusCacheProviderReg.Match(output.Stderr.Bytes()) { |
| @@ -56,7 +56,7 @@ Placeholders have preset names: | |||
|
|
|||
| * `%prefix` - Path to the working directory were Terragrunt is running. | |||
|
|
|||
| * `%tfpath` - Path to the OpenTofu/Terraform executable (as defined by [terragrunt-tfpath](https://terragrunt.gruntwork.io/docs/reference/cli-options/#terragrunt-tfpath)). | |||
| * `%tf-path` - Path to the OpenTofu/Terraform executable (as defined by [terragrunt-tfpath](https://terragrunt.gruntwork.io/docs/reference/cli-options/#terragrunt-tfpath)). | |||
There was a problem hiding this comment.
Make sure to call out this change in the release notes.
There was a problem hiding this comment.
Sure, I will call this out. Thanks.
| @@ -83,45 +85,49 @@ type Controls map[string]Control | |||
| //nolint:lll,gochecknoglobals,stylecheck | |||
| var StrictControls = Controls{ | |||
| SpinUp: { | |||
| Error: errors.Errorf("The `%s` command is no longer supported. Use `terragrunt run-all apply` instead.", SpinUp), | |||
There was a problem hiding this comment.
Because this error is user facing, and it's more likely to involve multiple sentences don't you think it's better to have them be full sentences? If so, we should just add a nolint for whatever made you adjust this.
There was a problem hiding this comment.
Alternatively, maybe you know a special way to convert the error messages to proper casing before they are reported to users?
There was a problem hiding this comment.
Sure, I did what you suggested.
There was a problem hiding this comment.
Alternatively, maybe you know a special way to convert the error messages to proper casing before they are reported to users?
Ah no, I don't know of any ready-made function that could do this, only manual message conversion, but I don't think it's worth it.
Description
Fixes #3603
Fixes #3540
Deprecate the
--terragrunt-tf-logs-to-jsonflag. TF stdout and stderr will be wrapped in JSON by default if--terragrunt-forward-tf-stdoutflag is not specified.TODOs
Read the Gruntwork contribution guidelines.
Release Notes (draft)
Added / Removed / Updated [X].
Migration Guide