helper/schema: Ensure (ResourceData).GetRawConfig() is populated in provider Configure functions #1271
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
…rovider Configure functions Reference: #1270 This change is intended to be as targeted as possible to prevent other unintended changes. In other RPCs, the protocol configuration data is able to be set upfront via `terraform.InstanceState`, however for provider configuration it is still using the legacy `terraform.ResourceConfig` value which previously did not have the same data field. This adds the data field while trying to be pragmatic about potentially breaking compatibility with the unfortunately exported APIs in this SDK. New test failures prior to updating logic: ``` --- FAIL: TestProviderConfigure (0.00s) --- FAIL: TestProviderConfigure/ConfigureContextFunc-GetRawConfig (0.00s) /Users/bflad/src/github.com/hashicorp/terraform-plugin-sdk/helper/schema/provider_test.go:338: Unexpected diagnostics (-wanted +got): diag.Diagnostics( - nil, + {{Summary: "unexpected GetRawConfig difference: expected: {{{{} map[test:{{{"...}}, ) --- FAIL: TestProviderConfigure/ConfigureFunc-GetRawConfig (0.00s) /Users/bflad/src/github.com/hashicorp/terraform-plugin-sdk/helper/schema/provider_test.go:338: Unexpected diagnostics (-wanted +got): diag.Diagnostics( - nil, + {{Summary: "unexpected GetRawConfig difference: expected: {{{{} map[test:{{{"...}}, ) --- FAIL: TestGRPCProviderServerConfigureProvider (0.00s) --- FAIL: TestGRPCProviderServerConfigureProvider/ConfigureContextFunc-GetRawConfig (0.00s) /Users/bflad/src/github.com/hashicorp/terraform-plugin-sdk/helper/schema/grpc_provider_test.go:343: unexpected difference: &tfprotov5.ConfigureProviderResponse{ - Diagnostics: []*tfprotov5.Diagnostic{ - &{ - Severity: s"ERROR", - Summary: "unexpected difference: expected: {{{{} map[test:{{{} %!s(cty.pri"..., - }, - }, + Diagnostics: nil, } --- FAIL: TestGRPCProviderServerConfigureProvider/ConfigureFunc-GetRawConfig (0.00s) /Users/bflad/src/github.com/hashicorp/terraform-plugin-sdk/helper/schema/grpc_provider_test.go:343: unexpected difference: &tfprotov5.ConfigureProviderResponse{ - Diagnostics: []*tfprotov5.Diagnostic{ - &{ - Severity: s"ERROR", - Summary: "unexpected difference: expected: {{{{} map[test:{{{} %!s(cty.pri"..., - }, - }, + Diagnostics: nil, } ```
austinvalle
approved these changes
Nov 2, 2023
This change also fixes `GetOkExists()` handling for provider configuration.
Updated tests prior to logic updates:
```
--- FAIL: TestProviderConfigure (0.00s)
--- FAIL: TestProviderConfigure/ConfigureContextFunc-GetOkExists-zero-value (0.00s)
/Users/bflad/src/github.com/hashicorp/terraform-plugin-sdk/helper/schema/provider_test.go:924: Unexpected diagnostics (-wanted +got): diag.Diagnostics(
- nil,
+ {{Summary: "unexpected GetOkExists difference: expected: false, got: true"}},
)
--- FAIL: TestProviderConfigure/ConfigureFunc-GetOkExists-zero-value (0.00s)
/Users/bflad/src/github.com/hashicorp/terraform-plugin-sdk/helper/schema/provider_test.go:924: Unexpected diagnostics (-wanted +got): diag.Diagnostics(
- nil,
+ {{Summary: "unexpected GetOkExists difference: expected: false, got: true"}},
)
```
Provider configuration only contains configuration data. It does not participate in the plan (similar to data sources) nor does Terraform preserve a prior state. |
This verifies it is safe to always set the `ResourceConfig` regardless of the presence of `InstanceDiff`, ensuring that `GetOkExists()` should work in both cases without affecting existing behavior.
|
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 #1270
This change is intended to be as targeted as possible to prevent other unintended changes. In other RPCs, the protocol configuration data is able to be set upfront via
terraform.InstanceState, however for provider configuration it is still using the legacyterraform.ResourceConfigvalue which previously did not have the same data field. This adds the data field while trying to be pragmatic about potentially breaking compatibility with the unfortunately exported APIs in this SDK.This change also tangentially fixes
GetOkExiststo now return atruesecond result when a configurationNew test failures prior to updating logic:
In terms of prior (errant)
GetOkExists()behavior, this causes this behavior change/fix: