Propagate tf:"suppress_diff" to child attributes (#981)

* Propagate diff suppression also to nested fields of a configuration block, if it's marked for diff suppression.
* Log more precise log messages when this happens.

Fix #942

Author: nfx

README.md

@@ -112,8 +112,6 @@ resource "databricks_job" "this" {
   notebook_task {
     notebook_path = databricks_notebook.this.path
   }
-
-  email_notifications {}
 }
 
 output "notebook_url" {

clusters/clusters_api.go

@@ -130,29 +130,29 @@ type ZonesInfo struct {
 // AwsAttributes encapsulates the aws attributes for aws based clusters
 // https://docs.databricks.com/dev-tools/api/latest/clusters.html#clusterclusterattributes
 type AwsAttributes struct {
-	FirstOnDemand       int32         `json:"first_on_demand,omitempty" tf:"computed"`
-	Availability        Availability  `json:"availability,omitempty" tf:"computed"`
-	ZoneID              string        `json:"zone_id,omitempty" tf:"computed"`
+	FirstOnDemand       int32         `json:"first_on_demand,omitempty"`
+	Availability        Availability  `json:"availability,omitempty"`
+	ZoneID              string        `json:"zone_id,omitempty"`
 	InstanceProfileArn  string        `json:"instance_profile_arn,omitempty"`
-	SpotBidPricePercent int32         `json:"spot_bid_price_percent,omitempty" tf:"computed"`
-	EbsVolumeType       EbsVolumeType `json:"ebs_volume_type,omitempty" tf:"computed"`
-	EbsVolumeCount      int32         `json:"ebs_volume_count,omitempty" tf:"computed"`
-	EbsVolumeSize       int32         `json:"ebs_volume_size,omitempty" tf:"computed"`
+	SpotBidPricePercent int32         `json:"spot_bid_price_percent,omitempty"`
+	EbsVolumeType       EbsVolumeType `json:"ebs_volume_type,omitempty"`
+	EbsVolumeCount      int32         `json:"ebs_volume_count,omitempty"`
+	EbsVolumeSize       int32         `json:"ebs_volume_size,omitempty"`
 }
 
 // AzureAttributes encapsulates the Azure attributes for Azure based clusters
 // https://docs.microsoft.com/en-us/azure/databricks/dev-tools/api/latest/clusters#clusterazureattributes
 type AzureAttributes struct {
-	FirstOnDemand   int32        `json:"first_on_demand,omitempty" tf:"computed"`
-	Availability    Availability `json:"availability,omitempty" tf:"computed"`
-	SpotBidMaxPrice float64      `json:"spot_bid_max_price,omitempty" tf:"computed"`
+	FirstOnDemand   int32        `json:"first_on_demand,omitempty"`
+	Availability    Availability `json:"availability,omitempty"`
+	SpotBidMaxPrice float64      `json:"spot_bid_max_price,omitempty"`
 }
 
 // GcpAttributes encapsultes GCP specific attributes
 // https://docs.gcp.databricks.com/dev-tools/api/latest/clusters.html#clustergcpattributes
 type GcpAttributes struct {
-	UsePreemptibleExecutors bool   `json:"use_preemptible_executors,omitempty" tf:"computed"`
-	GoogleServiceAccount    string `json:"google_service_account,omitempty" tf:"computed"`
+	UsePreemptibleExecutors bool   `json:"use_preemptible_executors,omitempty"`
+	GoogleServiceAccount    string `json:"google_service_account,omitempty"`
 }
 
 // DbfsStorageInfo contains the destination string for DBFS

clusters/resource_cluster.go

@@ -47,9 +47,9 @@ func SparkConfDiffSuppressFunc(k, old, new string, d *schema.ResourceData) bool
 	return false
 }
 
-func AwsAttribsDiffSuppressFunc(k, old, new string, d *schema.ResourceData) bool {
-	if k == "aws_attributes.0.zone_id" && old != "" && new == "auto" {
-		log.Printf("[DEBUG] Suppressing diff for k=%#v old=%#v new=%#v", k, old, new)
+func ZoneDiffSuppress(k, old, new string, d *schema.ResourceData) bool {
+	if old != "" && (new == "auto" || new == "") {
+		log.Printf("[INFO] Suppressing diff on availability zone")
 		return true
 	}
 	return false
@@ -58,7 +58,7 @@ func AwsAttribsDiffSuppressFunc(k, old, new string, d *schema.ResourceData) bool
 func resourceClusterSchema() map[string]*schema.Schema {
 	return common.StructToSchema(Cluster{}, func(s map[string]*schema.Schema) map[string]*schema.Schema {
 		s["spark_conf"].DiffSuppressFunc = SparkConfDiffSuppressFunc
-		s["aws_attributes"].DiffSuppressFunc = AwsAttribsDiffSuppressFunc
+		common.MustSchemaPath(s, "aws_attributes", "zone_id").DiffSuppressFunc = ZoneDiffSuppress
 		// adds `library` configuration block
 		s["library"] = common.StructToSchema(libraries.ClusterLibraryList{},
 			func(ss map[string]*schema.Schema) map[string]*schema.Schema {

common/reflect_resource.go

@@ -146,6 +146,16 @@ func chooseFieldName(typeField reflect.StructField) string {
 	return strings.Split(jsonTag, ",")[0]
 }
 
+func diffSuppressor(zero string) func(k, old, new string, d *schema.ResourceData) bool {
+	return func(k, old, new string, d *schema.ResourceData) bool {
+		if new == zero && old != zero {
+			log.Printf("[DEBUG] Suppressing diff for %v: platform=%#v config=%#v", k, old, new)
+			return true
+		}
+		return false
+	}
+}
+
 // typeToSchema converts struct into terraform schema. `path` is used for block suppressions
 // special path element `"0"` is used to denote either arrays or sets of elements
 func typeToSchema(v reflect.Value, t reflect.Type, path []string) map[string]*schema.Schema {
@@ -201,14 +211,17 @@ func typeToSchema(v reflect.Value, t reflect.Type, path []string) map[string]*sc
 			scm[fieldName].Type = schema.TypeList
 			elem := typeField.Type.Elem()
 			sv := reflect.New(elem).Elem()
+			nestedSchema := typeToSchema(sv, elem, append(path, fieldName, "0"))
 			if strings.Contains(tfTag, "suppress_diff") {
-				// TODO: we may also suppress count diffs on all json:"..,omitempty" without tf:"force_new"
-				// find . -type f -name '*.go' -not -path "vendor/*" | xargs grep ',omitempty' | grep '*'
 				blockCount := strings.Join(append(path, fieldName, "#"), ".")
 				scm[fieldName].DiffSuppressFunc = makeEmptyBlockSuppressFunc(blockCount)
+				for _, v := range nestedSchema {
+					// to those relatively new to GoLang: we must explicitly pass down v by copy
+					v.DiffSuppressFunc = diffSuppressor(fmt.Sprintf("%v", v.Type.Zero()))
+				}
 			}
 			scm[fieldName].Elem = &schema.Resource{
-				Schema: typeToSchema(sv, elem, append(path, fieldName, "0")),
+				Schema: nestedSchema,
 			}
 		case reflect.Slice:
 			ft := schema.TypeList

common/resource.go

@@ -57,12 +57,11 @@ func (r Resource) ToResource() *schema.Resource {
 		for {
 			head := queue[0]
 			queue = queue[1:]
-			for k, v := range head.Schema {
+			for _, v := range head.Schema {
 				if v.Computed {
 					continue
 				}
 				if nested, ok := v.Elem.(*schema.Resource); ok {
-					log.Printf("[DEBUG] %s is a nested block", k)
 					queue = append(queue, nested)
 				}
 				v.ForceNew = true
@@ -137,9 +136,8 @@ func MustCompileKeyRE(name string) *regexp.Regexp {
 func makeEmptyBlockSuppressFunc(name string) func(k, old, new string, d *schema.ResourceData) bool {
 	re := MustCompileKeyRE(name)
 	return func(k, old, new string, d *schema.ResourceData) bool {
-		log.Printf("[DEBUG] name=%s k='%v', old='%v', new='%v'", name, k, old, new)
 		if re.Match([]byte(name)) && old == "1" && new == "0" {
-			log.Printf("[DEBUG] Suppressing diff for name=%s k=%#v old=%#v new=%#v", name, k, old, new)
+			log.Printf("[DEBUG] Suppressing diff for name=%s k=%#v patform=%#v config=%#v", name, k, old, new)
 			return true
 		}
 		return false

docs/data-sources/current_user.md

@@ -40,8 +40,6 @@ resource "databricks_job" "this" {
   notebook_task {
     notebook_path = databricks_notebook.this.path
   }
-
-  email_notifications {}
 }
 
 output "notebook_url" {

docs/guides/workspace-management.md

@@ -67,8 +67,6 @@ resource "databricks_job" "this" {
   notebook_task {
     notebook_path = databricks_notebook.this.path
   }
-
-  email_notifications {}
 }
 
 resource "databricks_cluster" "this" {

docs/index.md

@@ -86,8 +86,6 @@ resource "databricks_job" "this" {
   notebook_task {
     notebook_path = databricks_notebook.this.path
   }
-
-  email_notifications {}
 }
 
 output "notebook_url" {

docs/resources/permissions.md

@@ -158,7 +158,6 @@ resource "databricks_service_principal" "aws_principal" {
 resource "databricks_job" "this" {
     name = "Featurization"
     max_concurrent_runs = 1
-    email_notifications {}
 
     new_cluster  {
         num_workers   = 300

pipelines/resource_pipeline.go

@@ -200,7 +200,8 @@ func adjustPipelineResourceSchema(m map[string]*schema.Schema) map[string]*schem
 	cluster, _ := m["cluster"].Elem.(*schema.Resource)
 	clustersSchema := cluster.Schema
 	clustersSchema["spark_conf"].DiffSuppressFunc = clusters.SparkConfDiffSuppressFunc
-	clustersSchema["aws_attributes"].DiffSuppressFunc = clusters.AwsAttribsDiffSuppressFunc
+	common.MustSchemaPath(clustersSchema, 
+		"aws_attributes", "zone_id").DiffSuppressFunc = clusters.ZoneDiffSuppress
 
 	awsAttributes, _ := clustersSchema["aws_attributes"].Elem.(*schema.Resource)
 	awsAttributesSchema := awsAttributes.Schema