Prevent validators from dropping diags #619
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
bflad
approved these changes
Jan 11, 2023
There was a problem hiding this comment.
Code-wise this looks really good! Thank you, @skirsten 🚀
If you're interested, we could ensure there's covering unit testing for this by updating/duplicating unit testing like TestServerValidateProviderConfig/request-config-ProviderWithValidateConfig-diagnostic to have multiple validators returning diagnostics.
To create changelog entries for this, you can create a .changelog/619.txt file with contents such as:
```release-note:bug
datasource: Prevented `ConfigValidators` from unexpectedly modifying or removing prior validator diagnostics
```
```release-note:bug
provider: Prevented `ConfigValidators` from unexpectedly modifying or removing prior validator diagnostics
```
```release-note:bug
resource: Prevented `ConfigValidators` from unexpectedly modifying or removing prior validator diagnostics
```
bflad
added a commit
that referenced
this pull request
Jan 13, 2023
…agnostics overwrites Reference: #619 Against current `main`: ``` --- FAIL: TestServerValidateDataSourceConfig (0.00s) --- FAIL: TestServerValidateDataSourceConfig/request-config-DataSourceWithConfigValidators-diagnostics (0.00s) /Users/bflad/src/github.com/hashicorp/terraform-plugin-framework/internal/fwserver/server_validatedatasourceconfig_test.go:301: unexpected difference: &fwserver.ValidateDataSourceConfigResponse{ - Diagnostics: diag.Diagnostics{diag.ErrorDiagnostic{detail: "error detail 2", summary: "error summary 2"}}, + Diagnostics: diag.Diagnostics{ + diag.ErrorDiagnostic{detail: "error detail 1", summary: "error summary 1"}, + diag.ErrorDiagnostic{detail: "error detail 2", summary: "error summary 2"}, + }, } --- FAIL: TestServerValidateProviderConfig (0.00s) --- FAIL: TestServerValidateProviderConfig/request-config-ProviderWithConfigValidators-diagnostics (0.00s) /Users/bflad/src/github.com/hashicorp/terraform-plugin-framework/internal/fwserver/server_validateproviderconfig_test.go:307: unexpected difference: &fwserver.ValidateProviderConfigResponse{ PreparedConfig: &{Raw: s`tftypes.Object["test":tftypes.String]<"test":tftypes.String<"tes`..., Schema: schema.Schema{Attributes: {"test": schema.StringAttribute{Required: true}}}}, - Diagnostics: diag.Diagnostics{diag.ErrorDiagnostic{detail: "error detail 2", summary: "error summary 2"}}, + Diagnostics: diag.Diagnostics{ + diag.ErrorDiagnostic{detail: "error detail 1", summary: "error summary 1"}, + diag.ErrorDiagnostic{detail: "error detail 2", summary: "error summary 2"}, + }, } --- FAIL: TestServerValidateResourceConfig (0.00s) --- FAIL: TestServerValidateResourceConfig/request-config-ResourceWithConfigValidators-diagnostics (0.00s) /Users/bflad/src/github.com/hashicorp/terraform-plugin-framework/internal/fwserver/server_validateresourceconfig_test.go:301: unexpected difference: &fwserver.ValidateResourceConfigResponse{ - Diagnostics: diag.Diagnostics{diag.ErrorDiagnostic{detail: "error detail 2", summary: "error summary 2"}}, + Diagnostics: diag.Diagnostics{ + diag.ErrorDiagnostic{detail: "error detail 1", summary: "error summary 1"}, + diag.ErrorDiagnostic{detail: "error detail 2", summary: "error summary 2"}, + }, } ```
|
Will handle the unit testing and changelog via: #622 |
|
Thank you @bflad for taking care of it 🙏 I had a quick look yesterday but did not find the time. |
bflad
added a commit
that referenced
this pull request
Jan 13, 2023
…agnostics overwrites (#622) Reference: #619 Against current `main`: ``` --- FAIL: TestServerValidateDataSourceConfig (0.00s) --- FAIL: TestServerValidateDataSourceConfig/request-config-DataSourceWithConfigValidators-diagnostics (0.00s) /Users/bflad/src/github.com/hashicorp/terraform-plugin-framework/internal/fwserver/server_validatedatasourceconfig_test.go:301: unexpected difference: &fwserver.ValidateDataSourceConfigResponse{ - Diagnostics: diag.Diagnostics{diag.ErrorDiagnostic{detail: "error detail 2", summary: "error summary 2"}}, + Diagnostics: diag.Diagnostics{ + diag.ErrorDiagnostic{detail: "error detail 1", summary: "error summary 1"}, + diag.ErrorDiagnostic{detail: "error detail 2", summary: "error summary 2"}, + }, } --- FAIL: TestServerValidateProviderConfig (0.00s) --- FAIL: TestServerValidateProviderConfig/request-config-ProviderWithConfigValidators-diagnostics (0.00s) /Users/bflad/src/github.com/hashicorp/terraform-plugin-framework/internal/fwserver/server_validateproviderconfig_test.go:307: unexpected difference: &fwserver.ValidateProviderConfigResponse{ PreparedConfig: &{Raw: s`tftypes.Object["test":tftypes.String]<"test":tftypes.String<"tes`..., Schema: schema.Schema{Attributes: {"test": schema.StringAttribute{Required: true}}}}, - Diagnostics: diag.Diagnostics{diag.ErrorDiagnostic{detail: "error detail 2", summary: "error summary 2"}}, + Diagnostics: diag.Diagnostics{ + diag.ErrorDiagnostic{detail: "error detail 1", summary: "error summary 1"}, + diag.ErrorDiagnostic{detail: "error detail 2", summary: "error summary 2"}, + }, } --- FAIL: TestServerValidateResourceConfig (0.00s) --- FAIL: TestServerValidateResourceConfig/request-config-ResourceWithConfigValidators-diagnostics (0.00s) /Users/bflad/src/github.com/hashicorp/terraform-plugin-framework/internal/fwserver/server_validateresourceconfig_test.go:301: unexpected difference: &fwserver.ValidateResourceConfigResponse{ - Diagnostics: diag.Diagnostics{diag.ErrorDiagnostic{detail: "error detail 2", summary: "error summary 2"}}, + Diagnostics: diag.Diagnostics{ + diag.ErrorDiagnostic{detail: "error detail 1", summary: "error summary 1"}, + diag.ErrorDiagnostic{detail: "error detail 2", summary: "error summary 2"}, + }, } ```
|
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.
More info here: hashicorp/terraform-plugin-framework-validators#94
Basically, it just makes sure the validators cannot accidentally drop previous diags.