Adding log_retention_days field to existing bp resource for backupdr (#14622) (#23846)

[upstream:d1d207118dbf770c8a8c7dc820f1954d10219c49]

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

.changelog/14622.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+backupdr: added `log_retention_days` field to `google_backup_dr_backup_plan` resource
+```

google/services/backupdr/data_source_backup_dr_backup_plan_test.go

@@ -17,9 +17,10 @@
 package backupdr_test
 
 import (
+	"testing"
+
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
 	"github.com/hashicorp/terraform-provider-google/google/acctest"
-	"testing"
 )
 
 func TestAccDataSourceGoogleBackupDRBackupPlan_basic(t *testing.T) {
@@ -42,6 +43,26 @@ func TestAccDataSourceGoogleBackupDRBackupPlan_basic(t *testing.T) {
 	})
 }
 
+func TestAccDataSourceGoogleBackupDRBackupPlan_csql(t *testing.T) {
+	t.Parallel()
+	context := map[string]interface{}{
+		"random_suffix": acctest.RandString(t, 10),
+	}
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckBackupDRBackupPlanDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDataSourceGoogleBackupDRBackupPlan_csql(context),
+				Check: resource.ComposeTestCheckFunc(
+					acctest.CheckDataSourceStateMatchesResourceState("data.google_backup_dr_backup_plan.fetch-bp", "google_backup_dr_backup_plan.csql-test"),
+				),
+			},
+		},
+	})
+}
+
 func testAccDataSourceGoogleBackupDRBackupPlan_basic(context map[string]interface{}) string {
 	return acctest.Nprintf(`
 resource "google_backup_dr_backup_vault" "my-backup-vault-1" {
@@ -94,3 +115,57 @@ data "google_backup_dr_backup_plan" "fetch-bp" {
   }
 `, context)
 }
+
+func testAccDataSourceGoogleBackupDRBackupPlan_csql(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_backup_dr_backup_vault" "my-backup-vault-csql" {
+    location ="us-central1"
+    backup_vault_id    = "tf-test-bv-%{random_suffix}"
+    description = "This is a backup vault built by Terraform for cloudsql."
+    backup_minimum_enforced_retention_duration = "100000s"
+    labels = {
+      foo = "bar1"
+      bar = "baz1"
+    }
+    annotations = {
+      annotations1 = "bar1"
+      annotations2 = "baz1"
+    }
+    force_update = "true"
+    force_delete = "true"
+    allow_missing = "true" 
+}
+
+
+resource "google_backup_dr_backup_plan" "csql-test" { 
+  location = "us-central1" 
+  backup_plan_id = "tf-test-bp-%{random_suffix}"
+  resource_type= "sqladmin.googleapis.com/Instance"
+  backup_vault = google_backup_dr_backup_vault.my-backup-vault-csql.name
+  depends_on=[ google_backup_dr_backup_vault.my-backup-vault-csql ]
+  lifecycle {
+    ignore_changes = [backup_vault]
+  }
+  log_retention_days = 4
+  backup_rules {
+    rule_id = "rule-1"
+    backup_retention_days = 5
+    standard_schedule {
+      recurrence_type = "HOURLY"
+      hourly_frequency = 6
+      time_zone = "UTC"
+      backup_window{
+        start_hour_of_day = 0
+        end_hour_of_day = 24
+      }
+    }
+  }
+}
+
+data "google_backup_dr_backup_plan" "fetch-bp" {
+  location =  "us-central1"
+  backup_plan_id=google_backup_dr_backup_plan.csql-test.backup_plan_id
+  depends_on= [ google_backup_dr_backup_plan.csql-test ]
+  }
+`, context)
+}

google/services/backupdr/resource_backup_dr_backup_plan.go

@@ -196,14 +196,20 @@ This is required for 'recurrence_type', 'HOURLY' and is not applicable otherwise
 				Type:     schema.TypeString,
 				Required: true,
 				Description: `The resource type to which the 'BackupPlan' will be applied.
-Examples include, "compute.googleapis.com/Instance", "compute.googleapis.com/Disk", and "storage.googleapis.com/Bucket".`,
+Examples include, "compute.googleapis.com/Instance", "compute.googleapis.com/Disk", "sqladmin.googleapis.com/Instance" and "storage.googleapis.com/Bucket".`,
 			},
 			"description": {
 				Type:        schema.TypeString,
 				Optional:    true,
 				Description: `The description allows for additional details about 'BackupPlan' and its use cases to be provided.`,
 				Default:     "",
 			},
+			"log_retention_days": {
+				Type:        schema.TypeInt,
+				Optional:    true,
+				ForceNew:    true,
+				Description: `This is only applicable for CloudSql resource. Days for which logs will be stored. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.`,
+			},
 			"backup_vault_service_account": {
 				Type:        schema.TypeString,
 				Computed:    true,
@@ -267,6 +273,12 @@ func resourceBackupDRBackupPlanCreate(d *schema.ResourceData, meta interface{})
 	} else if v, ok := d.GetOkExists("backup_rules"); !tpgresource.IsEmptyValue(reflect.ValueOf(backupRulesProp)) && (ok || !reflect.DeepEqual(v, backupRulesProp)) {
 		obj["backupRules"] = backupRulesProp
 	}
+	logRetentionDaysProp, err := expandBackupDRBackupPlanLogRetentionDays(d.Get("log_retention_days"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("log_retention_days"); !tpgresource.IsEmptyValue(reflect.ValueOf(logRetentionDaysProp)) && (ok || !reflect.DeepEqual(v, logRetentionDaysProp)) {
+		obj["logRetentionDays"] = logRetentionDaysProp
+	}
 
 	url, err := tpgresource.ReplaceVars(d, config, "{{BackupDRBasePath}}projects/{{project}}/locations/{{location}}/backupPlans/?backup_plan_id={{backup_plan_id}}")
 	if err != nil {
@@ -390,6 +402,9 @@ func resourceBackupDRBackupPlanRead(d *schema.ResourceData, meta interface{}) er
 	if err := d.Set("backup_rules", flattenBackupDRBackupPlanBackupRules(res["backupRules"], d, config)); err != nil {
 		return fmt.Errorf("Error reading BackupPlan: %s", err)
 	}
+	if err := d.Set("log_retention_days", flattenBackupDRBackupPlanLogRetentionDays(res["logRetentionDays"], d, config)); err != nil {
+		return fmt.Errorf("Error reading BackupPlan: %s", err)
+	}
 
 	return nil
 }
@@ -773,6 +788,23 @@ func flattenBackupDRBackupPlanBackupRulesStandardScheduleBackupWindowEndHourOfDa
 	return v // let terraform core handle it otherwise
 }
 
+func flattenBackupDRBackupPlanLogRetentionDays(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	// Handles the string fixed64 format
+	if strVal, ok := v.(string); ok {
+		if intVal, err := tpgresource.StringToFixed64(strVal); err == nil {
+			return intVal
+		}
+	}
+
+	// number values are represented as float64
+	if floatVal, ok := v.(float64); ok {
+		intVal := int(floatVal)
+		return intVal
+	}
+
+	return v // let terraform core handle it otherwise
+}
+
 func expandBackupDRBackupPlanDescription(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
 	return v, nil
 }
@@ -988,3 +1020,7 @@ func expandBackupDRBackupPlanBackupRulesStandardScheduleBackupWindowStartHourOfD
 func expandBackupDRBackupPlanBackupRulesStandardScheduleBackupWindowEndHourOfDay(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
 	return v, nil
 }
+
+func expandBackupDRBackupPlanLogRetentionDays(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}

google/services/backupdr/resource_backup_dr_backup_plan_generated_meta.yaml

@@ -25,6 +25,7 @@ fields:
   - field: 'description'
   - field: 'location'
     provider_only: true
+  - field: 'log_retention_days'
   - field: 'name'
   - field: 'resource_type'
   - field: 'update_time'

google/services/backupdr/resource_backup_dr_backup_plan_generated_test.go

@@ -88,6 +88,65 @@ resource "google_backup_dr_backup_plan" "my-backup-plan-1" {
 `, context)
 }
 
+func TestAccBackupDRBackupPlan_backupDrBackupPlanForCsqlResourceExample(t *testing.T) {
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"random_suffix": acctest.RandString(t, 10),
+	}
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckBackupDRBackupPlanDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccBackupDRBackupPlan_backupDrBackupPlanForCsqlResourceExample(context),
+			},
+			{
+				ResourceName:            "google_backup_dr_backup_plan.my-csql-backup-plan-1",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"backup_plan_id", "location"},
+			},
+		},
+	})
+}
+
+func testAccBackupDRBackupPlan_backupDrBackupPlanForCsqlResourceExample(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_backup_dr_backup_vault" "my_backup_vault" {
+  location                                      = "us-central1"
+  backup_vault_id                               = "tf-test-backup-vault-csql-test%{random_suffix}"
+  backup_minimum_enforced_retention_duration    = "100000s"
+}
+
+resource "google_backup_dr_backup_plan" "my-csql-backup-plan-1" {
+  location       = "us-central1"
+  backup_plan_id = "tf-test-backup-plan-csql-test%{random_suffix}"
+  resource_type  = "sqladmin.googleapis.com/Instance"
+  backup_vault   = google_backup_dr_backup_vault.my_backup_vault.id
+
+  backup_rules {
+    rule_id                = "rule-1"
+    backup_retention_days  = 5
+
+    standard_schedule {
+      recurrence_type     = "HOURLY"
+      hourly_frequency    = 6
+      time_zone           = "UTC"
+
+      backup_window {
+        start_hour_of_day = 0
+        end_hour_of_day   = 6
+      }
+    }
+  }
+  log_retention_days = 4
+}
+`, context)
+}
+
 func testAccCheckBackupDRBackupPlanDestroyProducer(t *testing.T) func(s *terraform.State) error {
 	return func(s *terraform.State) error {
 		for name, rs := range s.RootModule().Resources {

website/docs/r/backup_dr_backup_plan.html.markdown

@@ -98,6 +98,40 @@ resource "google_backup_dr_backup_plan" "my-disk-backup-plan-1" {
   }
 }
 ```
+## Example Usage - Backup Dr Backup Plan For Csql Resource
+
+
+```hcl
+resource "google_backup_dr_backup_vault" "my_backup_vault" {
+  location                                      = "us-central1"
+  backup_vault_id                               = "backup-vault-csql-test"
+  backup_minimum_enforced_retention_duration    = "100000s"
+}
+
+resource "google_backup_dr_backup_plan" "my-csql-backup-plan-1" {
+  location       = "us-central1"
+  backup_plan_id = "backup-plan-csql-test"
+  resource_type  = "sqladmin.googleapis.com/Instance"
+  backup_vault   = google_backup_dr_backup_vault.my_backup_vault.id
+
+  backup_rules {
+    rule_id                = "rule-1"
+    backup_retention_days  = 5
+
+    standard_schedule {
+      recurrence_type     = "HOURLY"
+      hourly_frequency    = 6
+      time_zone           = "UTC"
+
+      backup_window {
+        start_hour_of_day = 0
+        end_hour_of_day   = 6
+      }
+    }
+  }
+  log_retention_days = 4
+}
+```
 
 ## Argument Reference
 
@@ -111,7 +145,7 @@ The following arguments are supported:
 * `resource_type` -
   (Required)
   The resource type to which the `BackupPlan` will be applied.
-  Examples include, "compute.googleapis.com/Instance", "compute.googleapis.com/Disk", and "storage.googleapis.com/Bucket".
+  Examples include, "compute.googleapis.com/Instance", "compute.googleapis.com/Disk", "sqladmin.googleapis.com/Instance" and "storage.googleapis.com/Bucket".
 
 * `backup_rules` -
   (Required)
@@ -131,6 +165,10 @@ The following arguments are supported:
   (Optional)
   The description allows for additional details about `BackupPlan` and its use cases to be provided.
 
+* `log_retention_days` -
+  (Optional)
+  This is only applicable for CloudSql resource. Days for which logs will be stored. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+
 * `project` - (Optional) The ID of the project in which the resource belongs.
     If it is not provided, the provider project is used.