feat: Improve handling of ExcludeFromCopy configuration in Terragrunt #3816
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add a new test case to verify the correct behavior of `UpdateGetters` with `ExcludeFromCopy` configuration - Ensure that the `FileCopyGetter` correctly respects the `ExcludeFromCopy` configuration when downloading Terraform sources - Update the `UpdateGetters` function to pass the `TerragruntConfig` to the `FileCopyGetter` for proper handling of the `ExcludeFromCopy` configuration
Excoriate
requested review from
denis256,
levkohimins and
yhakbar
as code owners
yhakbar
requested changes
Jan 30, 2025
Co-authored-by: Yousif Akbar <[email protected]>
The changes in this commit remove an unnecessary comment from the `TestUpdateGettersExcludeFromCopy` test in the `download_source_test.go` file. This comment was not providing any valuable information and was cluttering the test code.
yhakbar
approved these changes
Jan 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR addresses a subtle configuration handling issue in Terragrunt's source downloading mechanism, specifically related to the
ExcludeFromCopyconfiguration. It fixes #3767 (ar at least, contributes to fixing/closing it)Problem Statement
In the previous implementation, there was a bug in how
ExcludeFromCopywas being processed during source downloading. The original code incorrectly assigned the exclusion configuration, potentially leading to unexpected file copying behavior. Somehow, this wast not caught by the existing tests.Key Changes
TestUpdateGettersExcludeFromCopyto validateExcludeFromCopyconfiguration handlingFileCopyGettercorrectly respects theExcludeFromCopyconfigurationRationale
The bug in PR #3766 highlighted a some sort of weakness in terragrunt's configuration handling (in the download-source logic):
Technical Details
nilExcludeFromCopyconfigurationnilExcludeFromCopywith specific exclusion patternsUpdateGetterscorrectly populatesFileCopyGetterwith exclusion configurationTODOs
Read the Gruntwork contribution guidelines.
Release Notes
Added enhanced test coverage and fixed configuration handling for
ExcludeFromCopyin Terragrunt source downloading mechanism.Migration Guide
No breaking changes. Users can continue to use
exclude_from_copyconfiguration as before.