Fix permadiff when edition field is added to configuration of a google_sql_database_instance resource (#9198) (#16215)

* Suppress diff on `google_sql_database_instance`'s `edition` field when state contains `""` and config contains `"ENTERPRISE"`

* Remove `DiffSuppressFunc`, add flattener and expander to handle conversion of `""` to `"ENTERPRISE"`

* Remove duplicate import

* Set default value of `edition` to `"ENTERPRISE"`

* Remove expander, add state upgrader

* Add acceptance test step that provisions an instance without `edition` set

* Update tests to assert the value in state matches the edition used, including when edition is not set in config

* Remove state upgrader
[upstream:241a15cb0ed6ae99c3290825051f168deda648fd]

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

Author: modular-magician

.changelog/9198.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+sql: Fixed a bug where adding the `edition` field to a `google_sql_database_instance` resource that already existed and used ENTERPRISE edition resulted in a permant diff in plans
+```

google/services/sql/resource_sql_database_instance.go

@@ -7,6 +7,7 @@ import (
 	"errors"
 	"fmt"
 	"log"
+	"reflect"
 	"strings"
 	"time"
 
@@ -177,6 +178,7 @@ func ResourceSqlDatabaseInstance() *schema.Resource {
 						"edition": {
 							Type:         schema.TypeString,
 							Optional:     true,
+							Default:      "ENTERPRISE",
 							ValidateFunc: validation.StringInSlice([]string{"ENTERPRISE", "ENTERPRISE_PLUS"}, false),
 							Description:  `The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.`,
 						},
@@ -2003,7 +2005,7 @@ func flattenSettings(settings *sqladmin.Settings) []map[string]interface{} {
 	data := map[string]interface{}{
 		"version":                     settings.SettingsVersion,
 		"tier":                        settings.Tier,
-		"edition":                     settings.Edition,
+		"edition":                     flattenEdition(settings.Edition),
 		"activation_policy":           settings.ActivationPolicy,
 		"availability_type":           settings.AvailabilityType,
 		"collation":                   settings.Collation,
@@ -2331,6 +2333,14 @@ func flattenPasswordValidationPolicy(passwordValidationPolicy *sqladmin.Password
 	return []map[string]interface{}{data}
 }
 
+func flattenEdition(v interface{}) string {
+	if v == nil || tpgresource.IsEmptyValue(reflect.ValueOf(v)) {
+		return "ENTERPRISE"
+	}
+
+	return v.(string)
+}
+
 func instanceMutexKey(project, instance_name string) string {
 	return fmt.Sprintf("google-sql-database-instance-%s-%s", project, instance_name)
 }

google/services/sql/resource_sql_database_instance_test.go

@@ -1520,22 +1520,43 @@ func TestAccSqlDatabaseInstance_Edition(t *testing.T) {
 	enterprisePlusTier := "db-perf-optimized-N-2"
 	enterpriseName := "tf-test-enterprise-" + acctest.RandString(t, 10)
 	enterpriseTier := "db-custom-2-13312"
+	noEditionName := "tf-test-enterprise-noedition-" + acctest.RandString(t, 10)
 	acctest.VcrTest(t, resource.TestCase{
 		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
 		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
 		CheckDestroy:             testAccSqlDatabaseInstanceDestroyProducer(t),
 		Steps: []resource.TestStep{
+			{
+				Config: testGoogleSqlDatabaseInstance_EditionConfig_noEdition(noEditionName, enterpriseTier),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr("google_sql_database_instance.instance", "settings.0.edition", "ENTERPRISE"),
+				),
+			},
+			{
+				ResourceName:            "google_sql_database_instance.instance",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"deletion_protection"},
+			},
+			// Delete and recreate (ForceNew) triggered by passing in a new `name` value
 			{
 				Config: testGoogleSqlDatabaseInstance_EditionConfig(enterprisePlusName, enterprisePlusTier, "ENTERPRISE_PLUS"),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr("google_sql_database_instance.instance", "settings.0.edition", "ENTERPRISE_PLUS"),
+				),
 			},
 			{
 				ResourceName:            "google_sql_database_instance.instance",
 				ImportState:             true,
 				ImportStateVerify:       true,
 				ImportStateVerifyIgnore: []string{"deletion_protection"},
 			},
+			// Delete and recreate (ForceNew) triggered by passing in a new `name` value
 			{
 				Config: testGoogleSqlDatabaseInstance_EditionConfig(enterpriseName, enterpriseTier, "ENTERPRISE"),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr("google_sql_database_instance.instance", "settings.0.edition", "ENTERPRISE"),
+				),
 			},
 			{
 				ResourceName:            "google_sql_database_instance.instance",
@@ -2241,6 +2262,20 @@ resource "google_sql_database_instance" "instance" {
 }`, databaseName, endDate, startDate, time)
 }
 
+func testGoogleSqlDatabaseInstance_EditionConfig_noEdition(databaseName, tier string) string {
+	return fmt.Sprintf(`
+
+resource "google_sql_database_instance" "instance" {
+  name             = "%s"
+  region           = "us-east1"
+  database_version    = "POSTGRES_14"
+  deletion_protection = false
+  settings {
+    tier = "%s"
+  }
+}`, databaseName, tier)
+}
+
 func testGoogleSqlDatabaseInstance_EditionConfig(databaseName, tier, edition string) string {
 	return fmt.Sprintf(`