fix: Incompatible schema defined for mongodbatlas_backup_compliance_policy

[andreaangiolillo]

Description

Ticket: https://jira.mongodb.org/browse/CLOUDP-220384

Bug:

Running tfplugindocs generate returns the following error:

Error executing command: unable to generate website: unable to render doc "mongodbatlas_backup_compliance_policy": unable to render template for "mongodbatlas_backup_compliance_policy": unable to render schema: unable to render schema: no match for "on_demand_policy_item", this can happen if you have incompatible schema defined, for example an optional block where all the child attributes are computed, in which case the block itself should also be marked computed 

Cause:

As the error message suggests this can happen if you have incompatible schema defined, for example an optional block where all the child attributes are computed, in which case the block itself should also be marked computed, the attribute on_demand_policy_item is marked as Optional while having all the child attributes as Computed

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.
• Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR.
• This change requires a documentation update
• Documentation fix/enhancement

Required Checklist:

• I have signed the MongoDB CLA
• I have read the contribution guidelines
• 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 defined an isolated PR with a relevant title as it will be used in the auto-generated changelog.

Further comments

[marcosuma]

any potential breaking changes ? or plan change detections?
I am asking to make sure you've done some extra testing.

[AgustinBettati]

while I do not see a risk in this change as project_id is documented as the only argument for the data source, we should consider also fixing inconsistencies present in policy_item_hourly, policy_item_daily, policy_item_weekly and policy_item_monthly which are not defined as computed. Error seems to only be raised in on_demand_policy_item because all nested attributes are computed.

[andreaangiolillo]

@AgustinBettati All the policy_item_* fields have a few required parameters such as retention_unit and retention_value which is the reason why we are not getting the error for them.

[andreaangiolillo]

@marcosuma I was able to test locally that this is not a breaking change.
Testing scenario:

• Run the following configuration

resource "mongodbatlas_project" "atlas-project" {
  name   = "test-andrea"
  org_id = "XXXXXXXXXXXXXX"
}

resource "mongodbatlas_backup_compliance_policy" "backup_policy" {
  project_id                 = mongodbatlas_project.atlas-project.id
  authorized_email           = "[email protected]"
  authorized_user_first_name = "ssss"
  authorized_user_last_name  = "sss"
  copy_protection_enabled    = false
  pit_enabled                = false
  encryption_at_rest_enabled = false

  restore_window_days = 7

  on_demand_policy_item {
    frequency_interval = 1
    retention_unit     = "days"
    retention_value    = 3
  }

  policy_item_hourly {
    frequency_interval = 1
    retention_unit     = "days"
    retention_value    = 7
  }

  policy_item_daily {
    frequency_interval = 1
    retention_unit     = "days"
    retention_value    = 7
  }

  policy_item_weekly {
    frequency_interval = 1
    retention_unit     = "weeks"
    retention_value    = 4
  }

  policy_item_monthly {
    frequency_interval = 1
    retention_unit     = "months"
    retention_value    = 12
  }

}

data "mongodbatlas_backup_compliance_policy" "backup_policy" {
  project_id = mongodbatlas_backup_compliance_policy.backup_policy.project_id
}

• Run TF apply with the latest provider

Apply complete! Resources: 2 added, 0 changed, 0 destroyed.

• Updated the provider to use local version and run again terraform apply

No changes. Your infrastructure matches the configuration.

Apply complete! Resources: 0 added, 0 changed, 0 destroyed.

[AgustinBettati]

Just to be sure, is it possible that the relevant data source backup_compliance_policy was not tested in the above test configuration?

All the policy_item_* fields have a few required parameters such as retention_unit and retention_value which is the reason why we are not getting the error for them

Correct, I was bringing this up as I don't see why there should be optional or required attributes given that they should not be defined in the configuration of the data source. All of them should be computed except for project_id which is the only argument for using the data source.

[andreaangiolillo]

Just to be sure, is it possible that the relevant data source backup_compliance_policy was not tested in the above test configuration?

ops, I copied/pasted the wrong conf 🤦 I updated my message. Thanks!

Correct, I was bringing this up as I don't see why there should be optional or required attributes given that they should not be defined in the configuration of the data source. All of them should be computed except for project_id which is the only argument for using the data source.

Thanks for the clarification. I agree, I updated the schema to make them computed as well. I also retested the new changes with the TF conf and no changes where detected. Thanks!

[AgustinBettati]

LGTM, thanks for the followup adjustments