PLAT-7481 Support Terraform Provider region_id to provider and name m… (#63)

* PLAT-7481 Support Terraform Provider region_id to provider and name migration

* Fail on migration to deprecated region_id

* Fix state check

Author: oyeliseiev-ua

docs/resources/workspace_group.md

@@ -19,14 +19,15 @@ provider "singlestoredb" {
   // You can generate this key from the SingleStore Portal at https://portal.singlestore.com/organizations/org-id/api-keys.
 }
 
-data "singlestoredb_regions" "all" {}
+data "singlestoredb_regions_v2" "all" {}
 
 resource "singlestoredb_workspace_group" "this" {
   name            = "group"
   firewall_ranges = ["0.0.0.0/0"] // Ensure restrictive ranges for production environments.
   expires_at      = "2222-01-01T00:00:00Z"
-  region_id       = data.singlestoredb_regions.all.regions.0.id // Prefer specifying the explicit region ID in production environments as the list of regions may vary.
-  admin_password  = "initialSfkjDIJ423d44w1sfooBar1$"
+  cloud_provider  = data.singlestoredb_regions_v2.all.regions.0.provider
+  region_name     = data.singlestoredb_regions_v2.all.regions.0.region_name
+  admin_password  = "mockPassword193!"
 }
 ```
 

examples/resources/singlestoredb_workspace_group/resource.tf

@@ -4,12 +4,13 @@ provider "singlestoredb" {
   // You can generate this key from the SingleStore Portal at https://portal.singlestore.com/organizations/org-id/api-keys.
 }
 
-data "singlestoredb_regions" "all" {}
+data "singlestoredb_regions_v2" "all" {}
 
 resource "singlestoredb_workspace_group" "this" {
   name            = "group"
   firewall_ranges = ["0.0.0.0/0"] // Ensure restrictive ranges for production environments.
   expires_at      = "2222-01-01T00:00:00Z"
-  region_id       = data.singlestoredb_regions.all.regions.0.id // Prefer specifying the explicit region ID in production environments as the list of regions may vary.
-  admin_password  = "initialSfkjDIJ423d44w1sfooBar1$"
+  cloud_provider  = data.singlestoredb_regions_v2.all.regions.0.provider
+  region_name     = data.singlestoredb_regions_v2.all.regions.0.region_name
+  admin_password  = "mockPassword193!"
 }

examples/resources/singlestoredb_workspace_group_advanced/resource.tf

@@ -10,7 +10,7 @@ resource "singlestoredb_workspace_group" "this" {
   expires_at                  = "2222-01-01T00:00:00Z"
   region_name                 = "us-west-2"
   cloud_provider              = "AWS"
-  admin_password              = "initialSfkjDIJ423d44w1sfooBar1$"
+  admin_password              = "mockPassword193!"
   deployment_type             = "NON-PRODUCTION"
   opt_in_preview_feature      = true
   high_availability_two_zones = true

internal/provider/config/const.go

@@ -57,7 +57,7 @@ const (
 	// TestInitialWorkspaceGroupExpiresAt is the initial workspace group expiration in examples.
 	TestInitialWorkspaceGroupExpiresAt = "2222-01-01T00:00:00Z"
 	// TestInitialAdminPassword is the initial workspace admin password in examples.
-	TestInitialAdminPassword = "initialSfkjDIJ423d44w1sfooBar1$" //nolint:gosec
+	TestInitialAdminPassword = "mockPassword193!"
 	// TestInitialFirewallRange is the firewall range in the example.
 	TestInitialFirewallRange = "0.0.0.0/0"
 	// TestFirewallRangeAllTraffic is the firewall range in the example for allowing all traffic.

internal/provider/workspacegroups/resource.go

@@ -158,7 +158,7 @@ func (r *workspaceGroupResource) Create(ctx context.Context, req resource.Create
 		return
 	}
 
-	if err := validateCreateRegionParameters(plan); err != nil {
+	if err := validateRequiredRegionParameters(&plan); err != nil {
 		resp.Diagnostics.AddError(err.Summary, err.Detail)
 
 		return
@@ -217,7 +217,7 @@ func (r *workspaceGroupResource) Create(ctx context.Context, req resource.Create
 	resp.Diagnostics.Append(diags...)
 }
 
-func validateCreateRegionParameters(plan workspaceGroupResourceModel) *util.SummaryWithDetailError {
+func validateRequiredRegionParameters(plan *workspaceGroupResourceModel) *util.SummaryWithDetailError {
 	providerAndRegionNameAreSet := !plan.CloudProvider.IsNull() && !plan.CloudProvider.IsUnknown() && !plan.RegionName.IsNull() && !plan.RegionName.IsUnknown()
 	regionIDIsSet := !plan.RegionID.IsNull() && !plan.RegionID.IsUnknown()
 
@@ -388,7 +388,7 @@ func (r *workspaceGroupResource) ModifyPlan(ctx context.Context, req resource.Mo
 		return
 	}
 
-	if err := validateModifyPlanRegionParameters(plan, state); err != nil {
+	if err := validateModifyPlanRegionParameters(ctx, r, plan, state); err != nil {
 		resp.Diagnostics.AddError(err.Summary, err.Detail)
 
 		return
@@ -418,25 +418,74 @@ func (r *workspaceGroupResource) ModifyPlan(ctx context.Context, req resource.Mo
 	}
 }
 
-func validateModifyPlanRegionParameters(plan, state *workspaceGroupResourceModel) *util.SummaryWithDetailError {
-	if !plan.RegionID.Equal(state.RegionID) {
+func validateModifyPlanRegionParameters(ctx context.Context, r *workspaceGroupResource, plan, state *workspaceGroupResourceModel) *util.SummaryWithDetailError {
+	if err := validateRequiredRegionParameters(plan); err != nil {
+		return err
+	}
+
+	if err := handleRegionMigrationState(ctx, r, plan, state); err != nil {
+		return err
+	}
+
+	if err := validateModifyRegionID(plan, state); err != nil {
+		return err
+	}
+
+	if err := validateModifyRegionNameAndProvider(plan, state); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func handleRegionMigrationState(ctx context.Context, r *workspaceGroupResource, plan, state *workspaceGroupResourceModel) *util.SummaryWithDetailError {
+	shouldMigrateToRegionNameAndProvider := !state.RegionID.IsNull() && plan.RegionID.IsNull()
+	shouldMigrateToDepricatedRegionID := !state.RegionName.IsNull() && plan.RegionName.IsNull() && !state.CloudProvider.IsNull() && plan.CloudProvider.IsNull()
+
+	if shouldMigrateToDepricatedRegionID {
+		return &util.SummaryWithDetailError{
+			Summary: "Cannot change cloud_provider and region_name to the deprecated region_id.",
+			Detail:  "Changing cloud_provider and region_name to the deprecated region_id is not permitted. Use the cloud_provider and region_name parameters instead.",
+		}
+	}
+
+	if shouldMigrateToRegionNameAndProvider {
+		workspaceGroup, err := r.GetV1WorkspaceGroupsWorkspaceGroupIDWithResponse(ctx,
+			uuid.MustParse(state.ID.ValueString()),
+			&management.GetV1WorkspaceGroupsWorkspaceGroupIDParams{},
+		)
+		if serr := util.StatusOK(workspaceGroup, err); serr != nil {
+			return serr
+		}
+		state.CloudProvider = types.StringValue(string(workspaceGroup.JSON200.Provider))
+		state.RegionName = types.StringValue(workspaceGroup.JSON200.RegionName)
+	}
+
+	return nil
+}
+
+func validateModifyRegionID(plan, state *workspaceGroupResourceModel) *util.SummaryWithDetailError {
+	if !plan.RegionID.IsNull() && !state.RegionID.IsNull() && !plan.RegionID.Equal(state.RegionID) {
 		return &util.SummaryWithDetailError{
 			Summary: "Cannot update workspace group region_id",
-			Detail:  "To prevent accidental deletion of the workspace group and loss of data, updating the region_id is not permitted. Please explicitly delete the workspace group before changing its region_id.",
+			Detail:  "Updating the region_id is not permitted. Warning: this field is deprecated. Use cloud_provider and region_name instead.",
 		}
 	}
 
+	return nil
+}
+
+func validateModifyRegionNameAndProvider(plan, state *workspaceGroupResourceModel) *util.SummaryWithDetailError {
 	if !plan.RegionName.Equal(state.RegionName) {
 		return &util.SummaryWithDetailError{
 			Summary: "Cannot update workspace group region_name",
-			Detail:  "To prevent accidental deletion of the workspace group and loss of data, updating the region_name is not permitted. Please explicitly delete the workspace group before changing its region_name.",
+			Detail:  fmt.Sprintf("Updating the region_name is not permitted. Expected value is '%s', but now is '%s'.", state.RegionName.ValueString(), plan.RegionName.ValueString()),
 		}
 	}
-
 	if !plan.CloudProvider.Equal(state.CloudProvider) {
 		return &util.SummaryWithDetailError{
 			Summary: "Cannot update workspace group cloud_provider",
-			Detail:  "To prevent accidental deletion of the workspace group and loss of data, updating the cloud_provider is not permitted. Please explicitly delete the workspace group before changing its cloud_provider.",
+			Detail:  fmt.Sprintf("Updating the cloud_provider is not permitted. Expected value is '%s'.", state.CloudProvider.ValueString()),
 		}
 	}
 

internal/provider/workspacegroups/resource_test.go

@@ -23,17 +23,17 @@ import (
 
 var (
 	updatedWorkspaceGroupName = strings.Join([]string{"updated", config.TestInitialWorkspaceGroupName}, "-")
-	updatedAdminPassword      = "buzDzBd4qAR12c9$" //nolint:gosec
+	updatedAdminPassword      = "mockPasswordUpdated193!"
 	defaultDeploymentType     = management.WorkspaceGroupDeploymentTypePRODUCTION
 	updatedDeploymentType     = management.WorkspaceGroupDeploymentTypeNONPRODUCTION
 )
 
 func TestCRUDWorkspaceGroup(t *testing.T) {
-	regions := []management.Region{
+	regionsv2 := []management.RegionV2{
 		{
-			RegionID: uuid.MustParse("2ca3d358-021d-45ed-86cb-38b8d14ac507"),
-			Region:   "GS - US West 2 (Oregon) - aws-oregon-gs1",
-			Provider: management.RegionProviderAWS,
+			Region:     "GS - US West 2 (Oregon) - aws-oregon-gs1",
+			Provider:   management.RegionV2ProviderAWS,
+			RegionName: "aws-oregon-gs1",
 		},
 	}
 
@@ -44,7 +44,8 @@ func TestCRUDWorkspaceGroup(t *testing.T) {
 		ExpiresAt:         util.Ptr(config.TestInitialWorkspaceGroupExpiresAt),
 		FirewallRanges:    util.Ptr([]string{config.TestInitialFirewallRange}),
 		Name:              config.TestInitialWorkspaceGroupName,
-		RegionID:          regions[0].RegionID,
+		RegionName:        regionsv2[0].RegionName,
+		Provider:          management.WorkspaceGroupProviderAWS,
 		State:             management.WorkspaceGroupStatePENDING, // During the first poll, the status will still be PENDING.
 		TerminatedAt:      nil,
 		UpdateWindow:      nil,
@@ -55,13 +56,13 @@ func TestCRUDWorkspaceGroup(t *testing.T) {
 
 	updatedExpiresAt := time.Now().UTC().Add(time.Hour * 2).Format(time.RFC3339)
 
-	regionsHandler := func(w http.ResponseWriter, r *http.Request) bool {
-		if r.URL.Path != "/v1/regions" || r.Method != http.MethodGet {
+	regionsv2Handler := func(w http.ResponseWriter, r *http.Request) bool {
+		if r.URL.Path != "/v2/regions" || r.Method != http.MethodGet {
 			return false
 		}
 
 		w.Header().Add("Content-Type", "json")
-		_, err := w.Write(testutil.MustJSON(regions))
+		_, err := w.Write(testutil.MustJSON(regionsv2))
 		require.NoError(t, err)
 
 		return true
@@ -103,7 +104,7 @@ func TestCRUDWorkspaceGroup(t *testing.T) {
 		require.Equal(t, config.TestInitialWorkspaceGroupExpiresAt, util.Deref(input.ExpiresAt))
 		require.Equal(t, []string{config.TestInitialFirewallRange}, input.FirewallRanges)
 		require.Equal(t, config.TestInitialWorkspaceGroupName, input.Name)
-		require.Equal(t, regions[0].RegionID, *input.RegionID)
+		require.Equal(t, regionsv2[0].RegionName, *input.RegionName)
 
 		w.Header().Add("Content-Type", "json")
 		_, err = w.Write(testutil.MustJSON(
@@ -173,7 +174,7 @@ func TestCRUDWorkspaceGroup(t *testing.T) {
 	}
 
 	readOnlyHandlers := []func(w http.ResponseWriter, r *http.Request) bool{
-		regionsHandler,
+		regionsv2Handler,
 		workspaceGroupsGetHandler,
 	}
 
@@ -213,7 +214,8 @@ func TestCRUDWorkspaceGroup(t *testing.T) {
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "name", config.TestInitialWorkspaceGroupName),
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "created_at", workspaceGroup.CreatedAt),
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "expires_at", *workspaceGroup.ExpiresAt),
-					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "region_id", regions[0].RegionID.String()),
+					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "cloud_provider", string(management.RegionProviderAWS)),
+					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "region_name", workspaceGroup.RegionName),
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "admin_password", config.TestInitialAdminPassword),
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "firewall_ranges.#", "1"),
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "firewall_ranges.0", config.TestInitialFirewallRange),
@@ -228,13 +230,16 @@ func TestCRUDWorkspaceGroup(t *testing.T) {
 					WithWorkspaceGroupResource("this")("expires_at", cty.StringVal(updatedExpiresAt)).
 					WithWorkspaceGroupResource("this")("firewall_ranges", cty.ListValEmpty(cty.String)).
 					WithWorkspaceGroupResource("this")("deployment_type", cty.StringVal(string(updatedDeploymentType))).
+					WithWorkspaceGroupResource("this")("cloud_provider", cty.StringVal(string(management.RegionProviderAWS))).
+					WithWorkspaceGroupResource("this")("region_name", cty.StringVal(workspaceGroup.RegionName)).
 					String(),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", config.IDAttribute, workspaceGroupID.String()),
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "name", updatedWorkspaceGroupName),
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "created_at", workspaceGroup.CreatedAt),
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "expires_at", updatedExpiresAt),
-					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "region_id", regions[0].RegionID.String()),
+					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "cloud_provider", string(management.RegionProviderAWS)),
+					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "region_name", workspaceGroup.RegionName),
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "admin_password", updatedAdminPassword),
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "firewall_ranges.#", "0"),
 					resource.TestCheckResourceAttr("singlestoredb_workspace_group.this", "deployment_type", string(updatedDeploymentType)),