fix: Avoid error when removing read only spec in region config that does not define electable specs #3162

AgustinBettati · 2025-03-12T17:29:30Z

Description

Link to any related issue(s): CLOUDP-306136, also follow ups on test made in CLOUDP-305352.

A change is made to the plan modifier so that if a region does not have an electable spec, if a read only spec is removed its values are still taken from the state. Complete details and example in CLOUDP-306136.

Additional test changes present in PR:

Adding explicit steps to verify empty plan after removal of blocks
Adding scenario of removing block in region config that does not have electable_specs defined.

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

…cks are removed

…le is not defined

AgustinBettati · 2025-03-13T09:15:39Z

.changelog/3162.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+resource/mongodbatlas_advanced_cluster (preview provider 2.0.0): Avoid error when removing `read_only_specs` in `region_configs` that does not define `electable_specs` 


using mongodbatlas_advanced_cluster (preview provider 2.0.0) in the changelog

AgustinBettati · 2025-03-13T09:18:24Z

internal/service/advancedcluster/resource_advanced_cluster_test.go

@@ -1375,23 +1388,25 @@ func TestAccMockableAdvancedCluster_shardedAddAnalyticsAndAutoScaling(t *testing
 	})
 }

-func TestAccMockableAdvancedCluster_removeBlocksFromConfig(t *testing.T) {
+func TestAccAdvancedCluster_removeBlocksFromConfig(t *testing.T) {


refactored removeBlocksFromConfig from a Mockable to regular test.
Main motivation was that execution of this test is long (+40min) and getting a successful local execution for updating golden files is a challenge. @lantoli I know you recently added this test, let me know if you see a concern with this.

github-actions · 2025-03-13T09:20:10Z

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

EspenAlbert · 2025-03-13T11:49:03Z

internal/testutil/mig/test_step.go

-			},
-		},
-	}
+	testStep := acc.TestStepCheckEmptyPlan(config)


Nice. Refactor, like it better than what I did in #3105

lmkerbey-mdb

LGTM.

internal/service/advancedclustertpf/plan_modifier.go

lantoli

LGTM

…e and disk_size_gb values with state after ignore block is removed

…ze for triggering a change

…tance_size for triggering a change" This reverts commit 9709558.

…ral replication spec

… config

AgustinBettati · 2025-03-14T13:16:14Z

Added additional changes to handle scenario that appeared in one of the tests:
If a region config

does not have electable specs
its read only spec is removed
instance size is modified in another region config from the same replication spec

The read only spec that was removed will have the new updated value of the instance size defined in the associated region_config electable spec. ff33457 and 7870b3c specifically capture this fix.

Verifying successful tests in

.changelog/3162.txt

internal/service/advancedclustertpf/plan_modifier.go

AgustinBettati added 3 commits March 12, 2025 15:30

add additional step for ensuring empty plans are encountered when blo…

6826179

…cks are removed

adjust test step check making it different from one for migration tests

7d9e609

add logic for copying values from state for read only spec if electab…

61232c9

…le is not defined

github-actions bot added the bug label Mar 12, 2025

AgustinBettati added 2 commits March 12, 2025 23:18

refactor removeBlocksFromConfig into regular acceptance test

096a23a

adding changelog

d8c94ef

AgustinBettati commented Mar 13, 2025

View reviewed changes

AgustinBettati marked this pull request as ready for review March 13, 2025 09:19

AgustinBettati requested review from a team as code owners March 13, 2025 09:19

EspenAlbert reviewed Mar 13, 2025

View reviewed changes

EspenAlbert approved these changes Mar 13, 2025

View reviewed changes

marcosuma approved these changes Mar 13, 2025

View reviewed changes

lmkerbey-mdb approved these changes Mar 13, 2025

View reviewed changes

lantoli reviewed Mar 13, 2025

View reviewed changes

internal/service/advancedclustertpf/plan_modifier.go Outdated Show resolved Hide resolved

lantoli approved these changes Mar 13, 2025

View reviewed changes

AgustinBettati added 6 commits March 13, 2025 17:20

fix replicationSpecsAutoScaling avoiding misalignment of instance_siz…

86f5706

…e and disk_size_gb values with state after ignore block is removed

fix removeBlocksFromConfig by using node_count instead of instance_si…

9709558

…ze for triggering a change

fix for handling change of instance size in separate region config

ff33457

Revert "fix removeBlocksFromConfig by using node_count instead of ins…

f8ba8ca

…tance_size for triggering a change" This reverts commit 9709558.

favour electable specs of same region config over one defined in gene…

7870b3c

…ral replication spec

adjust check to consider change in read only spec of different region…

d857fff

… config

lantoli reviewed Mar 14, 2025

View reviewed changes

.changelog/3162.txt Outdated Show resolved Hide resolved

lantoli approved these changes Mar 14, 2025

View reviewed changes

maastha reviewed Mar 14, 2025

View reviewed changes

internal/service/advancedclustertpf/plan_modifier.go Outdated Show resolved Hide resolved

maastha approved these changes Mar 14, 2025

View reviewed changes

maastha reviewed Mar 14, 2025

View reviewed changes

internal/service/advancedclustertpf/plan_modifier.go Show resolved Hide resolved

adding additional docs clarification comments

152afb5

AgustinBettati merged commit 9c6c432 into master Mar 14, 2025
38 of 39 checks passed

AgustinBettati deleted the CLOUDP-306136 branch March 14, 2025 16:20

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

chore: Updates CHANGELOG.md for #3162

0fa40a0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Avoid error when removing read only spec in region config that does not define electable specs #3162

fix: Avoid error when removing read only spec in region config that does not define electable specs #3162

AgustinBettati commented Mar 12, 2025 •

edited

Loading

AgustinBettati Mar 13, 2025

AgustinBettati Mar 13, 2025

github-actions bot commented Mar 13, 2025

EspenAlbert Mar 13, 2025

lmkerbey-mdb left a comment

lantoli left a comment

AgustinBettati commented Mar 14, 2025 •

edited

Loading

		@@ -0,0 +1,3 @@
		```release-note:bug
		resource/mongodbatlas_advanced_cluster (preview provider 2.0.0): Avoid error when removing `read_only_specs` in `region_configs` that does not define `electable_specs`

fix: Avoid error when removing read only spec in region config that does not define electable specs #3162

fix: Avoid error when removing read only spec in region config that does not define electable specs #3162

Conversation

AgustinBettati commented Mar 12, 2025 • edited Loading

Description

Type of change:

Required Checklist:

Further comments

AgustinBettati Mar 13, 2025

Choose a reason for hiding this comment

AgustinBettati Mar 13, 2025

Choose a reason for hiding this comment

github-actions bot commented Mar 13, 2025

EspenAlbert Mar 13, 2025

Choose a reason for hiding this comment

lmkerbey-mdb left a comment

Choose a reason for hiding this comment

lantoli left a comment

Choose a reason for hiding this comment

AgustinBettati commented Mar 14, 2025 • edited Loading

AgustinBettati commented Mar 12, 2025 •

edited

Loading

AgustinBettati commented Mar 14, 2025 •

edited

Loading