terraform: Error message for unknown error_message in variable validation #35400
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
…tion In cases where the "condition" is known but the "error_message" is not, we were previously returning the generic error about the error message not being evaluable. In the long run we'll want to do something better here to minimize the chances of this situation arising -- reporting an error that we don't know how to describe is a poor user experience -- but this is a temporary intervention to at least make the error message more relevant in the meantime, while we design how Terraform actually ought to behave in this awkward situation.
DanielMSchmidt
approved these changes
Jul 11, 2024
|
Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch. |
|
Oh, whoops... this should have had the v1.9 backport label on it before I merged it. I'll manually prepare a backport branch in a little while and push that up for review too. |
|
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. |
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.
In cases where the
conditionis known but theerror_messageis not, we were previously returning the generic error about the error message not being evaluable.This is an interim change to give better feedback for the unfortunate situation described in #35397, so we can give authors better guidance in the meantime while we're designing a better solution.
In the long run we'll want to do something better here to minimize the chances of this situation arising -- reporting an error that we don't know how to describe is a poor user experience. But for now this at least acknowledges that an unknown value is the problem, and annotates the error message with the "caused by unknown" marking so that the UI will specify which of the contributing values was unknown.
(In this particular case the message is not fully accurate:
var.error_messagewould be known during the plan phase, but isn't yet known during the validation phase. However, I've written it this way in anticipation of a future solution to #35397 that would avoid this error message being returned for anything that is unknown during the validate phase but yet would be known during the planning phase.)