fix: Changes on_demand_policy_item attribute from required to optional for mongodbatlas_backup_compliance_policy (#3119)

* test: Reproduces failure in GH issue (`on_demand_policy_item` is required)

* fix: Uses `optional` instead of `required` for `on_demand_policy_item` in `mongodbatlas_backup_compliance_policy`

* doc: Adds a reference for `on_demand_policy_item`

* chore: Add changelog entry

* test: Add check for retention_value in on_demand_policy_item in backup compliance policy tests and remove commented code from config

* doc: Add scheduled policy frequency types to backup compliance policy documentation

Author: EspenAlbert

.changelog/3119.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+resource/mongodbatlas_backup_compliance_policy: Changes `on_demand_policy_item` attribute from `required` to `optional`
+```

docs/data-sources/backup_compliance_policy.md

@@ -144,6 +144,12 @@ In addition to all arguments above, the following attributes are exported:
 *  `state` - Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
 * `updated_date` - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
 * `updated_user` - Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
+* `on_demand_policy_item` - Specifications for [on-demand policy](#on-demand-policy-item).
+* `policy_item_hourly` - Scheduled policy using an hourly frequency type, see [block fields](#policy-item-hourly).
+* `policy_item_daily` - Scheduled policy using a daily frequency type, see [block fields](#policy-item-daily).
+* `policy_item_weekly` - Scheduled policy using a weekly frequency type, see [block fields](#policy-item-weekly).
+* `policy_item_monthly` - Scheduled policy using a monthly frequency type, see [block fields](#policy-item-monthly).
+* `policy_item_yearly` - Scheduled policy using a yearly frequency type, see [block fields](#policy-item-yearly).
 
 ### On Demand Policy Item
 * `id` - Unique identifier of the backup policy item.

docs/resources/backup_compliance_policy.md

@@ -163,6 +163,12 @@ resource "mongodbatlas_backup_compliance_policy" "backup_policy" {
 * `pit_enabled` - Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
 * `encryption_at_rest_enabled` - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
 * `restore_window_days` - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
+* `on_demand_policy_item` - Specifications for [on-demand policy](#on-demand-policy-item).
+* `policy_item_hourly` - Scheduled policy using an hourly frequency type, see [block fields](#policy-item-hourly).
+* `policy_item_daily` - Scheduled policy using a daily frequency type, see [block fields](#policy-item-daily).
+* `policy_item_weekly` - Scheduled policy using a weekly frequency type, see [block fields](#policy-item-weekly).
+* `policy_item_monthly` - Scheduled policy using a monthly frequency type, see [block fields](#policy-item-monthly).
+* `policy_item_yearly` - Scheduled policy using a yearly frequency type, see [block fields](#policy-item-yearly).
 
 ## Attributes Reference
 

internal/service/backupcompliancepolicy/data_source_backup_compliance_policy.go

@@ -285,8 +285,8 @@ func dataSourceRead(ctx context.Context, d *schema.ResourceData, meta any) diag.
 		return diag.FromErr(fmt.Errorf(errorSnapshotBackupPolicySetting, "updated_user", projectID, err))
 	}
 
-	if err := d.Set("on_demand_policy_item", flattenOnDemandBackupPolicyItem(policy.GetOnDemandPolicyItem())); err != nil {
-		return diag.FromErr(fmt.Errorf(errorSnapshotBackupPolicySetting, "policies", projectID, err))
+	if err := d.Set("on_demand_policy_item", flattenOnDemandBackupPolicyItem(policy.OnDemandPolicyItem)); err != nil {
+		return diag.FromErr(fmt.Errorf(errorSnapshotBackupPolicySetting, "on_demand_policy_item", projectID, err))
 	}
 
 	if err := d.Set("policy_item_hourly", flattenBackupPolicyItems(policy.GetScheduledPolicyItems(), cloudbackupschedule.Hourly)); err != nil {

internal/service/backupcompliancepolicy/resource_backup_compliance_policy.go

@@ -70,7 +70,7 @@ func Resource() *schema.Resource {
 			"on_demand_policy_item": {
 				Type:     schema.TypeList,
 				MaxItems: 1,
-				Required: true,
+				Optional: true,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"id": {
@@ -330,8 +330,8 @@ func resourceRead(ctx context.Context, d *schema.ResourceData, meta any) diag.Di
 		return diag.FromErr(fmt.Errorf(errorBackupPolicySetting, "pit_enabled", projectID, err))
 	}
 
-	if err := d.Set("on_demand_policy_item", flattenOnDemandBackupPolicyItem(policy.GetOnDemandPolicyItem())); err != nil {
-		return diag.FromErr(fmt.Errorf(errorBackupPolicySetting, "scheduled_policy_items", projectID, err))
+	if err := d.Set("on_demand_policy_item", flattenOnDemandBackupPolicyItem(policy.OnDemandPolicyItem)); err != nil {
+		return diag.FromErr(fmt.Errorf(errorBackupPolicySetting, "on_demand_policy_item", projectID, err))
 	}
 
 	if err := d.Set("policy_item_hourly", flattenBackupPolicyItems(policy.GetScheduledPolicyItems(), cloudbackupschedule.Hourly)); err != nil {
@@ -411,7 +411,10 @@ func resourceImport(ctx context.Context, d *schema.ResourceData, meta any) ([]*s
 	return []*schema.ResourceData{d}, nil
 }
 
-func flattenOnDemandBackupPolicyItem(item admin.BackupComplianceOnDemandPolicyItem) []map[string]any {
+func flattenOnDemandBackupPolicyItem(item *admin.BackupComplianceOnDemandPolicyItem) []map[string]any {
+	if item == nil {
+		return nil
+	}
 	return []map[string]any{
 		{
 			"id":                 item.GetId(),

internal/service/backupcompliancepolicy/resource_backup_compliance_policy_test.go

@@ -93,7 +93,7 @@ func TestAccBackupCompliancePolicy_overwriteBackupPolicies(t *testing.T) {
 	})
 }
 
-func TestAccBackupCompliancePolicy_withoutRestoreWindowDays(t *testing.T) {
+func TestAccBackupCompliancePolicy_withoutRestoreWindowDaysAndOnDemand(t *testing.T) {
 	var (
 		orgID          = os.Getenv("MONGODB_ATLAS_ORG_ID")
 		projectName    = acc.RandomProjectName() // No ProjectIDExecution to avoid conflicts with backup compliance policy
@@ -105,11 +105,12 @@ func TestAccBackupCompliancePolicy_withoutRestoreWindowDays(t *testing.T) {
 		ProtoV6ProviderFactories: acc.TestAccProviderV6Factories,
 		Steps: []resource.TestStep{
 			{
-				Config: configWithoutRestoreDays(projectName, orgID, projectOwnerID),
+				Config: configWithoutRestoreDaysAndOnDemand(projectName, orgID, projectOwnerID),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					checkExists(resourceName),
 					resource.TestCheckResourceAttr(resourceName, "copy_protection_enabled", "false"),
 					resource.TestCheckResourceAttr(resourceName, "encryption_at_rest_enabled", "false"),
+					resource.TestCheckResourceAttr(resourceName, "on_demand_policy_item.#", "0"),
 				),
 			},
 		},
@@ -136,6 +137,7 @@ func TestAccBackupCompliancePolicy_UpdateSetsAllAttributes(t *testing.T) {
 					resource.TestCheckResourceAttr(resourceName, "pit_enabled", "false"),
 					resource.TestCheckResourceAttr(resourceName, "encryption_at_rest_enabled", "false"),
 					resource.TestCheckResourceAttr(resourceName, "copy_protection_enabled", "true"),
+					resource.TestCheckResourceAttr(resourceName, "on_demand_policy_item.0.retention_value", "3"),
 				),
 			},
 			{
@@ -324,7 +326,7 @@ func configWithoutOptionals(projectName, orgID, projectOwnerID string) string {
 	`
 }
 
-func configWithoutRestoreDays(projectName, orgID, projectOwnerID string) string {
+func configWithoutRestoreDaysAndOnDemand(projectName, orgID, projectOwnerID string) string {
 	return acc.ConfigProjectWithSettings(projectName, orgID, projectOwnerID, false) + `	  
 	  resource "mongodbatlas_backup_compliance_policy" "backup_policy_res" {
 			project_id                 = mongodbatlas_project.test.id
@@ -335,14 +337,6 @@ func configWithoutRestoreDays(projectName, orgID, projectOwnerID string) string
 			pit_enabled                = false
 			encryption_at_rest_enabled = false
 			
-			//restore_window_days = 7
-			
-			on_demand_policy_item {
-				frequency_interval = 0
-				retention_unit     = "days"
-				retention_value    = 3
-			}
-			
 			policy_item_hourly {
 				frequency_interval = 6
 				retention_unit     = "days"