INTMDB-932: remove the default value of retain_backups_enabled (#1314)

Author: andreaangiolillo

mongodbatlas/resource_mongodbatlas_advanced_cluster.go

@@ -72,7 +72,6 @@ func resourceMongoDBAtlasAdvancedCluster() *schema.Resource {
 			"retain_backups_enabled": {
 				Type:        schema.TypeBool,
 				Optional:    true,
-				Default:     false,
 				Description: "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster",
 			},
 			"bi_connector": {
@@ -787,13 +786,11 @@ func resourceMongoDBAtlasAdvancedClusterDelete(ctx context.Context, d *schema.Re
 	projectID := ids["project_id"]
 	clusterName := ids["cluster_name"]
 
-	retainBackup := pointy.Bool(false)
-	if v, ok := d.Get("retain_backups_enabled").(bool); ok {
-		retainBackup = pointy.Bool(v)
-	}
-
-	options := &matlas.DeleteAdvanceClusterOptions{
-		RetainBackups: retainBackup,
+	var options *matlas.DeleteAdvanceClusterOptions
+	if v, ok := d.GetOkExists("retain_backups_enabled"); ok {
+		options = &matlas.DeleteAdvanceClusterOptions{
+			RetainBackups: pointy.Bool(v.(bool)),
+		}
 	}
 
 	_, err := conn.AdvancedClusters.Delete(ctx, projectID, clusterName, options)
@@ -842,10 +839,6 @@ func resourceMongoDBAtlasAdvancedClusterImportState(ctx context.Context, d *sche
 		log.Printf(errorClusterAdvancedSetting, "name", u.ID, err)
 	}
 
-	if err := d.Set("retain_backups_enabled", false); err != nil {
-		return nil, fmt.Errorf(errorClusterAdvancedSetting, "retain_backups_enabled", u.ID, err)
-	}
-
 	d.SetId(encodeStateID(map[string]string{
 		"cluster_id":   u.ID,
 		"project_id":   *projectID,

mongodbatlas/resource_mongodbatlas_advanced_cluster_test.go

@@ -98,6 +98,7 @@ func TestAccClusterAdvancedCluster_singleProvider(t *testing.T) {
 					testAccCheckMongoDBAtlasAdvancedClusterAttributes(&cluster, rName),
 					resource.TestCheckResourceAttrSet(resourceName, "project_id"),
 					resource.TestCheckResourceAttr(resourceName, "name", rName),
+					resource.TestCheckResourceAttr(resourceName, "retain_backups_enabled", "true"),
 					resource.TestCheckResourceAttrSet(resourceName, "replication_specs.#"),
 					resource.TestCheckResourceAttrSet(resourceName, "replication_specs.0.region_configs.#"),
 				),
@@ -109,6 +110,7 @@ func TestAccClusterAdvancedCluster_singleProvider(t *testing.T) {
 					testAccCheckMongoDBAtlasAdvancedClusterAttributes(&cluster, rName),
 					resource.TestCheckResourceAttrSet(resourceName, "project_id"),
 					resource.TestCheckResourceAttr(resourceName, "name", rName),
+					resource.TestCheckResourceAttr(resourceName, "retain_backups_enabled", "false"),
 					resource.TestCheckResourceAttrSet(resourceName, "replication_specs.#"),
 					resource.TestCheckResourceAttrSet(resourceName, "replication_specs.0.region_configs.#"),
 				),
@@ -118,7 +120,7 @@ func TestAccClusterAdvancedCluster_singleProvider(t *testing.T) {
 				ImportStateIdFunc:       testAccCheckMongoDBAtlasClusterImportStateIDFunc(resourceName),
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"replication_specs"},
+				ImportStateVerifyIgnore: []string{"replication_specs", "retain_backups_enabled"},
 			},
 		},
 	})
@@ -148,6 +150,7 @@ func TestAccClusterAdvancedCluster_multicloud(t *testing.T) {
 					testAccCheckMongoDBAtlasAdvancedClusterAttributes(&cluster, rName),
 					resource.TestCheckResourceAttrSet(resourceName, "project_id"),
 					resource.TestCheckResourceAttr(resourceName, "name", rName),
+					resource.TestCheckResourceAttr(resourceName, "retain_backups_enabled", "false"),
 					resource.TestCheckResourceAttrSet(resourceName, "replication_specs.#"),
 					resource.TestCheckResourceAttrSet(resourceName, "replication_specs.0.region_configs.#"),
 					resource.TestCheckResourceAttrSet(dataSourceClustersName, "results.#"),
@@ -163,6 +166,7 @@ func TestAccClusterAdvancedCluster_multicloud(t *testing.T) {
 					testAccCheckMongoDBAtlasAdvancedClusterAttributes(&cluster, rNameUpdated),
 					resource.TestCheckResourceAttrSet(resourceName, "project_id"),
 					resource.TestCheckResourceAttr(resourceName, "name", rNameUpdated),
+					resource.TestCheckResourceAttr(resourceName, "retain_backups_enabled", "false"),
 					resource.TestCheckResourceAttrSet(resourceName, "replication_specs.#"),
 					resource.TestCheckResourceAttrSet(resourceName, "replication_specs.0.region_configs.#"),
 					resource.TestCheckResourceAttrSet(dataSourceClustersName, "results.#"),
@@ -176,7 +180,7 @@ func TestAccClusterAdvancedCluster_multicloud(t *testing.T) {
 				ImportStateIdFunc:       testAccCheckMongoDBAtlasClusterImportStateIDFunc(resourceName),
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"replication_specs"},
+				ImportStateVerifyIgnore: []string{"replication_specs", "retain_backups_enabled"},
 			},
 		},
 	})
@@ -660,7 +664,6 @@ resource "mongodbatlas_advanced_cluster" "test" {
   project_id   = mongodbatlas_project.cluster_project.id
   name         = %[3]q
   cluster_type = "REPLICASET"
-  retain_backups_enabled = "false"
 
   replication_specs {
     region_configs {
@@ -696,7 +699,7 @@ resource "mongodbatlas_advanced_cluster" "test" {
   project_id   = mongodbatlas_project.cluster_project.id
   name         = %[3]q
   cluster_type = "REPLICASET"
-  retain_backups_enabled = "false"
+  retain_backups_enabled = "true"
 
   replication_specs {
     region_configs {
@@ -732,6 +735,7 @@ resource "mongodbatlas_advanced_cluster" "test" {
   project_id   = mongodbatlas_project.cluster_project.id
   name         = %[3]q
   cluster_type = "REPLICASET"
+  retain_backups_enabled = false
 
   replication_specs {
     region_configs {

mongodbatlas/resource_mongodbatlas_cluster.go

@@ -85,7 +85,6 @@ func resourceMongoDBAtlasCluster() *schema.Resource {
 			"retain_backups_enabled": {
 				Type:        schema.TypeBool,
 				Optional:    true,
-				Default:     false,
 				Description: "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster",
 			},
 			"bi_connector": {
@@ -1022,16 +1021,14 @@ func resourceMongoDBAtlasClusterDelete(ctx context.Context, d *schema.ResourceDa
 	projectID := ids["project_id"]
 	clusterName := ids["cluster_name"]
 
-	retainBackup := pointy.Bool(false)
-	if v, ok := d.Get("retain_backups_enabled").(bool); ok {
-		retainBackup = pointy.Bool(v)
+	var options *matlas.DeleteAdvanceClusterOptions
+	if v, ok := d.GetOkExists("retain_backups_enabled"); ok {
+		options = &matlas.DeleteAdvanceClusterOptions{
+			RetainBackups: pointy.Bool(v.(bool)),
+		}
 	}
 
-	options := &matlas.DeleteAdvanceClusterOptions{
-		RetainBackups: retainBackup,
-	}
 	_, err := conn.Clusters.Delete(ctx, projectID, clusterName, options)
-
 	if err != nil {
 		return diag.FromErr(fmt.Errorf(errorClusterDelete, clusterName, err))
 	}
@@ -1081,10 +1078,6 @@ func resourceMongoDBAtlasClusterImportState(ctx context.Context, d *schema.Resou
 		return nil, fmt.Errorf("couldn't import cluster backup configuration %s in project %s, error: %s", *name, *projectID, err)
 	}
 
-	if err := d.Set("retain_backups_enabled", false); err != nil {
-		return nil, fmt.Errorf("couldn't import cluster backup configuration %s in project %s, error: %s", *name, *projectID, err)
-	}
-
 	d.SetId(encodeStateID(map[string]string{
 		"cluster_id":    u.ID,
 		"project_id":    *projectID,

mongodbatlas/resource_mongodbatlas_cluster_test.go

@@ -42,6 +42,7 @@ func TestAccClusterRSCluster_basicAWS_simple(t *testing.T) {
 					resource.TestCheckResourceAttrSet(resourceName, "replication_specs.#"),
 					resource.TestCheckResourceAttrSet(resourceName, "replication_specs.0.regions_config.#"),
 					resource.TestCheckResourceAttr(resourceName, "pit_enabled", "true"),
+					resource.TestCheckResourceAttr(resourceName, "retain_backups_enabled", "true"),
 					resource.TestCheckResourceAttr(resourceName, "version_release_system", "LTS"),
 				),
 			},
@@ -57,6 +58,7 @@ func TestAccClusterRSCluster_basicAWS_simple(t *testing.T) {
 					resource.TestCheckResourceAttrSet(resourceName, "mongo_uri"),
 					resource.TestCheckResourceAttrSet(resourceName, "replication_specs.#"),
 					resource.TestCheckResourceAttrSet(resourceName, "replication_specs.0.regions_config.#"),
+					resource.TestCheckResourceAttr(resourceName, "retain_backups_enabled", "true"),
 					resource.TestCheckResourceAttr(resourceName, "version_release_system", "LTS"),
 				),
 			},
@@ -948,7 +950,7 @@ func TestAccClusterRSCluster_importBasic(t *testing.T) {
 		resourceName = "mongodbatlas_cluster.test"
 		orgID        = os.Getenv("MONGODB_ATLAS_ORG_ID")
 		projectName  = acctest.RandomWithPrefix("test-acc")
-		clusterName  = fmt.Sprintf("test-acc-%s", acctest.RandString(10))
+		clusterName  = acctest.RandomWithPrefix("test-acc")
 	)
 
 	resource.ParallelTest(t, resource.TestCase{
@@ -964,7 +966,7 @@ func TestAccClusterRSCluster_importBasic(t *testing.T) {
 				ImportStateIdFunc:       testAccCheckMongoDBAtlasClusterImportStateIDFunc(resourceName),
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"cloud_backup", "provider_backup_enabled"},
+				ImportStateVerifyIgnore: []string{"cloud_backup", "provider_backup_enabled", "retain_backups_enabled"},
 			},
 		},
 	})
@@ -976,7 +978,7 @@ func TestAccClusterRSCluster_tenant(t *testing.T) {
 		resourceName = "mongodbatlas_cluster.tenant"
 		orgID        = os.Getenv("MONGODB_ATLAS_ORG_ID")
 		projectName  = acctest.RandomWithPrefix("test-acc")
-		name         = fmt.Sprintf("test-acc-%s", acctest.RandString(10))
+		name         = acctest.RandomWithPrefix("test-acc")
 	)
 
 	dbMajorVersion := testAccGetMongoDBAtlasMajorVersion()
@@ -1374,7 +1376,7 @@ func testAccMongoDBAtlasClusterConfigAWS(orgID, projectName, name string, backup
 		    }
 			cloud_backup                 = %[4]t
 			pit_enabled                  = %[4]t
-			retain_backups_enabled       = false
+			retain_backups_enabled       = true
 			auto_scaling_disk_gb_enabled = %[5]t
 			// Provider Settings "block"
 

website/docs/r/advanced_cluster.html.markdown

@@ -372,7 +372,7 @@ Refer to the following for full privatelink endpoint connection string examples:
 
 This parameter defaults to false.
 
-* `retain_backups_enabled` - (Optional) Set to true to retain backup snapshots for the deleted cluster. This parameter defaults to false.
+* `retain_backups_enabled` - (Optional) Set to true to retain backup snapshots for the deleted cluster. M10 and above only.
 
 **NOTE** Prior version of provider had parameter as `bi_connector` state will migrate it to new value you only need to update parameter in your terraform file
 

website/docs/r/cluster.html.markdown

@@ -324,7 +324,7 @@ But in order to explicitly change `provider_instance_size_name` comment the `lif
     ```
     * The default value is false.  M10 and above only.
 
-* `retain_backups_enabled` - (Optional) Set to true to retain backup snapshots for the deleted cluster. The default value is false. M10 and above only.
+* `retain_backups_enabled` - (Optional) Set to true to retain backup snapshots for the deleted cluster. M10 and above only. 
 * `bi_connector` - (Optional) Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See [BI Connector](#bi-connector) below for more details. **DEPRECATED** Use `bi_connector_config` instead.
 * `bi_connector_config` - (Optional) Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See [BI Connector](#bi-connector) below for more details.
 * `cluster_type` - (Required) Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.