fix: Changes actions attribute to TypeSet in mongodbatlas_custom_db_role to not be sensitive to order (#3508)

* rename files

* avoids order sensitivity

* Use TypeSet checks instead of index-based checks for actions

* changelog change

* inline calls in config

Author: oarbusi

.changelog/3508.txt

@@ -0,0 +1,3 @@
+```release-note:breaking-change
+resource/mongodbatlas_custom_db_role: Changes actions attribute to not be sensitive to order
+```

internal/service/customdbrole/data_source_custom_db_role.go renamed to internal/service/customdbrole/data_source.go

@@ -51,7 +51,7 @@ func Resource() *schema.Resource {
 				),
 			},
 			"actions": {
-				Type:     schema.TypeList,
+				Type:     schema.TypeSet,
 				Optional: true,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
@@ -269,8 +269,8 @@ func resourceImport(ctx context.Context, d *schema.ResourceData, meta any) ([]*s
 }
 
 func expandActions(d *schema.ResourceData) *[]admin.DatabasePrivilegeAction {
-	actions := make([]admin.DatabasePrivilegeAction, len(d.Get("actions").([]any)))
-	for k, v := range d.Get("actions").([]any) {
+	actions := make([]admin.DatabasePrivilegeAction, len(d.Get("actions").(*schema.Set).List()))
+	for k, v := range d.Get("actions").(*schema.Set).List() {
 		a := v.(map[string]any)
 		actions[k] = admin.DatabasePrivilegeAction{
 			Action:    a["action"].(string),

internal/service/customdbrole/data_source_custom_db_roles.go renamed to internal/service/customdbrole/plural_data_source.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
 	"github.com/hashicorp/terraform-plugin-testing/knownvalue"
+	"github.com/hashicorp/terraform-plugin-testing/plancheck"
 	"github.com/hashicorp/terraform-plugin-testing/statecheck"
 	"github.com/hashicorp/terraform-plugin-testing/terraform"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/conversion"
@@ -38,6 +39,10 @@ func TestAccCustomDBRoles_Basic(t *testing.T) {
 	resource.ParallelTest(t, *basicTestCase(t))
 }
 
+func TestAccCustomDBRoles_BasicWithTwoActions(t *testing.T) {
+	resource.ParallelTest(t, *basicTestCaseWithTwoActions(t))
+}
+
 func basicTestCase(t *testing.T) *resource.TestCase {
 	t.Helper()
 	var (
@@ -84,6 +89,39 @@ func basicTestCase(t *testing.T) *resource.TestCase {
 	}
 }
 
+func basicTestCaseWithTwoActions(t *testing.T) *resource.TestCase {
+	t.Helper()
+	var (
+		projectID     = acc.ProjectIDExecution(t)
+		roleName      = acc.RandomName()
+		action1       = "INSERT"
+		action2       = "UPDATE"
+		databaseName1 = acc.RandomClusterName()
+		databaseName2 = acc.RandomClusterName()
+	)
+
+	return &resource.TestCase{
+		PreCheck:                 func() { acc.PreCheckBasic(t) },
+		ProtoV6ProviderFactories: acc.TestAccProviderV6Factories,
+		CheckDestroy:             checkDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: configBasicWithTwoActions(projectID, roleName, action1, databaseName1, action2, databaseName2),
+				Check:  checkExists(resourceName),
+			},
+			{
+				Config: configBasicWithTwoActions(projectID, roleName, action2, databaseName2, action1, databaseName1), // reverse the actions order
+				Check:  checkExists(resourceName),
+				ConfigPlanChecks: resource.ConfigPlanChecks{
+					PreApply: []plancheck.PlanCheck{
+						plancheck.ExpectEmptyPlan(),
+					},
+				},
+			},
+		},
+	}
+}
+
 func checkAttrs(projectID, roleName, action, databaseName string) resource.TestCheckFunc {
 	return acc.CheckRSAndDS(
 		resourceName,
@@ -378,16 +416,28 @@ func TestAccConfigRSCustomDBRoles_MultipleCustomRoles(t *testing.T) {
 					resource.TestCheckResourceAttrSet(InheritedRoleResourceName, "project_id"),
 					resource.TestCheckResourceAttr(InheritedRoleResourceName, "role_name", inheritRole.RoleName),
 					resource.TestCheckResourceAttr(InheritedRoleResourceName, "actions.#", cast.ToString(len(inheritRole.GetActions()))),
-					resource.TestCheckResourceAttr(InheritedRoleResourceName, "actions.0.action", inheritRole.GetActions()[0].Action),
-					resource.TestCheckResourceAttr(InheritedRoleResourceName, "actions.0.resources.#", cast.ToString(len(inheritRole.GetActions()[0].GetResources()))),
+					resource.TestCheckTypeSetElemNestedAttrs(InheritedRoleResourceName, "actions.*", map[string]string{
+						"action":      inheritRole.GetActions()[0].Action,
+						"resources.#": cast.ToString(len(inheritRole.GetActions()[0].GetResources())),
+					}),
+					resource.TestCheckTypeSetElemNestedAttrs(InheritedRoleResourceName, "actions.*", map[string]string{
+						"action":      inheritRole.GetActions()[1].Action,
+						"resources.#": cast.ToString(len(inheritRole.GetActions()[1].GetResources())),
+					}),
 
 					// For Test Role
 					checkExists(testRoleResourceName),
 					resource.TestCheckResourceAttrSet(testRoleResourceName, "project_id"),
 					resource.TestCheckResourceAttr(testRoleResourceName, "role_name", testRole.RoleName),
 					resource.TestCheckResourceAttr(testRoleResourceName, "actions.#", cast.ToString(len(testRole.GetActions()))),
-					resource.TestCheckResourceAttr(testRoleResourceName, "actions.0.action", testRole.GetActions()[0].Action),
-					resource.TestCheckResourceAttr(testRoleResourceName, "actions.0.resources.#", cast.ToString(len(testRole.GetActions()[0].GetResources()))),
+					resource.TestCheckTypeSetElemNestedAttrs(testRoleResourceName, "actions.*", map[string]string{
+						"action":      testRole.GetActions()[0].Action,
+						"resources.#": cast.ToString(len(testRole.GetActions()[0].GetResources())),
+					}),
+					resource.TestCheckTypeSetElemNestedAttrs(testRoleResourceName, "actions.*", map[string]string{
+						"action":      testRole.GetActions()[1].Action,
+						"resources.#": cast.ToString(len(testRole.GetActions()[1].GetResources())),
+					}),
 				),
 			},
 			{
@@ -399,16 +449,28 @@ func TestAccConfigRSCustomDBRoles_MultipleCustomRoles(t *testing.T) {
 					resource.TestCheckResourceAttrSet(InheritedRoleResourceName, "project_id"),
 					resource.TestCheckResourceAttr(InheritedRoleResourceName, "role_name", inheritRoleUpdated.RoleName),
 					resource.TestCheckResourceAttr(InheritedRoleResourceName, "actions.#", cast.ToString(len(inheritRoleUpdated.GetActions()))),
-					resource.TestCheckResourceAttr(InheritedRoleResourceName, "actions.0.action", inheritRoleUpdated.GetActions()[0].Action),
-					resource.TestCheckResourceAttr(InheritedRoleResourceName, "actions.0.resources.#", cast.ToString(len(inheritRoleUpdated.GetActions()[0].GetResources()))),
+					resource.TestCheckTypeSetElemNestedAttrs(InheritedRoleResourceName, "actions.*", map[string]string{
+						"action":      inheritRoleUpdated.GetActions()[0].Action,
+						"resources.#": cast.ToString(len(inheritRoleUpdated.GetActions()[0].GetResources())),
+					}),
+					resource.TestCheckTypeSetElemNestedAttrs(InheritedRoleResourceName, "actions.*", map[string]string{
+						"action":      inheritRoleUpdated.GetActions()[1].Action,
+						"resources.#": cast.ToString(len(inheritRoleUpdated.GetActions()[1].GetResources())),
+					}),
+					resource.TestCheckTypeSetElemNestedAttrs(InheritedRoleResourceName, "actions.*", map[string]string{
+						"action":      inheritRoleUpdated.GetActions()[2].Action,
+						"resources.#": cast.ToString(len(inheritRoleUpdated.GetActions()[2].GetResources())),
+					}),
 
 					// For Test Role
 					checkExists(testRoleResourceName),
 					resource.TestCheckResourceAttrSet(testRoleResourceName, "project_id"),
 					resource.TestCheckResourceAttr(testRoleResourceName, "role_name", testRoleUpdated.RoleName),
 					resource.TestCheckResourceAttr(testRoleResourceName, "actions.#", cast.ToString(len(testRoleUpdated.GetActions()))),
-					resource.TestCheckResourceAttr(testRoleResourceName, "actions.0.action", testRoleUpdated.GetActions()[0].Action),
-					resource.TestCheckResourceAttr(testRoleResourceName, "actions.0.resources.#", cast.ToString(len(testRoleUpdated.GetActions()[0].GetResources()))),
+					resource.TestCheckTypeSetElemNestedAttrs(testRoleResourceName, "actions.*", map[string]string{
+						"action":      testRoleUpdated.GetActions()[0].Action,
+						"resources.#": cast.ToString(len(testRoleUpdated.GetActions()[0].GetResources())),
+					}),
 					resource.TestCheckResourceAttr(testRoleResourceName, "inherited_roles.#", "1"),
 				),
 			},
@@ -509,8 +571,14 @@ func TestAccConfigRSCustomDBRoles_UpdatedInheritRoles(t *testing.T) {
 					resource.TestCheckResourceAttrSet(InheritedRoleResourceName, "project_id"),
 					resource.TestCheckResourceAttr(InheritedRoleResourceName, "role_name", inheritRole.RoleName),
 					resource.TestCheckResourceAttr(InheritedRoleResourceName, "actions.#", cast.ToString(len(inheritRole.GetActions()))),
-					resource.TestCheckResourceAttr(InheritedRoleResourceName, "actions.0.action", inheritRole.GetActions()[0].Action),
-					resource.TestCheckResourceAttr(InheritedRoleResourceName, "actions.0.resources.#", cast.ToString(len(inheritRole.GetActions()[0].GetResources()))),
+					resource.TestCheckTypeSetElemNestedAttrs(InheritedRoleResourceName, "actions.*", map[string]string{
+						"action":      inheritRole.GetActions()[0].Action,
+						"resources.#": cast.ToString(len(inheritRole.GetActions()[0].GetResources())),
+					}),
+					resource.TestCheckTypeSetElemNestedAttrs(InheritedRoleResourceName, "actions.*", map[string]string{
+						"action":      inheritRole.GetActions()[1].Action,
+						"resources.#": cast.ToString(len(inheritRole.GetActions()[1].GetResources())),
+					}),
 
 					// For Test Role
 					checkExists(testRoleResourceName),
@@ -529,8 +597,18 @@ func TestAccConfigRSCustomDBRoles_UpdatedInheritRoles(t *testing.T) {
 					resource.TestCheckResourceAttrSet(InheritedRoleResourceName, "project_id"),
 					resource.TestCheckResourceAttr(InheritedRoleResourceName, "role_name", inheritRoleUpdated.RoleName),
 					resource.TestCheckResourceAttr(InheritedRoleResourceName, "actions.#", cast.ToString(len(inheritRoleUpdated.GetActions()))),
-					resource.TestCheckResourceAttr(InheritedRoleResourceName, "actions.0.action", inheritRoleUpdated.GetActions()[0].Action),
-					resource.TestCheckResourceAttr(InheritedRoleResourceName, "actions.0.resources.#", cast.ToString(len(inheritRoleUpdated.GetActions()[0].GetResources()))),
+					resource.TestCheckTypeSetElemNestedAttrs(InheritedRoleResourceName, "actions.*", map[string]string{
+						"action":      inheritRoleUpdated.GetActions()[0].Action,
+						"resources.#": cast.ToString(len(inheritRoleUpdated.GetActions()[0].GetResources())),
+					}),
+					resource.TestCheckTypeSetElemNestedAttrs(InheritedRoleResourceName, "actions.*", map[string]string{
+						"action":      inheritRoleUpdated.GetActions()[1].Action,
+						"resources.#": cast.ToString(len(inheritRoleUpdated.GetActions()[1].GetResources())),
+					}),
+					resource.TestCheckTypeSetElemNestedAttrs(InheritedRoleResourceName, "actions.*", map[string]string{
+						"action":      inheritRoleUpdated.GetActions()[2].Action,
+						"resources.#": cast.ToString(len(inheritRoleUpdated.GetActions()[2].GetResources())),
+					}),
 
 					// For Test Role
 					checkExists(testRoleResourceName),
@@ -603,6 +681,30 @@ func configBasic(projectID, roleName, action, databaseName string) string {
 	`, projectID, roleName, action, databaseName)
 }
 
+func generateActionConfig(action, databaseName string) string {
+	return fmt.Sprintf(`
+		actions {
+			action = %q
+			resources {
+				collection_name = ""
+				database_name   = %q
+			}
+		}
+	`, action, databaseName)
+}
+
+func configBasicWithTwoActions(projectID, roleName, action1, databaseName1, action2, databaseName2 string) string {
+	return fmt.Sprintf(`
+		resource "mongodbatlas_custom_db_role" "test" {
+			project_id = %[1]q
+			role_name  = %[2]q
+
+			%[3]s
+			%[4]s
+		}
+	`, projectID, roleName, generateActionConfig(action1, databaseName1), generateActionConfig(action2, databaseName2))
+}
+
 func configWithInheritedRoles(orgID, projectName string, inheritedRole []admin.UserCustomDBRole, testRole *admin.UserCustomDBRole) string {
 	return fmt.Sprintf(`