fix: pass extra_args when fetching dependencies outputs
#4416
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 WalkthroughWalkthroughThe code refactors dependency output retrieval functions to accept a unified Changes
Sequence Diagram(s)sequenceDiagram
participant Caller
participant DependencyHandler
participant TerragruntOptions
participant TerragruntConfig
Caller->>DependencyHandler: getTerragruntOutputJSON(ctx, logger, config)
DependencyHandler->>TerragruntConfig: Access ExtraArgs and IAMRoleOptions
DependencyHandler->>DependencyHandler: FilterTerraformExtraArgs(...)
DependencyHandler->>DependencyHandler: filterTerraformEnvVarsFromExtraArgs(...)
DependencyHandler->>TerragruntOptions: setupTerragruntOptionsForBareTerraform(...)
TerragruntOptions->>DependencyHandler: Return options with merged CLI args and env vars
DependencyHandler->>Caller: Return output JSON
Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes were found. Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 golangci-lint (1.64.8)Error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2 ✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
config/dependency.go (1)
1139-1150: Order of CLI-argument insertion may override user flags
InsertTerraformCliArgs(args...)appends to the end of the existing slice.
If the original command already carried an explicit flag (e.g.-lock=false) the later append silently overrides earlier semantics. Consider detecting duplicates and preserving the user-supplied order/precedence.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
config/dependency.go(8 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.go`: Review the Go code for quality and correctness. Make sure that the Go code follows best practices, is performant, and is easy to understand and maintain.
**/*.go: Review the Go code for quality and correctness. Make sure that the Go code follows best practices, is performant, and is easy to understand and maintain.
config/dependency.go
🔇 Additional comments (2)
config/dependency.go (2)
7-11:mapsimport requires Go ≥1.20 – double-check the tool-chainThe new standard-library package
mapswas introduced in Go 1.20.
Please ensure that:
go.moddeclares at leastgo 1.20.- CI / build images are updated accordingly, otherwise builds will fail.
1153-1154: IAM-role precedence subtly changed
MergeIAMRoleOptions(targetConfig.GetIAMRoleOptions(), targetTGOptions.OriginalIAMRoleOptions)now gives config-file directives precedence over CLI. Historically CLI flags take priority. Confirm this reversal is intended; otherwise invert the parameters.
| func filterTerraformEnvVarsFromExtraArgs(terragruntOptions *options.TerragruntOptions, terragruntConfig *TerragruntConfig) map[string]string { | ||
| out := map[string]string{} | ||
| cmd := terragruntOptions.TerraformCliArgs.First() | ||
|
|
||
| for _, arg := range terragruntConfig.Terraform.ExtraArgs { | ||
| if arg.EnvVars == nil { | ||
| continue | ||
| } | ||
|
|
||
| for _, argcmd := range arg.Commands { | ||
| if cmd == argcmd { | ||
| maps.Copy(out, *arg.EnvVars) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return out | ||
| } |
There was a problem hiding this comment.
Potential panic: maps.Copy on a nil destination map
targetTGOptions.Env might be nil (common when TG is instantiated programmatically).
maps.Copy(dst, src) panics when dst is nil. Initialising the map fixes this.
func filterTerraformEnvVarsFromExtraArgs(terragruntOptions *options.TerragruntOptions, terragruntConfig *TerragruntConfig) map[string]string {
- out := map[string]string{}
+ out := make(map[string]string)and in the caller (setupTerragruntOptionsForBareTerraform):
- maps.Copy(targetTGOptions.Env, filterTerraformEnvVarsFromExtraArgs(targetTGOptions, targetConfig))
+ if targetTGOptions.Env == nil {
+ targetTGOptions.Env = make(map[string]string)
+ }
+ maps.Copy(targetTGOptions.Env, filterTerraformEnvVarsFromExtraArgs(targetTGOptions, targetConfig))Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In config/dependency.go around lines 1102 to 1119, the function
filterTerraformEnvVarsFromExtraArgs initializes the destination map 'out'
correctly, but the caller function setupTerragruntOptionsForBareTerraform might
be passing a nil map to maps.Copy, causing a panic. To fix this, ensure that any
map passed as the destination to maps.Copy is properly initialized before the
call. Specifically, initialize targetTGOptions.Env as an empty map if it is nil
before copying environment variables into it.
| func FilterTerraformExtraArgs(l log.Logger, opts *options.TerragruntOptions, terragruntConfig *TerragruntConfig) []string { | ||
| out := []string{} | ||
| cmd := opts.TerraformCliArgs.First() | ||
|
|
||
| for _, arg := range terragruntConfig.Terraform.ExtraArgs { | ||
| for _, argCmd := range arg.Commands { | ||
| if cmd == argCmd { | ||
| lastArg := opts.TerraformCliArgs.Last() | ||
| skipVars := (cmd == tf.CommandNameApply || cmd == tf.CommandNameDestroy) && util.IsFile(lastArg) | ||
|
|
||
| // The following is a fix for GH-493. | ||
| // If the first argument is "apply" and the second argument is a file (plan), | ||
| // we don't add any -var-file to the command. | ||
| if arg.Arguments != nil { | ||
| if skipVars { | ||
| // If we have to skip vars, we need to iterate over all elements of array... | ||
| for _, a := range *arg.Arguments { | ||
| if !strings.HasPrefix(a, "-var") { | ||
| out = append(out, a) | ||
| } | ||
| } | ||
| } else { | ||
| // ... Otherwise, let's add all the arguments | ||
| out = append(out, *arg.Arguments...) | ||
| } | ||
| } | ||
|
|
||
| if !skipVars { | ||
| varFiles := arg.GetVarFiles(l) | ||
| for _, file := range varFiles { | ||
| out = append(out, "-var-file="+file) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return out | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Nil–safety & duplication in FilterTerraformExtraArgs
terragruntConfigis dereferenced without a nil check; the helper is currently only called from a guarded site, but adding a check makes it future-proof.opts.TerraformCliArgs.First()/Last()can return an empty string when the slice is empty – guarding avoids misleading matches.- Returned slice can contain duplicated flags when multiple
extra_argumentsblocks target the same command. Consider amap[string]struct{}to de-dup.
+ if terragruntConfig == nil || terragruntConfig.Terraform == nil {
+ return nil
+ }
cmd := opts.TerraformCliArgs.First()
- if cmd == argCmd {
+ if cmd != "" && cmd == argCmd {📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| func FilterTerraformExtraArgs(l log.Logger, opts *options.TerragruntOptions, terragruntConfig *TerragruntConfig) []string { | |
| out := []string{} | |
| cmd := opts.TerraformCliArgs.First() | |
| for _, arg := range terragruntConfig.Terraform.ExtraArgs { | |
| for _, argCmd := range arg.Commands { | |
| if cmd == argCmd { | |
| lastArg := opts.TerraformCliArgs.Last() | |
| skipVars := (cmd == tf.CommandNameApply || cmd == tf.CommandNameDestroy) && util.IsFile(lastArg) | |
| // The following is a fix for GH-493. | |
| // If the first argument is "apply" and the second argument is a file (plan), | |
| // we don't add any -var-file to the command. | |
| if arg.Arguments != nil { | |
| if skipVars { | |
| // If we have to skip vars, we need to iterate over all elements of array... | |
| for _, a := range *arg.Arguments { | |
| if !strings.HasPrefix(a, "-var") { | |
| out = append(out, a) | |
| } | |
| } | |
| } else { | |
| // ... Otherwise, let's add all the arguments | |
| out = append(out, *arg.Arguments...) | |
| } | |
| } | |
| if !skipVars { | |
| varFiles := arg.GetVarFiles(l) | |
| for _, file := range varFiles { | |
| out = append(out, "-var-file="+file) | |
| } | |
| } | |
| } | |
| } | |
| } | |
| return out | |
| } | |
| func FilterTerraformExtraArgs(l log.Logger, opts *options.TerragruntOptions, terragruntConfig *TerragruntConfig) []string { | |
| // Nil‐safety: guard against future calls with a nil config or missing Terraform block | |
| if terragruntConfig == nil || terragruntConfig.Terraform == nil { | |
| return nil | |
| } | |
| out := []string{} | |
| cmd := opts.TerraformCliArgs.First() | |
| for _, arg := range terragruntConfig.Terraform.ExtraArgs { | |
| for _, argCmd := range arg.Commands { | |
| // Avoid matching on an empty cmd (First() can return "") | |
| if cmd != "" && cmd == argCmd { | |
| lastArg := opts.TerraformCliArgs.Last() | |
| skipVars := (cmd == tf.CommandNameApply || cmd == tf.CommandNameDestroy) && util.IsFile(lastArg) | |
| // The following is a fix for GH-493. | |
| // If the first argument is "apply" and the second argument is a file (plan), | |
| // we don't add any -var-file to the command. | |
| if arg.Arguments != nil { | |
| if skipVars { | |
| // If we have to skip vars, we need to iterate over all elements of array... | |
| for _, a := range *arg.Arguments { | |
| if !strings.HasPrefix(a, "-var") { | |
| out = append(out, a) | |
| } | |
| } | |
| } else { | |
| // ... Otherwise, let's add all the arguments | |
| out = append(out, *arg.Arguments...) | |
| } | |
| } | |
| if !skipVars { | |
| varFiles := arg.GetVarFiles(l) | |
| for _, file := range varFiles { | |
| out = append(out, "-var-file="+file) | |
| } | |
| } | |
| } | |
| } | |
| } | |
| return out | |
| } |
🤖 Prompt for AI Agents
In config/dependency.go around lines 1062 to 1100, add a nil check for
terragruntConfig at the start of FilterTerraformExtraArgs to prevent
dereferencing nil. Also, check if opts.TerraformCliArgs.First() and Last()
return empty strings before using them to avoid incorrect matches. Finally,
replace the output slice with a map to track added arguments and prevent
duplicates, then convert the map keys back to a slice before returning.
|
Regarding CodeRabbit and SonarCloud feedback: this code is copied verbatim from |
|
Hey @head-gardener , I think this issue is going to take us a while to get to. There are a lot of implications to the subsystem that you're editing here, and we need to tread carefully to make sure we understand all the implications of this change. Please have patience with us. |
Description
Fixes #2598.
TerragruntOptions.ExtraArgsisn't being included in the options being passed totf.RunCommandWithOutput. In this PR I copied over theExtraArgslogic fromrun.goand that fixed the issue.The code from
run.gocan't be included directly because of a dependency cycle and I can't find a place to put it. Do you have any ideas? Also let me now if there is any documentation I can/need to update and if you want a test for this specific case.TODOs
Read the Gruntwork contribution guidelines.
ExtraArgslogic somewhere.Release Notes (draft)
Fix optimized output fetchers to use
terraform:extra_argumentsconfigurationMigration Guide
If you had previously set
disable_dependency_optimizationto bypass this issue you may unset it now.Summary by CodeRabbit