Process only relevant variables in the testing framework#34072
Merged
liamcervante merged 1 commit intomainfrom Oct 16, 2023
Merged
Process only relevant variables in the testing framework#34072liamcervante merged 1 commit intomainfrom
liamcervante merged 1 commit intomainfrom
Conversation
jbardin
approved these changes
Oct 13, 2023
Contributor
|
Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch. |
Contributor
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR adds in the concept of "relevant variables" to the testing framework. Previously, each run block would process every available variable and attempt to parse even those they had no need for. This resulted in some edge case behaviour as seen in the linked issue. Now, each run block first calculates the variables it needs, and then exclusively processes the subset of required variables.
In addition, this PR does some refactoring of the variables processing. Previously, the variables were processed in their entirety twice: once for the test itself, and then once again for the assertions after the test has finished. Now, we only process the variables once at the beginning of each run and use mutator functions
FilterVariablesToConfigandAddVariablesToConfigto achieve the required configurations for the test and for processing the assertions.Also, previously we were duplicating the defaults and conversion logic while preparing the variables for assertions. I realised I can push that processing further down the stack into the
terraformpackage, and then reuse the existingprepareFinalInputVariableValuefunction instead of duplicating that logic.The refactoring here will make future PRs easier (such as #34069) where we need to pull the variables available to the whole file. We can reuse the new function added here instead of doing this refactor at that point or adding a new function.
Fixes #34070
Target Release
1.6.2
Draft CHANGELOG entry
BUG FIXES
terraform test: Fix bug whereterraform testwas processing and including all available variables for every test rather than only the ones required for that particular test.