feat: Adds support for new `description` field in `mongodbatlas_resource_policy` resource & data sources #3214

maastha · 2025-03-26T11:47:26Z

Description

Adds support for new description field in mongodbatlas_resource_policy resource & data sources

Link to any related issue(s): CLOUDP-295768

Type of change:

Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
This change requires a documentation update
Documentation fix/enhancement

Required Checklist:

I have signed the MongoDB CLA
I have read the contributing guides
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
I have added any necessary documentation (if appropriate)
I have run make fmt and formatted my code
If changes include deprecations or removals I have added appropriate changelog entries.
If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

maastha · 2025-03-26T15:01:13Z

Fixing the examples check

github-actions · 2025-03-26T15:01:38Z

APIx bot: a message has been sent to Docs Slack channel

oarbusi · 2025-03-26T15:16:32Z

internal/service/resourcepolicy/resource.go

+	if editAdmin.Description == nil {
+		editAdmin.Description = conversion.Pointer("")


why is this needed?

what behavior do we want to have if description is not in the config, setting to empty o keeping the description? (for example in case they change description in the UI, or it's an imported resource with a description but it's not in specified in the config)

it will be null by default. This particular change is added as it is an optional attribute, so if user wants to "unset" the value/remove it from the config then we send an empty string to the API to do that in the PATCH.

sorry not clear, first sentence and code seem contradictory, and also same question as Oriol, when it's not in the config we want to set it to empty, or leave what it is?
do we need that this code?:

if editAdmin.Description == nil { editAdmin.Description = conversion.Pointer("")

let makes sure to capture the API and intended terraform behaviour in a code comment

I have simplified the implementation & added a comment, lmk if it makes the behavior clearer to understand.

when it's not in the config we want to set it to empty, or leave what it is?

@lantoli when it's not in the config we want it to be null, since it is optional. The question is during an update, how do we tell the API to reset it to null in the PATCH request? If we do editAdmin.Description = nil then it will never be included in the request due to` json:"description,omitempty"``. To address this, we set it to an empty string which the API interprets as nil.

that's fine, thanks

JuliaMongo

LGTM, with a few comments. I will also ask @erabil-mdb to review since she documented Atlas resource policies.

.changelog/3214.txt

docs/data-sources/resource_policies.md

docs/data-sources/resource_policy.md

docs/resources/resource_policy.md

lantoli · 2025-03-26T15:45:04Z

internal/service/resourcepolicy/resource_test.go

 }

-func configWithPolicyBodies(orgID, policyName string, bodies ...string) string {
+func configWithPolicyBodies(orgID, policyName string, description *string, bodies ...string) string {


nit: you can pass description as a string instead of pointer and use it if != ""

lantoli · 2025-03-26T15:46:35Z

internal/service/resourcepolicy/resource_test.go

@@ -203,7 +213,7 @@ data "mongodbatlas_resource_policy" "test" {
 data "mongodbatlas_resource_policies" "test" {
 	org_id = mongodbatlas_resource_policy.test.org_id
 }
-	`, orgID, policyName, policies)
+	`, orgID, policyName, descriptionStr, policies)


we don't need a check for the resource as it's optional but would be useful for the data sources as the field will be computed there

internal/service/resourcepolicy/resource.go

EspenAlbert

Only nit comments

AgustinBettati

LGTM, lets just clarify the removal aspect

AgustinBettati · 2025-03-27T09:10:29Z

internal/service/resourcepolicy/resource.go

+	if editAdmin.Description == nil {
+		editAdmin.Description = conversion.Pointer("")


let makes sure to capture the API and intended terraform behaviour in a code comment

init

bc5f879

github-actions bot added the enhancement label Mar 26, 2025

maastha added 5 commits March 26, 2025 11:49

changelog

e265633

minor

1ea8403

add example to docs

4701e88

Merge branch 'master' into CLOUDP-295768-rp-description

81ca99b

mig test

0ce7bcc

maastha changed the title ~~feat: Adds support for new Description field in mongodbatlas_resource_policy resource & data sources~~ feat: Adds support for new description field in mongodbatlas_resource_policy resource & data sources Mar 26, 2025

min

1d99653

maastha marked this pull request as ready for review March 26, 2025 15:01

maastha requested review from a team as code owners March 26, 2025 15:01

oarbusi reviewed Mar 26, 2025

View reviewed changes

JuliaMongo approved these changes Mar 26, 2025

View reviewed changes

lantoli reviewed Mar 26, 2025

View reviewed changes

lantoli approved these changes Mar 26, 2025

View reviewed changes

EspenAlbert reviewed Mar 26, 2025

View reviewed changes

internal/service/resourcepolicy/resource.go Outdated Show resolved Hide resolved

EspenAlbert approved these changes Mar 26, 2025

View reviewed changes

AgustinBettati reviewed Mar 27, 2025

View reviewed changes

maastha added 8 commits March 27, 2025 14:27

Pr comments

6dabe00

doc updates

86f6f9a

min

9e3c62b

Merge branch 'master' into CLOUDP-295768-rp-description

c8ad121

example

9476c09

Merge branch 'master' into CLOUDP-295768-rp-description

19342a1

format

0213fee

ds test

f8c9100

maastha added 2 commits March 31, 2025 12:42

ut

39ee63d

lint

1322c13

maastha merged commit 149c5c0 into master Mar 31, 2025
40 checks passed

maastha deleted the CLOUDP-295768-rp-description branch March 31, 2025 14:03

svc-apix-Bot added a commit that referenced this pull request Mar 31, 2025

chore: Updates CHANGELOG.md for #3214

ca9e34a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Adds support for new `description` field in `mongodbatlas_resource_policy` resource & data sources #3214

feat: Adds support for new `description` field in `mongodbatlas_resource_policy` resource & data sources #3214

maastha commented Mar 26, 2025 •

edited

Loading

maastha commented Mar 26, 2025

github-actions bot commented Mar 26, 2025

oarbusi Mar 26, 2025

lantoli Mar 26, 2025

maastha Mar 26, 2025

lantoli Mar 26, 2025 •

edited

Loading

AgustinBettati Mar 27, 2025

maastha Mar 27, 2025

maastha Mar 27, 2025 •

edited

Loading

lantoli Mar 31, 2025

JuliaMongo left a comment

lantoli Mar 26, 2025 •

edited

Loading

lantoli Mar 26, 2025 •

edited

Loading

maastha Mar 31, 2025

EspenAlbert left a comment

AgustinBettati left a comment

AgustinBettati Mar 27, 2025

		if editAdmin.Description == nil {
		editAdmin.Description = conversion.Pointer("")

feat: Adds support for new description field in mongodbatlas_resource_policy resource & data sources #3214

feat: Adds support for new description field in mongodbatlas_resource_policy resource & data sources #3214

Conversation

maastha commented Mar 26, 2025 • edited Loading

Description

Type of change:

Required Checklist:

Further comments

maastha commented Mar 26, 2025

github-actions bot commented Mar 26, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lantoli Mar 26, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maastha Mar 27, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JuliaMongo left a comment

Choose a reason for hiding this comment

lantoli Mar 26, 2025 • edited Loading

Choose a reason for hiding this comment

lantoli Mar 26, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

EspenAlbert left a comment

Choose a reason for hiding this comment

AgustinBettati left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat: Adds support for new `description` field in `mongodbatlas_resource_policy` resource & data sources #3214

feat: Adds support for new `description` field in `mongodbatlas_resource_policy` resource & data sources #3214

maastha commented Mar 26, 2025 •

edited

Loading

lantoli Mar 26, 2025 •

edited

Loading

maastha Mar 27, 2025 •

edited

Loading

lantoli Mar 26, 2025 •

edited

Loading

lantoli Mar 26, 2025 •

edited

Loading