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

Fix provider configuration code to handle Unknown values correctly #8943

Merged
merged 15 commits into from
Sep 19, 2023
Merged

Fix provider configuration code to handle Unknown values correctly #8943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c5bb798
Uncomment test cases for unknown values
SarahFrench Sep 13, 2023
e2801cd
Update test case names
SarahFrench Sep 13, 2023
2b25ad0
Update unknown value test for `project`, make it pass
SarahFrench Sep 13, 2023
47c06cf
Update unknown value test for `access_token`, make `access_token` and…
SarahFrench Sep 13, 2023
4f56cf5
Update unknown value tests for `region` and `zone`, make those tests …
SarahFrench Sep 13, 2023
8609564
Update unknown value tests for `user_project_override`, make that tes…
SarahFrench Sep 13, 2023
a5401b1
Update unknown value test for `impersonate_service_account`, make tha…
SarahFrench Sep 13, 2023
2fe75ac
Update unknown value tests for `request_reason` and `request_timeout`…
SarahFrench Sep 13, 2023
f4536d3
Make unknown batching.send_after and batching.enable_batching values …
SarahFrench Sep 13, 2023
6f4af5a
Update code to handle when the whole batching block is Unknown
SarahFrench Sep 13, 2023
43ef3c5
Update the test function for `batching` unit tests to navigate how `G…
SarahFrench Sep 13, 2023
338961d
Update code to handle null/unknown Scopes and ImpersonateServiceAccou…
SarahFrench Sep 13, 2023
cd9fde2
Improve `impersonate_service_account_delegates` tests for unknown values
SarahFrench Sep 13, 2023
54564b9
Add missing null test case for `batching` field
SarahFrench Sep 14, 2023
15761f7
Add non-VCR acceptance test to assert handling of unknown values in p…
SarahFrench Sep 19, 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
51 changes: 28 additions & 23 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 @@ -188,7 +188,7 @@ func (p *FrameworkProviderConfig) HandleZeroValues(ctx context.Context, data *fw

// 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.Credentials.IsNull() {
if (data.AccessToken.IsNull() || data.AccessToken.IsUnknown()) && (data.Credentials.IsNull() || data.Credentials.IsUnknown()) {
credentials := transport_tpg.MultiEnvDefault([]string{
"GOOGLE_CREDENTIALS",
"GOOGLE_CLOUD_KEYFILE_JSON",
Expand All @@ -208,11 +208,11 @@ func (p *FrameworkProviderConfig) HandleDefaults(ctx context.Context, data *fwmo
}
}

if data.ImpersonateServiceAccount.IsNull() && os.Getenv("GOOGLE_IMPERSONATE_SERVICE_ACCOUNT") != "" {
if (data.ImpersonateServiceAccount.IsNull() || data.ImpersonateServiceAccount.IsUnknown()) && os.Getenv("GOOGLE_IMPERSONATE_SERVICE_ACCOUNT") != "" {
data.ImpersonateServiceAccount = types.StringValue(os.Getenv("GOOGLE_IMPERSONATE_SERVICE_ACCOUNT"))
}

if data.Project.IsNull() {
if data.Project.IsNull() || data.Project.IsUnknown() {
project := transport_tpg.MultiEnvDefault([]string{
"GOOGLE_PROJECT",
"GOOGLE_CLOUD_PROJECT",
Expand All @@ -228,7 +228,7 @@ func (p *FrameworkProviderConfig) HandleDefaults(ctx context.Context, data *fwmo
data.BillingProject = types.StringValue(os.Getenv("GOOGLE_BILLING_PROJECT"))
}

if data.Region.IsNull() {
if data.Region.IsNull() || data.Region.IsUnknown() {
region := transport_tpg.MultiEnvDefault([]string{
"GOOGLE_REGION",
"GCLOUD_REGION",
Expand All @@ -240,7 +240,7 @@ func (p *FrameworkProviderConfig) HandleDefaults(ctx context.Context, data *fwmo
}
}

if data.Zone.IsNull() {
if data.Zone.IsNull() || data.Zone.IsUnknown() {
zone := transport_tpg.MultiEnvDefault([]string{
"GOOGLE_ZONE",
"GCLOUD_ZONE",
Expand All @@ -261,26 +261,26 @@ func (p *FrameworkProviderConfig) HandleDefaults(ctx context.Context, data *fwmo
}
}

if !data.Batching.IsNull() {
if !data.Batching.IsNull() && !data.Batching.IsUnknown() {
var pbConfigs []fwmodels.ProviderBatching
d := data.Batching.ElementsAs(ctx, &pbConfigs, true)
diags.Append(d...)
if diags.HasError() {
return
}

if pbConfigs[0].SendAfter.IsNull() {
if pbConfigs[0].SendAfter.IsNull() || pbConfigs[0].SendAfter.IsUnknown() {
pbConfigs[0].SendAfter = types.StringValue("10s")
}

if pbConfigs[0].EnableBatching.IsNull() {
if pbConfigs[0].EnableBatching.IsNull() || pbConfigs[0].EnableBatching.IsUnknown() {
pbConfigs[0].EnableBatching = types.BoolValue(true)
}

data.Batching, d = types.ListValueFrom(ctx, types.ObjectType{}.WithAttributeTypes(fwmodels.ProviderBatchingAttributes), pbConfigs)
}

if data.UserProjectOverride.IsNull() && os.Getenv("USER_PROJECT_OVERRIDE") != "" {
if (data.UserProjectOverride.IsNull() || data.UserProjectOverride.IsUnknown()) && os.Getenv("USER_PROJECT_OVERRIDE") != "" {
override, err := strconv.ParseBool(os.Getenv("USER_PROJECT_OVERRIDE"))
if err != nil {
diags.AddError(
Expand All @@ -289,11 +289,11 @@ func (p *FrameworkProviderConfig) HandleDefaults(ctx context.Context, data *fwmo
data.UserProjectOverride = types.BoolValue(override)
}

if data.RequestReason.IsNull() && os.Getenv("CLOUDSDK_CORE_REQUEST_REASON") != "" {
if (data.RequestReason.IsNull() || data.RequestReason.IsUnknown()) && os.Getenv("CLOUDSDK_CORE_REQUEST_REASON") != "" {
data.RequestReason = types.StringValue(os.Getenv("CLOUDSDK_CORE_REQUEST_REASON"))
}

if data.RequestTimeout.IsNull() {
if data.RequestTimeout.IsNull() || data.RequestTimeout.IsUnknown() {
data.RequestTimeout = types.StringValue("120s")
}

Expand Down Expand Up @@ -595,7 +595,7 @@ func (p *FrameworkProviderConfig) logGoogleIdentities(ctx context.Context, data
// a separate diagnostics here
var d diag.Diagnostics

if data.ImpersonateServiceAccount.IsNull() {
if data.ImpersonateServiceAccount.IsNull() || data.ImpersonateServiceAccount.IsUnknown() {

tokenSource := GetTokenSource(ctx, data, true, diags)
if diags.HasError() {
Expand Down Expand Up @@ -655,19 +655,23 @@ func GetCredentials(ctx context.Context, data fwmodels.ProviderModel, initialCre
var clientScopes []string
var delegates []string

d := data.Scopes.ElementsAs(ctx, &clientScopes, false)
diags.Append(d...)
if diags.HasError() {
return googleoauth.Credentials{}
if !data.Scopes.IsNull() && !data.Scopes.IsUnknown() {
d := data.Scopes.ElementsAs(ctx, &clientScopes, false)
diags.Append(d...)
if diags.HasError() {
return googleoauth.Credentials{}
}
}

d = data.ImpersonateServiceAccountDelegates.ElementsAs(ctx, &delegates, false)
diags.Append(d...)
if diags.HasError() {
return googleoauth.Credentials{}
if !data.ImpersonateServiceAccountDelegates.IsNull() && !data.ImpersonateServiceAccountDelegates.IsUnknown() {
d := data.ImpersonateServiceAccountDelegates.ElementsAs(ctx, &delegates, false)
diags.Append(d...)
if diags.HasError() {
return googleoauth.Credentials{}
}
}

if !data.AccessToken.IsNull() {
if !data.AccessToken.IsNull() && !data.AccessToken.IsUnknown() {
contents, _, err := verify.PathOrContents(data.AccessToken.ValueString())
if err != nil {
diags.AddError("error loading access token", err.Error())
Expand All @@ -692,7 +696,7 @@ func GetCredentials(ctx context.Context, data fwmodels.ProviderModel, initialCre
}
}

if !data.Credentials.IsNull() {
if !data.Credentials.IsNull() && !data.Credentials.IsUnknown() {
contents, _, err := verify.PathOrContents(data.Credentials.ValueString())
if err != nil {
diags.AddError(fmt.Sprintf("error loading credentials: %s", err), err.Error())
Expand Down Expand Up @@ -751,7 +755,8 @@ func GetBatchingConfig(ctx context.Context, data types.List, diags *diag.Diagnos
EnableBatching: true,
}

if data.IsNull() {
// Handle if entire batching block is null/unknown
if data.IsNull() || data.IsUnknown() {
return bc
}

Expand Down
Loading