fix: Adds new attribute results and deprecates resource_policies for mongodbatlas_resource_policies data source (#2740)

* new attribute results and deprecate resource_policies

* changelog entry

* change test to check new attribute

* fix changelog

* changelog fix

* fix docs

* Update .changelog/2740.txt

Co-authored-by: Leo Antoli <[email protected]>

* migration test

* skip mig test until next version

* fix comment

---------

Co-authored-by: Leo Antoli <[email protected]>

Author: oarbusi

.changelog/2740.txt

@@ -0,0 +1,7 @@
+```release-note:enhancement
+data-source/mongodbatlas_resource_policies: Adds `results` attribute
+```
+
+```release-note:note
+data-source/mongodbatlas_resource_policies: Deprecates `resource_policies` attribute
+```

docs/data-sources/resource_policies.md

@@ -84,7 +84,7 @@ data "mongodbatlas_resource_policies" "this" {
 
 
 output "policy_ids" {
-  value = { for policy in data.mongodbatlas_resource_policies.this.resource_policies : policy.name => policy.id }
+  value = { for policy in data.mongodbatlas_resource_policies.this.results : policy.name => policy.id }
 }
 ```
 
@@ -97,7 +97,8 @@ output "policy_ids" {
 
 ### Read-Only
 
-- `resource_policies` (Attributes List) (see [below for nested schema](#nestedatt--resource_policies))
+- `resource_policies` (Attributes List, Deprecated) (see [below for nested schema](#nestedatt--resource_policies))
+- `results` (Attributes List) (see [below for nested schema](#nestedatt--results))
 
 <a id="nestedatt--resource_policies"></a>
 ### Nested Schema for `resource_policies`
@@ -140,3 +141,46 @@ Read-Only:
 - `body` (String) A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.
 - `id` (String) Unique 24-hexadecimal character string that identifies the policy.
 
+
+
+<a id="nestedatt--results"></a>
+### Nested Schema for `results`
+
+Read-Only:
+
+- `created_by_user` (Attributes) The user that last updated the Atlas resource policy. (see [below for nested schema](#nestedatt--results--created_by_user))
+- `created_date` (String) Date and time in UTC when the Atlas resource policy was created.
+- `id` (String) Unique 24-hexadecimal digit string that identifies an Atlas resource policy.
+- `last_updated_by_user` (Attributes) The user that last updated the Atlas resource policy. (see [below for nested schema](#nestedatt--results--last_updated_by_user))
+- `last_updated_date` (String) Date and time in UTC when the Atlas resource policy was last updated.
+- `name` (String) Human-readable label that describes the Atlas resource policy.
+- `org_id` (String) Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+- `policies` (Attributes List) List of policies that make up the Atlas resource policy. (see [below for nested schema](#nestedatt--results--policies))
+- `version` (String) A string that identifies the version of the Atlas resource policy.
+
+<a id="nestedatt--results--created_by_user"></a>
+### Nested Schema for `results.created_by_user`
+
+Read-Only:
+
+- `id` (String) Unique 24-hexadecimal character string that identifies a user.
+- `name` (String) Human-readable label that describes a user.
+
+
+<a id="nestedatt--results--last_updated_by_user"></a>
+### Nested Schema for `results.last_updated_by_user`
+
+Read-Only:
+
+- `id` (String) Unique 24-hexadecimal character string that identifies a user.
+- `name` (String) Human-readable label that describes a user.
+
+
+<a id="nestedatt--results--policies"></a>
+### Nested Schema for `results.policies`
+
+Read-Only:
+
+- `body` (String) A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.
+- `id` (String) Unique 24-hexadecimal character string that identifies the policy.
+

docs/data-sources/resource_policy.md

@@ -84,7 +84,7 @@ data "mongodbatlas_resource_policies" "this" {
 
 
 output "policy_ids" {
-  value = { for policy in data.mongodbatlas_resource_policies.this.resource_policies : policy.name => policy.id }
+  value = { for policy in data.mongodbatlas_resource_policies.this.results : policy.name => policy.id }
 }
 ```
 

docs/resources/resource_policy.md

@@ -86,7 +86,7 @@ data "mongodbatlas_resource_policies" "this" {
 
 
 output "policy_ids" {
-  value = { for policy in data.mongodbatlas_resource_policies.this.resource_policies : policy.name => policy.id }
+  value = { for policy in data.mongodbatlas_resource_policies.this.results : policy.name => policy.id }
 }
 ```
 

examples/mongodbatlas_resource_policy/main.tf

@@ -74,5 +74,5 @@ data "mongodbatlas_resource_policies" "this" {
 
 
 output "policy_ids" {
-  value = { for policy in data.mongodbatlas_resource_policies.this.resource_policies : policy.name => policy.id }
+  value = { for policy in data.mongodbatlas_resource_policies.this.results : policy.name => policy.id }
 }

internal/service/resourcepolicy/model.go

@@ -82,6 +82,7 @@ func NewTFModelDSP(ctx context.Context, orgID string, input []admin.ApiAtlasReso
 	}
 	return &TFModelDSP{
 		ResourcePolicies: tfModels,
+		Results:          tfModels,
 		OrgID:            types.StringValue(orgID),
 	}, *diags
 }

internal/service/resourcepolicy/plural_data_source_schema.go

@@ -2,8 +2,10 @@ package resourcepolicy
 
 import (
 	"context"
+	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/constant"
 
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 )
@@ -18,6 +20,13 @@ func DataSourcePluralSchema(ctx context.Context) schema.Schema {
 				MarkdownDescription: "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.",
 			},
 			"resource_policies": schema.ListNestedAttribute{
+				DeprecationMessage: fmt.Sprintf(constant.DeprecationParamWithReplacement, "`results`"),
+				NestedObject: schema.NestedAttributeObject{
+					Attributes: dsAttributes,
+				},
+				Computed: true,
+			},
+			"results": schema.ListNestedAttribute{
 				NestedObject: schema.NestedAttributeObject{
 					Attributes: dsAttributes,
 				},
@@ -30,4 +39,5 @@ func DataSourcePluralSchema(ctx context.Context) schema.Schema {
 type TFModelDSP struct {
 	OrgID            types.String `tfsdk:"org_id"`
 	ResourcePolicies []TFModel    `tfsdk:"resource_policies"`
+	Results          []TFModel    `tfsdk:"results"`
 }

internal/service/resourcepolicy/resource_migration_test.go

@@ -7,6 +7,6 @@ import (
 )
 
 func TestMigResourcePolicy_basic(t *testing.T) {
-	mig.SkipIfVersionBelow(t, "1.21.0") // this feature was introduced in provider version 1.21.0
+	mig.SkipIfVersionBelow(t, "1.22.0") // this feature was introduced in provider version 1.21.0, plural data source schema was changed in 1.22.0
 	mig.CreateAndRunTestNonParallel(t, basicTestCase(t))
 }

internal/service/resourcepolicy/resource_test.go

@@ -158,15 +158,15 @@ func checksResourcePolicy(orgID, name string, policyCount int) resource.TestChec
 		"version",
 	}
 	pluralMap := map[string]string{
-		"org_id":              orgID,
-		"resource_policies.#": "1",
+		"org_id":    orgID,
+		"results.#": "1",
 	}
 	checks := []resource.TestCheckFunc{checkExists()}
 	checks = acc.AddAttrChecks(dataSourcePluralID, checks, pluralMap)
 	for i := 0; i < policyCount; i++ {
 		checks = acc.AddAttrSetChecks(resourceID, checks, fmt.Sprintf("policies.%d.body", i), fmt.Sprintf("policies.%d.id", i))
 		checks = acc.AddAttrSetChecks(dataSourceID, checks, fmt.Sprintf("policies.%d.body", i), fmt.Sprintf("policies.%d.id", i))
-		checks = acc.AddAttrSetChecks(dataSourcePluralID, checks, fmt.Sprintf("resource_policies.0.policies.%d.body", i), fmt.Sprintf("resource_policies.0.policies.%d.id", i))
+		checks = acc.AddAttrSetChecks(dataSourcePluralID, checks, fmt.Sprintf("results.0.policies.%d.body", i), fmt.Sprintf("results.0.policies.%d.id", i))
 	}
 	// cannot use dataSourcePluralID as it doesn't have the `results` attribute
 	return acc.CheckRSAndDS(resourceID, &dataSourceID, nil, attrSet, attrMap, resource.ComposeAggregateTestCheckFunc(checks...))