Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Unignore empty values in the provider configuration block in 5.0.0 #9014

Merged
merged 6 commits into from
Sep 22, 2023
Merged

Unignore empty values in the provider configuration block in 5.0.0 #9014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1ea56a2
Stop validating `""` as valid `credentials` value in the PF provider …
SarahFrench Sep 19, 2023
c5d4bfe
Remove code that makes PF ignore empty values
SarahFrench Sep 21, 2023
932d902
Update PF config code tests to match change in PF config code behaviour
SarahFrench Sep 21, 2023
6519942
Update remaining PF config code tests
SarahFrench Sep 21, 2023
10531cd
Update test for the PF version of credentials validator
SarahFrench Sep 21, 2023
64fcf99
Make not on SDK version of credentials validator that it cannot disti…
SarahFrench Sep 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion mmv1/third_party/terraform/fwprovider/framework_provider_internal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,11 @@ func TestFrameworkProvider_CredentialsValidator(t *testing.T) {
return types.StringValue(stringContents)
},
},
"configuring credentials as an empty string is valid": {
"configuring credentials as an empty string is not valid": {
ConfigValue: func(t *testing.T) types.String {
return types.StringValue("")
},
ExpectedErrorCount: 1,
},
"leaving credentials unconfigured is valid": {
ConfigValue: func(t *testing.T) types.String {
Expand Down
3 changes: 1 addition & 2 deletions mmv1/third_party/terraform/fwprovider/framework_validators.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import (
"time"

"github.com/hashicorp/terraform-plugin-framework/schema/validator"
"github.com/hashicorp/terraform-plugin-framework/types"

googleoauth "golang.org/x/oauth2/google"
)
Expand All @@ -31,7 +30,7 @@ func (v credentialsValidator) MarkdownDescription(ctx context.Context) string {

// ValidateString performs the validation.
func (v credentialsValidator) ValidateString(ctx context.Context, request validator.StringRequest, response *validator.StringResponse) {
if request.ConfigValue.IsNull() || request.ConfigValue.IsUnknown() || request.ConfigValue.Equal(types.StringValue("")) {
if request.ConfigValue.IsNull() || request.ConfigValue.IsUnknown() {
return
}

Expand Down
81 changes: 0 additions & 81 deletions mmv1/third_party/terraform/fwtransport/framework_config.go.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import (
"google.golang.org/grpc"

"github.com/hashicorp/go-cleanhttp"
"github.com/hashicorp/terraform-plugin-framework/attr"
"github.com/hashicorp/terraform-plugin-framework/diag"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-log/tflog"
Expand Down Expand Up @@ -56,15 +55,6 @@ type FrameworkProviderConfig struct {
// LoadAndValidateFramework handles the bulk of configuring the provider
// it is pulled out so that we can manually call this from our testing provider as well
func (p *FrameworkProviderConfig) LoadAndValidateFramework(ctx context.Context, data *fwmodels.ProviderModel, tfVersion string, diags *diag.Diagnostics, providerversion string) {


// Make the plugin framwork code behave like the SDK by ignoring zero values. This means re-setting zero values to null.
// This is added to fix https://github.com/hashicorp/terraform-provider-google/issues/14255 in a v4.x.x release
// TODO(SarahFrench) remove as part of https://github.com/hashicorp/terraform-provider-google/issues/14447 in 5.0.0
p.HandleZeroValues(ctx, data, diags)
if diags.HasError() {
return
}

// Set defaults if needed
p.HandleDefaults(ctx, data, diags)
Expand Down Expand Up @@ -115,77 +105,6 @@ func (p *FrameworkProviderConfig) LoadAndValidateFramework(ctx context.Context,
p.RequestBatcherIam = transport_tpg.NewRequestBatcher("IAM", ctx, batchingConfig)
}

// HandleZeroValues will make the plugin framework act like the SDK; zero value, particularly empty strings, are converted to null.
// This causes the plugin framework to treat the field as unset, just like how the SDK ignores empty strings.
func (p *FrameworkProviderConfig) HandleZeroValues(ctx context.Context, data *fwmodels.ProviderModel, diags *diag.Diagnostics) {

// Change empty strings to null values
if data.AccessToken.Equal(types.StringValue("")) {
data.AccessToken = types.StringNull()
}
if data.BillingProject.Equal(types.StringValue("")) {
data.BillingProject = types.StringNull()
}
if data.Credentials.Equal(types.StringValue("")) {
data.Credentials = types.StringNull()
}
if data.ImpersonateServiceAccount.Equal(types.StringValue("")) {
data.ImpersonateServiceAccount = types.StringNull()
}
if data.Project.Equal(types.StringValue("")) {
data.Project = types.StringNull()
}
if data.Region.Equal(types.StringValue("")) {
data.Region = types.StringNull()
}
if data.RequestReason.Equal(types.StringValue("")) {
data.RequestReason = types.StringNull()
}
if data.RequestTimeout.Equal(types.StringValue("")) {
data.RequestTimeout = types.StringNull()
}
if data.Zone.Equal(types.StringValue("")) {
data.Zone = types.StringNull()
}

// Change lists that aren't null or unknown with length of zero to null lists
if !data.Scopes.IsNull() && !data.Scopes.IsUnknown() && (len(data.Scopes.Elements()) == 0) {
data.Scopes = types.ListNull(types.StringType)
}
if !data.ImpersonateServiceAccountDelegates.IsNull() && !data.ImpersonateServiceAccountDelegates.IsUnknown() && (len(data.ImpersonateServiceAccountDelegates.Elements()) == 0) {
data.ImpersonateServiceAccountDelegates = types.ListNull(types.StringType)
}

// Batching implementation will change in future, but this code will be removed in 5.0.0 so may be unaffected
if !data.Batching.IsNull() && !data.Batching.IsUnknown() && (len(data.Batching.Elements()) > 0) {
var pbConfigs []fwmodels.ProviderBatching
d := data.Batching.ElementsAs(ctx, &pbConfigs, true)
diags.Append(d...)
if diags.HasError() {
return
}
if pbConfigs[0].SendAfter.Equal(types.StringValue("")) {
pbConfigs[0].SendAfter = types.StringNull() // Convert empty string to null
}
b, _ := types.ObjectValue(
map[string]attr.Type{
"enable_batching": types.BoolType,
"send_after": types.StringType,
},
map[string]attr.Value{
"enable_batching": pbConfigs[0].EnableBatching,
"send_after": pbConfigs[0].SendAfter,
},
)
newBatching, d := types.ListValue(types.ObjectType{}.WithAttributeTypes(fwmodels.ProviderBatchingAttributes), []attr.Value{b})
diags.Append(d...)
if diags.HasError() {
return
}
data.Batching = newBatching
}
}

// HandleDefaults will handle all the defaults necessary in the provider
func (p *FrameworkProviderConfig) HandleDefaults(ctx context.Context, data *fwmodels.ProviderModel, diags *diag.Diagnostics) {
if (data.AccessToken.IsNull() || data.AccessToken.IsUnknown()) && (data.Credentials.IsNull() || data.Credentials.IsUnknown()) {
Expand Down
Loading