Support placement_policy resource and database configuration (#7)

Supports creating a placement policy and adding it to a database:

```
resource "mysql_ti_placement_policy" "test" {
    name = "%s"
    primary_region = "%s"
    regions = %s
    constraints = %s
}

resource "mysql_database" "test" {
    name = "%s"
    default_character_set = "%s"
    default_collation = "%s"
    placement_policy = mysql_ti_placement_policy.test.name
}
```

---------

Co-authored-by: Andrew Chen <andrewchen@plaid.com>
Co-authored-by: Zander Hill <zander@xargs.io>

Author: 3 people

mysql/provider.go

@@ -256,6 +256,7 @@ func Provider() *schema.Provider {
 			"mysql_ti_config":         resourceTiConfigVariable(),
 			"mysql_ti_resource_group": resourceTiResourceGroup(),
 			"mysql_ti_resource_group_user_assignment": resourceTiResourceGroupUserAssignment(),
+			"mysql_ti_placement_policy":               resourceTiPlacementPolicy(),
 			"mysql_rds_config":                        resourceRDSConfig(),
 			"mysql_default_roles":                     resourceDefaultRoles(),
 		},

mysql/resource_database.go

@@ -6,6 +6,7 @@ import (
 	"errors"
 	"fmt"
 	"log"
+	"regexp"
 	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
@@ -15,8 +16,12 @@ import (
 
 const defaultCharacterSetKeyword = "CHARACTER SET "
 const defaultCollateKeyword = "COLLATE "
+const placementPolicyKeyword = "PLACEMENT POLICY="
+const placementPolicyDefault = "default"
 const unknownDatabaseErrCode = 1049
 
+var placementPolicyRegex = regexp.MustCompile(fmt.Sprintf("%s`([a-zA-Z0-9_-]+)`", placementPolicyKeyword))
+
 func resourceDatabase() *schema.Resource {
 	return &schema.Resource{
 		CreateContext: CreateDatabase,
@@ -44,6 +49,12 @@ func resourceDatabase() *schema.Resource {
 				Optional: true,
 				Default:  "utf8mb4_general_ci",
 			},
+
+			"placement_policy": {
+				Type:     schema.TypeString,
+				Optional: true,
+				Default:  "",
+			},
 		},
 	}
 }
@@ -54,7 +65,10 @@ func CreateDatabase(ctx context.Context, d *schema.ResourceData, meta interface{
 		return diag.FromErr(err)
 	}
 
-	stmtSQL := databaseConfigSQL("CREATE", d)
+	stmtSQL, err := databaseConfigSQL("CREATE", d, db)
+	if err != nil {
+		return diag.Errorf("failed constructing create SQL statement: %v", err)
+	}
 	log.Println("[DEBUG] Executing statement:", stmtSQL)
 
 	_, err = db.ExecContext(ctx, stmtSQL)
@@ -73,7 +87,10 @@ func UpdateDatabase(ctx context.Context, d *schema.ResourceData, meta interface{
 		return diag.FromErr(err)
 	}
 
-	stmtSQL := databaseConfigSQL("ALTER", d)
+	stmtSQL, err := databaseConfigSQL("ALTER", d, db)
+	if err != nil {
+		return diag.Errorf("failed constructing update SQL statement: %v", err)
+	}
 	log.Println("[DEBUG] Executing statement:", stmtSQL)
 
 	_, err = db.ExecContext(ctx, stmtSQL)
@@ -111,6 +128,12 @@ func ReadDatabase(ctx context.Context, d *schema.ResourceData, meta interface{})
 
 	defaultCharset := extractIdentAfter(createSQL, defaultCharacterSetKeyword)
 	defaultCollation := extractIdentAfter(createSQL, defaultCollateKeyword)
+	placementPolicyMatches := placementPolicyRegex.FindStringSubmatch(createSQL)
+
+	placementPolicy := ""
+	if len(placementPolicyMatches) >= 2 {
+		placementPolicy = placementPolicyMatches[1]
+	}
 
 	if defaultCollation == "" && defaultCharset != "" {
 		// MySQL doesn't return the collation if it's the default one for
@@ -145,6 +168,7 @@ func ReadDatabase(ctx context.Context, d *schema.ResourceData, meta interface{})
 	d.Set("name", name)
 	d.Set("default_character_set", defaultCharset)
 	d.Set("default_collation", defaultCollation)
+	d.Set("placement_policy", placementPolicy)
 
 	return nil
 }
@@ -168,13 +192,15 @@ func DeleteDatabase(ctx context.Context, d *schema.ResourceData, meta interface{
 	return nil
 }
 
-func databaseConfigSQL(verb string, d *schema.ResourceData) string {
+func databaseConfigSQL(verb string, d *schema.ResourceData, db *sql.DB) (string, error) {
 	name := d.Get("name").(string)
 	defaultCharset := d.Get("default_character_set").(string)
 	defaultCollation := d.Get("default_collation").(string)
+	placementPolicy := d.Get("placement_policy").(string)
 
 	var defaultCharsetClause string
 	var defaultCollationClause string
+	var placementPolicyClause string
 
 	if defaultCharset != "" {
 		defaultCharsetClause = defaultCharacterSetKeyword + quoteIdentifier(defaultCharset)
@@ -183,13 +209,29 @@ func databaseConfigSQL(verb string, d *schema.ResourceData) string {
 		defaultCollationClause = defaultCollateKeyword + quoteIdentifier(defaultCollation)
 	}
 
+	isTiDB, _, _, err := serverTiDB(db)
+	if err != nil {
+		return "", err
+	}
+
+	if isTiDB {
+		if placementPolicy != "" {
+			placementPolicyClause = placementPolicyKeyword + quoteIdentifier(placementPolicy)
+		} else {
+			placementPolicyClause = placementPolicyKeyword + quoteIdentifier(placementPolicyDefault)
+		}
+	} else if placementPolicy != "" {
+		return "", fmt.Errorf("placement_policy is only supported for TiDB")
+	}
+
 	return fmt.Sprintf(
-		"%s DATABASE %s %s %s",
+		"%s DATABASE %s %s %s %s",
 		verb,
 		quoteIdentifier(name),
 		defaultCharsetClause,
 		defaultCollationClause,
-	)
+		placementPolicyClause,
+	), nil
 }
 
 func extractIdentAfter(sql string, keyword string) string {

mysql/resource_database_test.go

@@ -51,9 +51,9 @@ func TestAccDatabase_collationChange(t *testing.T) {
 		CheckDestroy:      testAccDatabaseCheckDestroy(dbName),
 		Steps: []resource.TestStep{
 			{
-				Config: testAccDatabaseConfigFull(dbName, charset1, collation1),
+				Config: testAccDatabaseConfigFull(dbName, charset1, collation1, ""),
 				Check: resource.ComposeTestCheckFunc(
-					testAccDatabaseCheckFull("mysql_database.test", dbName, charset1, collation1),
+					testAccDatabaseCheckFull("mysql_database.test", dbName, charset1, collation1, ""),
 				),
 			},
 			{
@@ -70,20 +70,58 @@ func TestAccDatabase_collationChange(t *testing.T) {
 
 					db.Exec(fmt.Sprintf("ALTER DATABASE %s CHARACTER SET %s COLLATE %s", dbName, charset2, collation2))
 				},
-				Config: testAccDatabaseConfigFull(dbName, charset1, collation1),
+				Config: testAccDatabaseConfigFull(dbName, charset1, collation1, ""),
 				Check: resource.ComposeTestCheckFunc(
-					testAccDatabaseCheckFull(resourceName, dbName, charset1, collation1),
+					testAccDatabaseCheckFull(resourceName, dbName, charset1, collation1, ""),
+				),
+			},
+		},
+	})
+}
+
+func TestAccDatabase_placementPolicyChange(t *testing.T) {
+	dbName := "terraform_acceptance_test"
+
+	charset1 := "latin1"
+	collation1 := "latin1_bin"
+	placementPolicy1 := "test_policy"
+	placementPolicy2 := "test_policy_v2"
+	placementPolicyResourceName := "mysql_ti_placement_policy.test.name"
+
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			testAccPreCheckSkipNotTiDB(t)
+		},
+		ProviderFactories: testAccProviderFactories,
+		CheckDestroy:      testAccDatabaseCheckDestroy(dbName),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDatabaseAndPlacementPolicy(dbName, charset1, collation1, placementPolicy1, placementPolicyResourceName),
+				Check: resource.ComposeTestCheckFunc(
+					testAccDatabaseCheckFull("mysql_database.test", dbName, charset1, collation1, placementPolicy1),
+				),
+			},
+			{
+				Config: testAccDatabaseAndPlacementPolicy(dbName, charset1, collation1, placementPolicy1, ""),
+				Check: resource.ComposeTestCheckFunc(
+					testAccDatabaseCheckFull("mysql_database.test", dbName, charset1, collation1, ""),
+				),
+			},
+			{
+				Config: testAccDatabaseAndPlacementPolicy(dbName, charset1, collation1, placementPolicy2, placementPolicyResourceName),
+				Check: resource.ComposeTestCheckFunc(
+					testAccDatabaseCheckFull("mysql_database.test", dbName, charset1, collation1, placementPolicy2),
 				),
 			},
 		},
 	})
 }
 
 func testAccDatabaseCheckBasic(rn string, name string) resource.TestCheckFunc {
-	return testAccDatabaseCheckFull(rn, name, "utf8mb4", "utf8mb4_bin")
+	return testAccDatabaseCheckFull(rn, name, "utf8mb4", "utf8mb4_bin", "")
 }
 
-func testAccDatabaseCheckFull(rn string, name string, charset string, collation string) resource.TestCheckFunc {
+func testAccDatabaseCheckFull(rn string, name string, charset string, collation string, placementPolicy string) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		rs, ok := s.RootModule().Resources[rn]
 		if !ok {
@@ -123,6 +161,12 @@ func testAccDatabaseCheckFull(rn string, name string, charset string, collation
 			}
 		}
 
+		if !strings.Contains(createSQL, fmt.Sprintf("PLACEMENT POLICY=`%s`", placementPolicy)) && placementPolicy != "" {
+			return fmt.Errorf("placement policy expected %s", placementPolicy)
+		} else if strings.Contains(createSQL, "PLACEMENT POLICY=") && placementPolicy == "" {
+			return fmt.Errorf("placement policy expected to be empty")
+		}
+
 		return nil
 	}
 }
@@ -150,14 +194,28 @@ func testAccDatabaseCheckDestroy(name string) resource.TestCheckFunc {
 }
 
 func testAccDatabaseConfigBasic(name string) string {
-	return testAccDatabaseConfigFull(name, "utf8mb4", "utf8mb4_bin")
+	return testAccDatabaseConfigFull(name, "utf8mb4", "utf8mb4_bin", "")
 }
 
-func testAccDatabaseConfigFull(name string, charset string, collation string) string {
+func testAccDatabaseConfigFull(name string, charset string, collation string, placementPolicy string) string {
+	placementPolicyConfig := ""
+	if placementPolicy != "" {
+		placementPolicyConfig = fmt.Sprintf(`placement_policy = %s`, placementPolicy)
+	}
+
 	return fmt.Sprintf(`
 resource "mysql_database" "test" {
     name = "%s"
     default_character_set = "%s"
     default_collation = "%s"
-}`, name, charset, collation)
+    %s
+}`, name, charset, collation, placementPolicyConfig)
+}
+
+func testAccDatabaseAndPlacementPolicy(name string, charset string, collation string, placementPolicy string, databasePlacementPolicy string) string {
+	return fmt.Sprintf(
+		"%s\n%s",
+		testAccPlacementPolicyConfigBasic(placementPolicy),
+		testAccDatabaseConfigFull(name, charset, collation, databasePlacementPolicy),
+	)
 }