resource_sql_database_instance.go normalizes failover_dr_replica_name name for diff (#13579) (#22319)

[upstream:2321dedaa0d38225ba429fa252c673a614c2c036]

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

Author: modular-magician

.changelog/13579.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+sql: fixed the issue of shortened version of failover_dr_replica_name causes unnecessary diff 
+```

google/services/sql/resource_sql_database_instance.go

@@ -935,9 +935,10 @@ is set to true. Defaults to ZONAL.`,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"failover_dr_replica_name": {
-							Type:        schema.TypeString,
-							Optional:    true,
-							Description: fmt.Sprintf(`If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. The standard format of this field is "your-project:your-instance". You can also set this field to "your-instance", but cloud SQL backend will convert it to the aforementioned standard format.`),
+							Type:             schema.TypeString,
+							Optional:         true,
+							Description:      fmt.Sprintf(`If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. The standard format of this field is "your-project:your-instance". You can also set this field to "your-instance", but cloud SQL backend will convert it to the aforementioned standard format.`),
+							DiffSuppressFunc: areDRReplicaNamesEqual,
 						},
 						"dr_replica": {
 							Type:        schema.TypeBool,
@@ -2787,3 +2788,21 @@ func validatePromoteConfigurations(masterInstanceName cty.Value, replicaConfigur
 	}
 	return nil
 }
+
+// areDRReplicaNamesEqual compares 2 DR replica names.
+func areDRReplicaNamesEqual(_, oldValue, newValue string, d *schema.ResourceData) bool {
+	project := d.Get("project").(string)
+	// When we can't find project, just fallback to naive comparison.
+	if project == "" {
+		return oldValue == newValue
+	}
+	return normalizeDRReplicaName(oldValue, project) == normalizeDRReplicaName(newValue, project)
+}
+
+// normalizeDRReplicaName normalizes DR replica name by prefixing project name when it's missing.
+func normalizeDRReplicaName(drReplicaName, project string) string {
+	if strings.Contains(drReplicaName, ":") {
+		return drReplicaName
+	}
+	return fmt.Sprintf("%s:%s", project, drReplicaName)
+}

google/services/sql/resource_sql_database_instance_test.go

@@ -2618,14 +2618,16 @@ func TestAccSqlDatabaseInstance_MysqlSwitchoverSuccess(t *testing.T) {
 				ImportStateVerifyIgnore: ignoredReplicaConfigurationFields,
 			},
 			// Let's make sure that setting and unsetting failover replica works.
+			// Make sure we test both normalized and shortened version of DR replica
+			// names.
 			{
-				Config: googleSqlDatabaseInstance_mysqlSetFailoverReplica(project, primaryName, replicaName),
+				Config: googleSqlDatabaseInstance_mysqlSetFailoverReplica(project, primaryName, replicaName, false /* =useNormalizedDrReplicaName */),
 			},
 			{
 				Config: googleSqlDatabaseInstance_mysqlUnsetFailoverReplica(project, primaryName, replicaName),
 			},
 			{
-				Config: googleSqlDatabaseInstance_mysqlSetFailoverReplica(project, primaryName, replicaName),
+				Config: googleSqlDatabaseInstance_mysqlSetFailoverReplica(project, primaryName, replicaName, true /* =useNormalizedDrReplicaName */),
 			},
 			{
 				// Split into two configs because current TestStep implementation checks diff before refreshing.
@@ -2694,14 +2696,16 @@ func TestAccSqlDatabaseInstance_PostgresSwitchoverSuccess(t *testing.T) {
 				ImportStateVerifyIgnore: ignoredReplicaConfigurationFields,
 			},
 			// Let's make sure that setting and unsetting failover replica works.
+			// Make sure we test both normalized and shortened version of DR replica
+			// names.
 			{
-				Config: googleSqlDatabaseInstance_postgresSetFailoverReplica(project, primaryName, replicaName),
+				Config: googleSqlDatabaseInstance_postgresSetFailoverReplica(project, primaryName, replicaName, false /* =useNormalizedDrReplicaName */),
 			},
 			{
 				Config: googleSqlDatabaseInstance_postgresUnsetFailoverReplica(project, primaryName, replicaName),
 			},
 			{
-				Config: googleSqlDatabaseInstance_postgresSetFailoverReplica(project, primaryName, replicaName),
+				Config: googleSqlDatabaseInstance_postgresSetFailoverReplica(project, primaryName, replicaName, true /* =useNormalizedDrReplicaName */),
 			},
 			{
 				// Split into two configs because current TestStep implementation checks diff before refreshing.
@@ -3781,7 +3785,12 @@ resource "google_sql_database_instance" "original-replica" {
 `, project, primaryName, project, replicaName)
 }
 
-func googleSqlDatabaseInstance_mysqlSetFailoverReplica(project, primaryName, replicaName string) string {
+func googleSqlDatabaseInstance_mysqlSetFailoverReplica(project, primaryName, replicaName string, useNormalizedDrReplicaName bool) string {
+	drReplicaName := fmt.Sprintf("%s:%s", project, replicaName)
+	if !useNormalizedDrReplicaName {
+		drReplicaName = replicaName
+	}
+
 	return fmt.Sprintf(`
 resource "google_sql_database_instance" "original-primary" {
   project             = "%s"
@@ -3792,7 +3801,7 @@ resource "google_sql_database_instance" "original-primary" {
   deletion_protection = false
 
   replication_cluster {
-    failover_dr_replica_name = "%s:%s"
+    failover_dr_replica_name = "%s"
   }
 
   settings {
@@ -3819,7 +3828,7 @@ resource "google_sql_database_instance" "original-replica" {
     edition           = "ENTERPRISE_PLUS"
   }
 }
-`, project, primaryName, project, replicaName, project, replicaName, primaryName)
+`, project, primaryName, drReplicaName, project, replicaName, primaryName)
 }
 
 func googleSqlDatabaseInstance_mysqlUnsetFailoverReplica(project, primaryName, replicaName string) string {
@@ -4055,7 +4064,11 @@ resource "google_sql_database_instance" "original-replica" {
 `, project, primaryName, project, replicaName)
 }
 
-func googleSqlDatabaseInstance_postgresSetFailoverReplica(project, primaryName, replicaName string) string {
+func googleSqlDatabaseInstance_postgresSetFailoverReplica(project, primaryName, replicaName string, useNormalizedDrReplicaName bool) string {
+	drReplicaName := fmt.Sprintf("%s:%s", project, replicaName)
+	if !useNormalizedDrReplicaName {
+		drReplicaName = replicaName
+	}
 	return fmt.Sprintf(`
 resource "google_sql_database_instance" "original-primary" {
   project             = "%s"
@@ -4066,7 +4079,7 @@ resource "google_sql_database_instance" "original-primary" {
   deletion_protection = false
 
   replication_cluster {
-    failover_dr_replica_name = "%s:%s"
+    failover_dr_replica_name = "%s"
   }
 
   settings {
@@ -4093,7 +4106,7 @@ resource "google_sql_database_instance" "original-replica" {
     edition           = "ENTERPRISE_PLUS"
   }
 }
-`, project, primaryName, project, replicaName, project, replicaName, primaryName)
+`, project, primaryName, drReplicaName, project, replicaName, primaryName)
 }
 
 func googleSqlDatabaseInstance_postgresUnsetFailoverReplica(project, primaryName, replicaName string) string {