Skip to content

all: Included missing attribute path details in error diagnostics #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 30, 2022

Conversation

bflad
Copy link
Contributor

@bflad bflad commented Aug 28, 2022

Closes #57
Reference: hashicorp/terraform#31575

Terraform output currently does not include the attribute path details if the attribute is not present in the configuration. This can make troubleshooting difficult for practitioners and provider developers.

Even if Terraform implements path details for unconfigured attributes, those details may not necessarily be clear for troubleshooting as they would likely be implemented in a very short, concise manner to reduce diagnostic message noise. Those details would also only be present on recent and future Terraform versions, while these validators support all versions of Terraform supported by the terraform-plugin-framework Go module, currently Terraform 0.12 and later.

Reference: #57
Reference: hashicorp/terraform#31575

Terraform output currently does not include the attribute path details if the attribute is not present in the configuration. This can make troubleshooting difficult for practitioners and provider developers.

Even if Terraform implements path details for unconfigured attributes, those details may not necessarily be clear for troubleshooting as they would likely be implemented in a very short, concise manner to reduce diagnostic message noise. Those details would also only be present on recent and future Terraform versions, while these validators support all versions of Terraform supported by the terraform-plugin-framework Go module, currently Terraform 0.12 and later.
@bflad bflad added the bug Something isn't working label Aug 28, 2022
@bflad bflad added this to the v0.5.0 milestone Aug 28, 2022
@bflad bflad requested a review from a team as a code owner August 28, 2022 19:13
Copy link
Contributor

@bendbennett bendbennett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bflad bflad merged commit 2299f55 into main Aug 30, 2022
@bflad bflad deleted the bflad/path-in-diags branch August 30, 2022 14:44
@github-actions
Copy link

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.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Terraform validators support a custom message
2 participants