Add a diffSupressFunc() for template_gcs_path. (#13207) (#9564)

[upstream:c7fe3e3d0dae74979e5f9a10e620e89a53b9ba4e]

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

.changelog/13207.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+dataflow: fixed a permadiff on `template_gcs_path` in `google_dataflow_job` resource
+```

google-beta/services/dataflow/resource_dataflow_job.go

@@ -6,6 +6,7 @@ import (
 	"context"
 	"fmt"
 	"log"
+	"regexp"
 	"strings"
 	"time"
 
@@ -53,6 +54,34 @@ func resourceDataflowJobLabelDiffSuppress(k, old, new string, d *schema.Resource
 	return false
 }
 
+// ResourceDataflowJobTemplateGcsPathDiffSuppress suppresses diffs on the template_gcs_path field
+// when the only diff is the region name in the bucket.
+// `old` is the value set by service and `new` is what is stored in the config. When using a public
+// template bucket, it will be automatically turned to use a regional bucket path. In this case,
+// we want to supress the diff.
+// Example:
+//   - old: gs://template-bucket-us-central1/path/to/file.txt
+//   - new: gs://template-bucket/path/to/file.txt
+func ResourceDataflowJobTemplateGcsPathDiffSuppress(k, old, new string, d *schema.ResourceData) bool {
+	if old == new {
+		return true
+	}
+
+	return isRegionSuffixedPathMatch(old, new)
+}
+
+func isRegionSuffixedPathMatch(old, new string) bool {
+	re := regexp.MustCompile(`gs://([a-z0-9\-]+)-[a-z0-9]+-[a-z0-9]+(/.*)?`)
+	matches := re.FindStringSubmatch(old)
+
+	if len(matches) == 3 && matches[2] != "" {
+		modifiedOld := "gs://" + matches[1] + matches[2]
+		return modifiedOld == new
+	}
+
+	return false
+}
+
 func ResourceDataflowJob() *schema.Resource {
 	return &schema.Resource{
 		Create: resourceDataflowJobCreate,
@@ -87,9 +116,10 @@ func ResourceDataflowJob() *schema.Resource {
 			},
 
 			"template_gcs_path": {
-				Type:        schema.TypeString,
-				Required:    true,
-				Description: `The Google Cloud Storage path to the Dataflow job template.`,
+				Type:             schema.TypeString,
+				Required:         true,
+				DiffSuppressFunc: ResourceDataflowJobTemplateGcsPathDiffSuppress,
+				Description:      `The Google Cloud Storage path to the Dataflow job template.`,
 			},
 
 			"temp_gcs_location": {
@@ -264,13 +294,20 @@ func resourceDataflowJobTypeCustomizeDiff(_ context.Context, d *schema.ResourceD
 			}
 
 			if field != "terraform_labels" && d.HasChange(field) {
+				if field == "template_gcs_path" {
+					old, new := d.GetChange("template_gcs_path")
+
+					if isRegionSuffixedPathMatch(old.(string), new.(string)) {
+						continue
+					}
+				}
+
 				if err := d.ForceNew(field); err != nil {
 					return err
 				}
 			}
 		}
 	}
-
 	return nil
 }
 

google-beta/services/dataflow/resource_dataflow_job_test.go

@@ -11,6 +11,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
 	"github.com/hashicorp/terraform-plugin-testing/terraform"
 	"github.com/hashicorp/terraform-provider-google-beta/google-beta/services/dataflow"
@@ -23,7 +24,7 @@ import (
 )
 
 const (
-	testDataflowJobTemplateWordCountUrl = "gs://dataflow-templates-us-central1/latest/Word_Count"
+	testDataflowJobTemplateWordCountUrl = "gs://dataflow-templates/latest/Word_Count"
 	testDataflowJobSampleFileUrl        = "gs://dataflow-samples/shakespeare/various.txt"
 	testDataflowJobTemplateTextToPubsub = "gs://dataflow-templates-us-central1/latest/Stream_GCS_Text_to_Cloud_PubSub"
 	testDataflowJobRegion               = "us-central1"
@@ -1369,3 +1370,39 @@ resource "google_dataflow_job" "pubsub_stream" {
 }
   `, suffix, suffix, suffix, testDataflowJobTemplateTextToPubsub, onDelete)
 }
+
+func TestResourceDataflowJobTemplateGcsPathDiffSuppress(t *testing.T) {
+	cases := map[string]struct {
+		Old, New           string
+		ExpectDiffSuppress bool
+	}{
+		"same bucket": {
+			Old:                "gs://template-bucket/path/to/file",
+			New:                "gs://template-bucket/path/to/file",
+			ExpectDiffSuppress: true,
+		},
+		"different bucket": {
+			Old:                "gs://template-bucket-foo/path/to/file1",
+			New:                "gs://template-bucket/path/to/file1",
+			ExpectDiffSuppress: false,
+		},
+		"different object": {
+			Old:                "gs://template-bucket-foo/path/to/file2",
+			New:                "gs://template-bucket/path/to/file",
+			ExpectDiffSuppress: false,
+		},
+		"regional bucket name change is okay": {
+			Old:                "gs://template-bucket-us-central1/path/to/file1",
+			New:                "gs://template-bucket/path/to/file1",
+			ExpectDiffSuppress: true,
+		},
+	}
+	rd := schema.TestResourceDataRaw(t, dataflow.ResourceDataflowJob().Schema, nil)
+	rd.Set("region", "us-central1")
+
+	for tn, tc := range cases {
+		if dataflow.ResourceDataflowJobTemplateGcsPathDiffSuppress("template_gcs_path", tc.Old, tc.New, rd) != tc.ExpectDiffSuppress {
+			t.Errorf("bad: %s, '%s' => '%s' expect DiffSuppress to return %t", tn, tc.Old, tc.New, tc.ExpectDiffSuppress)
+		}
+	}
+}