Skip to content

fix(config): ensure shallow merge respects child values for include_in_copy / exclude_from_copy (#4757) #4758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

fix(config): ensure shallow merge respects child values for include_in_copy / exclude_from_copy (#4757) #4758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7a175c4
config(include): shallow merge IncludeInCopy/ExcludeFromCopy
tsentylo Aug 28, 2025
bf9bf51
tests(config): cover shallow+deep merge for copy filters
tsentylo Aug 28, 2025
606516f
Merge branch 'main' into bug/merge-copy-filters-4757
tsentylo Aug 28, 2025
18bc251
fix: Avoid aliasing: deep-copy slice pointers on shallow merge.
tsentylo Aug 28, 2025
5e54d3f
fix(config): add mergeListArgPreserveEmpty helper for include_in_copy…
tsentylo Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions config/include.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,9 @@ func (cfg *TerragruntConfig) Merge(l log.Logger, sourceConfig *TerragruntConfig,
cfg.Terraform.CopyTerraformLockFile = sourceConfig.Terraform.CopyTerraformLockFile
}

mergeListArgPreserveEmpty(sourceConfig.Terraform.IncludeInCopy, &cfg.Terraform.IncludeInCopy)
mergeListArgPreserveEmpty(sourceConfig.Terraform.ExcludeFromCopy, &cfg.Terraform.ExcludeFromCopy)

mergeExtraArgs(l, sourceConfig.Terraform.ExtraArgs, &cfg.Terraform.ExtraArgs)

mergeHooks(l, sourceConfig.Terraform.BeforeHooks, &cfg.Terraform.BeforeHooks)
Expand Down Expand Up @@ -675,6 +678,23 @@ func deepMergeDependencyBlocks(targetDependencies []Dependency, sourceDependenci
return combinedDeps, nil
}

// Merge list argument preserving empty lists.
//
// If child provides an explicit empty list, we store a non-nil empty slice
// to represent "clear the list", instead of a nil slice.
func mergeListArgPreserveEmpty(childListArg *[]string, parentListArg **[]string) {
if childListArg == nil {
return
}
if len(*childListArg) == 0 {
empty := make([]string, 0)
*parentListArg = &empty
return
}
copied := append([]string(nil), *childListArg...)
*parentListArg = &copied
}

// Merge the extra arguments.
//
// If a child's extra_arguments has the same name a parent's extra_arguments,
Expand Down
66 changes: 66 additions & 0 deletions config/include_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,36 @@ func TestMergeConfigIntoIncludedConfig(t *testing.T) {
&config.TerragruntConfig{Terraform: &config.TerraformConfig{ExcludeFromCopy: &[]string{"abc"}}},
&config.TerragruntConfig{Terraform: &config.TerraformConfig{CopyTerraformLockFile: &[]bool{false}[0], ExcludeFromCopy: &[]string{"abc"}}},
},
{
// child-only lists survive when parent has Terraform but no lists
&config.TerragruntConfig{Terraform: &config.TerraformConfig{IncludeInCopy: &[]string{"child.inc1", "child.inc2"}, ExcludeFromCopy: &[]string{"child.exc1"}}},
&config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo")}},
&config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"child.inc1", "child.inc2"}, ExcludeFromCopy: &[]string{"child.exc1"}}},
},
{
// parent-only lists remain when child has empty Terraform block
&config.TerragruntConfig{Terraform: &config.TerraformConfig{}},
&config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"parent.inc1"}, ExcludeFromCopy: &[]string{"parent.exc1"}}},
&config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"parent.inc1"}, ExcludeFromCopy: &[]string{"parent.exc1"}}},
},
{
// both set -> shallow merge keeps child lists (no concatenation in shallow)
&config.TerragruntConfig{Terraform: &config.TerraformConfig{IncludeInCopy: &[]string{"child.inc"}, ExcludeFromCopy: &[]string{"child.exc"}}},
&config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"parent.inc"}, ExcludeFromCopy: &[]string{"parent.exc"}}},
&config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"child.inc"}, ExcludeFromCopy: &[]string{"child.exc"}}},
},
{
// child explicitly empties lists -> overrides and clears parent
&config.TerragruntConfig{Terraform: &config.TerraformConfig{IncludeInCopy: &[]string{}, ExcludeFromCopy: &[]string{}}},
&config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"parent.inc"}, ExcludeFromCopy: &[]string{"parent.exc"}}},
&config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{}, ExcludeFromCopy: &[]string{}}},
},
{
// parent Terraform present but lists nil -> child lists must NOT be dropped
&config.TerragruntConfig{Terraform: &config.TerraformConfig{IncludeInCopy: &[]string{"child.inc"}, ExcludeFromCopy: &[]string{"child.exc"}}},
&config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo")}},
&config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"child.inc"}, ExcludeFromCopy: &[]string{"child.exc"}}},
},
}

for _, tc := range testCases {
Expand Down Expand Up @@ -336,6 +366,42 @@ func TestDeepMergeConfigIntoIncludedConfig(t *testing.T) {
target: &config.TerragruntConfig{Terraform: &config.TerraformConfig{ExcludeFromCopy: &[]string{"abc"}}},
expected: &config.TerragruntConfig{Terraform: &config.TerraformConfig{CopyTerraformLockFile: &[]bool{false}[0], ExcludeFromCopy: &[]string{"abc"}}},
},
{
name: "terraform parent only lists",
source: &config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"parent.inc1"}, ExcludeFromCopy: &[]string{"parent.exc1"}}},
target: &config.TerragruntConfig{Terraform: &config.TerraformConfig{}},
expected: &config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"parent.inc1"}, ExcludeFromCopy: &[]string{"parent.exc1"}}},
},
{
name: "terraform child only lists",
source: &config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo")}},
target: &config.TerragruntConfig{Terraform: &config.TerraformConfig{IncludeInCopy: &[]string{"child.inc1"}, ExcludeFromCopy: &[]string{"child.exc1"}}},
expected: &config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"child.inc1"}, ExcludeFromCopy: &[]string{"child.exc1"}}},
},
{
name: "terraform concatenate include/exclude lists",
source: &config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"parent.inc1", "parent.inc2"}, ExcludeFromCopy: &[]string{"parent.exc1"}}},
target: &config.TerragruntConfig{Terraform: &config.TerraformConfig{IncludeInCopy: &[]string{"child.inc1"}, ExcludeFromCopy: &[]string{"child.exc1", "child.exc2"}}},
expected: &config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"parent.inc1", "parent.inc2", "child.inc1"}, ExcludeFromCopy: &[]string{"parent.exc1", "child.exc1", "child.exc2"}}},
},
{
name: "terraform parent nil does not clobber child lists",
source: &config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo")}},
target: &config.TerragruntConfig{Terraform: &config.TerraformConfig{IncludeInCopy: &[]string{"child.inc"}, ExcludeFromCopy: &[]string{"child.exc"}}},
expected: &config.TerragruntConfig{Terraform: &config.TerraformConfig{Source: ptr("foo"), IncludeInCopy: &[]string{"child.inc"}, ExcludeFromCopy: &[]string{"child.exc"}}},
},
{
name: "terraform parent empty slice treated as present (concat no-op + child)",
source: &config.TerragruntConfig{Terraform: &config.TerraformConfig{IncludeInCopy: &[]string{}}},
target: &config.TerragruntConfig{Terraform: &config.TerraformConfig{IncludeInCopy: &[]string{"child"}}},
expected: &config.TerragruntConfig{Terraform: &config.TerraformConfig{IncludeInCopy: &[]string{"child"}}},
},
{
name: "terraform duplicates preserved (no dedupe at merge layer)",
source: &config.TerragruntConfig{Terraform: &config.TerraformConfig{ExcludeFromCopy: &[]string{"a", "b"}}},
target: &config.TerragruntConfig{Terraform: &config.TerraformConfig{ExcludeFromCopy: &[]string{"b", "c"}}},
expected: &config.TerragruntConfig{Terraform: &config.TerraformConfig{ExcludeFromCopy: &[]string{"a", "b", "b", "c"}}},
},
}

for _, tc := range testCases {
Expand Down