configs: Simplify required_providers blocks #24763
Merged
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
We now permit at most one `required_providers` block per module (except for overrides). This prevents users (and Terraform) from struggling to understand how to merge multiple `required_providers` configurations, with `version` and `source` attributes split across multiple blocks. Because only one `required_providers` block is permitted, there is no need to concatenate version constraints and resolve them. This allows us to simplify the structs used to represent provider requirements, aligning more closely with other structs in this package. This commit also fixes a semantic use-before-initialize bug, where resources defined before a `required_providers` block would be unable to use its source attribute. We achieve this by processing the module's `required_providers` configuration (and overrides) before resources. Overrides for `required_providers` work as before, replacing the entire block per provider.
ghost
added
the
sdkv1
Codecov Report
|
mildwonkey
approved these changes
Apr 24, 2020
There was a problem hiding this comment.
This looks great @alisdair ! Having those two types, ProviderRequirements and RequiredProviders, drove me a little batty and it's lovely to see a solution using one type in both files & modules.
| default: | ||
| // should not happen | ||
| diags = append(diags, &hcl.Diagnostic{ | ||
| Severity: hcl.DiagError, | ||
| Summary: "Invalid provider_requirements syntax", | ||
| Detail: "provider_requirements entries must be strings or objects.", | ||
| Summary: "Invalid required_providers syntax", |
There was a problem hiding this comment.
🤦 I'm so glad you caught that!
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked and limited conversation to collaborators
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.
We now permit at most one
required_providersblock per module (except for overrides). This prevents users (and Terraform) from struggling to understand how to merge multiplerequired_providersconfigurations, withversionandsourceattributes split across multiple blocks.Because only one
required_providersblock is permitted, there is no need to concatenate version constraints and resolve them. This allows us to simplify the structs used to represent provider requirements, aligning more closely with other structs in this package.This commit also fixes a semantic use-before-initialize bug, where resources defined before a
required_providersblock would be unable to use its source attribute. We achieve this by processing the module'srequired_providersconfiguration (and overrides) before resources.Overrides for
required_providerswork as before, replacing the entire block per provider.