add default provider value plan modifiers/small utils upgrades to fwprovider templates (#15011)

Author: NickElliot

mmv1/templates/terraform/resource_fw.go.tmpl

@@ -74,8 +74,11 @@ import (
 {{- end}}
 
 var (
-	_ resource.Resource              = &{{$.ResourceName}}FWResource{}
-	_ resource.ResourceWithConfigure = &{{$.ResourceName}}FWResource{}
+	_ resource.Resource                = &{{$.ResourceName}}FWResource{}
+	_ resource.ResourceWithConfigure   = &{{$.ResourceName}}FWResource{}
+{{- if or (and (or $.HasProject $.HasRegion $.HasZone) (not $.ExcludeDefaultCdiff)) $.CustomDiff }}
+	_ resource.ResourceWithModifyPlan  = &{{$.ResourceName}}FWResource{}
+{{- end}}
 )
 
 func New{{$.ResourceName}}FWResource() resource.Resource {
@@ -128,6 +131,23 @@ func (r *{{$.ResourceName}}FWResource) Configure(ctx context.Context, req resour
 	r.providerConfig = p
 }
 
+{{- if or (and (or $.HasProject $.HasRegion $.HasZone) (not $.ExcludeDefaultCdiff)) $.CustomDiff }}
+func (r *{{$.ResourceName}}FWResource) ModifyPlan(ctx context.Context, req resource.ModifyPlanRequest, resp *resource.ModifyPlanResponse) {
+{{- if and ($.HasProject) (not $.ExcludeDefaultCdiff) }}
+	fwresource.DefaultProjectModify(ctx, req, resp, r.providerConfig.Project)
+{{- end -}}
+{{if and ($.HasRegion) (not $.ExcludeDefaultCdiff)  }}
+	fwresource.DefaultRegionModify(ctx, req, resp, r.providerConfig.Region)
+{{- end -}}
+{{if and ($.HasZone) (not $.ExcludeDefaultCdiff)  }}
+	fwresource.DefaultZoneModify(ctx, req, resp, r.providerConfig.Zone)
+{{- end }}
+	if resp.Diagnostics.HasError() {
+		return
+	}
+}
+{{- end}}
+
 func (d *{{$.ResourceName}}FWResource) Schema(ctx context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
 		MarkdownDescription: "A resource to represent a SQL User object.",
@@ -263,7 +283,7 @@ func (r *{{$.ResourceName}}FWResource) Create(ctx context.Context, req resource.
 {{- if $.CustomCode.PreCreate }}
     {{ $.CustomTemplate $.CustomCode.PreCreate false -}}
 {{- end}}
-    res := fwtransport.SendRequest(fwtransport.SendRequestOptions{
+    res, err := fwtransport.SendRequest(fwtransport.SendRequestOptions{
         Config: r.providerConfig,
         Method: "{{ upper $.CreateVerb -}}",
         Project: billingProject.ValueString(),
@@ -483,7 +503,7 @@ func (r *{{$.ResourceName}}FWResource) Update(ctx context.Context, req resource.
 {{- if $.CustomCode.PreUpdate }}
     {{ $.CustomTemplate $.CustomCode.PreUpdate false -}}
 {{- end}}
-    res := fwtransport.SendRequest(fwtransport.SendRequestOptions{
+    res, err := fwtransport.SendRequest(fwtransport.SendRequestOptions{
         Config: r.providerConfig,
         Method: "{{ upper $.UpdateVerb -}}",
         Project: billingProject.ValueString(),
@@ -622,7 +642,7 @@ func (r *{{$.ResourceName}}FWResource) Delete(ctx context.Context, req resource.
     {{- end }}
 
     log.Printf("[DEBUG] Deleting {{ $.Name }} %q", data.Id.ValueString())
-    res := fwtransport.SendRequest(fwtransport.SendRequestOptions{
+    _, _ := fwtransport.SendRequest(fwtransport.SendRequestOptions{
         Config: r.providerConfig,
         Method: "{{ upper $.DeleteVerb -}}",
         Project: billingProject.ValueString(),
@@ -727,7 +747,7 @@ func (r *{{$.ResourceName}}FWResource) {{$.ResourceName}}FWRefresh(ctx context.C
 {{- if $.CustomCode.PreRead }}
     {{ $.CustomTemplate $.CustomCode.PreRead false -}}
 {{- end}}
-    res := fwtransport.SendRequest(fwtransport.SendRequestOptions{
+    res, err := fwtransport.SendRequest(fwtransport.SendRequestOptions{
         Config: r.providerConfig,
         Method: "{{ upper $.ReadVerb -}}",
         Project: billingProject.ValueString(),

mmv1/third_party/terraform/fwresource/field_helpers.go

@@ -37,7 +37,7 @@ func getProviderDefaultFromFrameworkSchema(schemaField string, rVal, pVal types.
 		return pVal
 	}
 
-	diags.AddError("required field is not set", fmt.Sprintf("%s is not set", schemaField))
+	diags.AddError("required field is not set", fmt.Sprintf("%s must be set in at least one of Terraform resource configuration, Terraform provider configuration, or environment variables.", schemaField))
 	return types.String{}
 }
 

mmv1/third_party/terraform/fwresource/framework_common_plan_modifiers.go

@@ -0,0 +1,84 @@
+package fwresource
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework/path"
+	"github.com/hashicorp/terraform-plugin-framework/resource"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+func DefaultProjectModify(ctx context.Context, req resource.ModifyPlanRequest, resp *resource.ModifyPlanResponse, providerConfigProject string) {
+	var old types.String
+	diags := req.State.GetAttribute(ctx, path.Root("project"), &old)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	var new types.String
+	diags = req.Plan.GetAttribute(ctx, path.Root("project"), &new)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	if (old.IsUnknown() || old.IsNull()) && new.IsUnknown() {
+		project := GetProjectFramework(new, types.StringValue(providerConfigProject), &resp.Diagnostics)
+		if resp.Diagnostics.HasError() {
+			return
+		}
+		resp.Plan.SetAttribute(ctx, path.Root("project"), project)
+	}
+	return
+}
+
+func DefaultRegionModify(ctx context.Context, req resource.ModifyPlanRequest, resp *resource.ModifyPlanResponse, providerConfigRegion string) {
+	var old types.String
+	diags := req.State.GetAttribute(ctx, path.Root("region"), &old)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	var new types.String
+	diags = req.Plan.GetAttribute(ctx, path.Root("region"), &new)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	if (old.IsUnknown() || old.IsNull()) && new.IsUnknown() {
+		region := GetRegionFramework(new, types.StringValue(providerConfigRegion), &resp.Diagnostics)
+		if resp.Diagnostics.HasError() {
+			return
+		}
+		resp.Plan.SetAttribute(ctx, path.Root("region"), region)
+	}
+	return
+}
+
+func DefaultZoneModify(ctx context.Context, req resource.ModifyPlanRequest, resp *resource.ModifyPlanResponse, providerConfigZone string) {
+	var old types.String
+	diags := req.State.GetAttribute(ctx, path.Root("zone"), &old)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	var new types.String
+	diags = req.Plan.GetAttribute(ctx, path.Root("zone"), &new)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	if (old.IsUnknown() || old.IsNull()) && new.IsUnknown() {
+		zone := GetZoneFramework(new, types.StringValue(providerConfigZone), &resp.Diagnostics)
+		if resp.Diagnostics.HasError() {
+			return
+		}
+		resp.Plan.SetAttribute(ctx, path.Root("zone"), zone)
+	}
+	return
+}