read_terragrunt_config #1051
read_terragrunt_config #1051
Conversation
| // Specifically, we want to reference blocks by named attributes, but blocks are rendered to lists in the | ||
| // TerragruntConfig struct, so we need to do some massaging of the data to convert the list of blocks in to a map going | ||
| // from the block name label to the block value. | ||
| func terragruntConfigAsCty(config *TerragruntConfig) (cty.Value, error) { |
There was a problem hiding this comment.
Ooof, Terragrunt config parsing gets worse and worse... So much manual stuff to massage between formats.
Is there any way to add a test or lint check or something that ensures every new parameter we add to TerragruntConfig is handled here, and if we forget one, we at least get a test failure warning us of that?
There was a problem hiding this comment.
Yea I was not very happy with this... but I also couldn't come up with a way to avoid it. I'll see if I can add a test here.
There was a problem hiding this comment.
Added some unit tests: c5ea857
There was a problem hiding this comment.
This test does a great job of checking that all the existing fields are converted, but if we were to add a new field, and forget to to add it to this test and to terragruntConfigAsCty... The test won't fail, right?
There was a problem hiding this comment.
Hmm my understanding is that it should fail here, where it will exhaust the options when it sees a new struct field.
I'm going to verify this now that I merged in the codegen feature. My expectation is that the test will fail when I rebase and push. If it doesn't, I'll update the test until it fails.
There was a problem hiding this comment.
Yup failed as expected: https://circleci.com/gh/gruntwork-io/terragrunt/4101
=== RUN TestTerragruntConfigAsCtyDrift
--- FAIL: TestTerragruntConfigAsCtyDrift (0.00s)
config_as_cty_test.go:178: Unknown struct property: GenerateConfigs
|
I believe I addressed all the comments, but given the complexity of the new tests, I rerequested a review. |
There was a problem hiding this comment.
It LGTM overall. My only concern is about the maintainability of terragruntConfigAsCty... Or more accurately, of the 3-4 places we now have to update every time we add a new config option to Terragrunt. Sadly, Go is a bit limit here, so I don't have any suggestions on how to improve this 😞
yorinasub17
force-pushed
the
yori-read-terragrunt-config
branch
from
bbf042e
to
d9e2543
Compare
Filed #1055 so we don't forget this thought. |
|
UPDATE: bfeab4c Added I also found a bug in the Thanks for the review! Going to merge this in now! |
This implements
read_terragrunt_config, a helper function that can be used for reading in another terragrunt config and accessing its blocks and attributes for reuse.This is one of the suggested improvements coming out of #1025
TODO
generateblocks will need to be added to the converter).