tfsdk: Return warning diagnostic when using Attribute or Schema type DeprecationMessage field
#93
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
…ype `DeprecationMessage` field Reference: #71
paddycarver
suggested changes
Aug 16, 2021
tfsdk/attribute.go
Outdated
| @@ -344,4 +344,13 @@ func (a Attribute) validate(ctx context.Context, req ValidateAttributeRequest, r | |||
| return | |||
| } | |||
| } | |||
|
|
|||
| if a.DeprecationMessage != "" { | |||
There was a problem hiding this comment.
Wouldn't we only want to return the error if the value wasn't null?
There was a problem hiding this comment.
Yes, we would! Good catch. Testing updated to catch this:
--- FAIL: TestAttributeValidate (0.00s)
--- FAIL: TestAttributeValidate/deprecation-message-null (0.00s)
attribute_test.go:1313: Unexpected response (+wanted, -got): tfsdk.ValidateAttributeResponse{
- Diagnostics: []*tfprotov6.Diagnostic{
- &{
- Severity: s"WARNING",
- Summary: "Attribute Deprecated",
- Detail: "Use something else instead.",
- Attribute: s`AttributeName("test")`,
- },
- },
+ Diagnostics: nil,
}
Fix will be included in next commit.
tfsdk/attribute_test.go
Outdated
| @@ -803,6 +803,39 @@ func TestAttributeValidate(t *testing.T) { | |||
| }, | |||
| resp: ValidateAttributeResponse{}, | |||
| }, | |||
| "deprecation-message": { | |||
There was a problem hiding this comment.
Would love to see a test for when the value is:
- present
- absent
- unknown
paddycarver
approved these changes
Aug 16, 2021
|
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.
Closes #71