Add data retention policy block to workspace resource

Author: mwudka

internal/provider/client_mock_workspaces.go

@@ -172,3 +172,15 @@ func (m *mockWorkspaces) SafeDelete(ctx context.Context, organization string, wo
 func (m *mockWorkspaces) SafeDeleteByID(ctx context.Context, workspaceID string) error {
 	panic("not implemented")
 }
+
+func (m *mockWorkspaces) ReadDataRetentionPolicy(ctx context.Context, workspaceID string) (*tfe.DataRetentionPolicy, error) {
+	panic("not implemented")
+}
+
+func (m *mockWorkspaces) SetDataRetentionPolicy(ctx context.Context, workspaceID string, options tfe.DataRetentionPolicySetOptions) (*tfe.DataRetentionPolicy, error) {
+	panic("not implemented")
+}
+
+func (m *mockWorkspaces) DeleteDataRetentionPolicy(ctx context.Context, workspaceID string) error {
+	panic("not implemented")
+}

internal/provider/resource_tfe_workspace.go

@@ -230,6 +230,21 @@ func resourceTFEWorkspace() *schema.Resource {
 				Default:  "",
 			},
 
+			"data_retention_policy": {
+				Type:     schema.TypeList,
+				Optional: true,
+				MinItems: 1,
+				MaxItems: 1,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"delete_older_than_n_days": {
+							Type:     schema.TypeInt,
+							Required: true,
+						},
+					},
+				},
+			},
+
 			"vcs_repo": {
 				Type:     schema.TypeList,
 				Optional: true,
@@ -428,6 +443,18 @@ func resourceTFEWorkspaceCreate(d *schema.ResourceData, meta interface{}) error
 
 	d.SetId(workspace.ID)
 
+	if v, ok := d.GetOk("data_retention_policy"); ok {
+		drp := v.([]interface{})[0].(map[string]interface{})
+
+		_, err = config.Client.Workspaces.SetDataRetentionPolicy(ctx, workspace.ID, tfe.DataRetentionPolicySetOptions{
+			DeleteOlderThanNDays: drp["delete_older_than_n_days"].(int),
+		})
+
+		if err != nil {
+			return fmt.Errorf("Error setting data retention policy on workspace %s: %w", name, err)
+		}
+	}
+
 	if sshKeyID, ok := d.GetOk("ssh_key_id"); ok {
 		_, err = config.Client.Workspaces.AssignSSHKey(ctx, workspace.ID, tfe.WorkspaceAssignSSHKeyOptions{
 			SSHKeyID: tfe.String(sshKeyID.(string)),
@@ -542,6 +569,22 @@ func resourceTFEWorkspaceRead(d *schema.ResourceData, meta interface{}) error {
 
 	d.Set("vcs_repo", vcsRepo)
 
+	var dataRetentionPolicy []interface{}
+	if workspace.DataRetentionPolicy != nil {
+		policy, err := config.Client.Workspaces.ReadDataRetentionPolicy(ctx, id)
+
+		if err != nil {
+			return fmt.Errorf(
+				"Error data retention policy for workspace %s: %w", id, err)
+		}
+
+		drp := map[string]interface{}{
+			"delete_older_than_n_days": policy.DeleteOlderThanNDays,
+		}
+		dataRetentionPolicy = append(dataRetentionPolicy, drp)
+	}
+	d.Set("data_retention_policy", dataRetentionPolicy)
+
 	if workspace.GlobalRemoteState {
 		d.Set("global_remote_state", true)
 	} else {
@@ -734,6 +777,25 @@ func resourceTFEWorkspaceUpdate(d *schema.ResourceData, meta interface{}) error
 		}
 	}
 
+	// nolint: nestif
+	if d.HasChange("data_retention_policy") {
+		v, ok := d.GetOk("data_retention_policy")
+		if ok {
+			drp := v.([]interface{})[0].(map[string]interface{})
+			_, err := config.Client.Workspaces.SetDataRetentionPolicy(ctx, id, tfe.DataRetentionPolicySetOptions{DeleteOlderThanNDays: drp["delete_older_than_n_days"].(int)})
+			if err != nil {
+				d.Partial(true)
+				return fmt.Errorf("Error setting data retention policy on workspace %s: %w", d.Id(), err)
+			}
+		} else {
+			err := config.Client.Workspaces.DeleteDataRetentionPolicy(ctx, id)
+			if err != nil {
+				d.Partial(true)
+				return fmt.Errorf("Error deleting data retention policy from workspace %s: %w", d.Id(), err)
+			}
+		}
+	}
+
 	if d.HasChange("tag_names") {
 		oldTagNameValues, newTagNameValues := d.GetChange("tag_names")
 		newTagNamesSet := newTagNameValues.(*schema.Set)

internal/provider/resource_tfe_workspace_test.go

@@ -1484,6 +1484,83 @@ func TestAccTFEWorkspace_updateVCSRepo(t *testing.T) {
 	})
 }
 
+func TestAccTFEWorkspace_updateDataRetentionPolicy(t *testing.T) {
+	skipIfCloud(t)
+
+	workspace := &tfe.Workspace{}
+	rInt := rand.New(rand.NewSource(time.Now().UnixNano())).Int()
+
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			testAccPreCheck(t)
+		},
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckTFEWorkspaceDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccTFEWorkspace_basicForceDeleteEnabled(rInt),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckTFEWorkspaceExists(
+						"tfe_workspace.foobar", workspace, testAccProvider),
+					resource.TestCheckNoResourceAttr("tfe_workspace.foobar", "data_retention_policy.0.delete_older_than_n_days"),
+				),
+			},
+			{
+				Config: testAccTFEWorkspace_dataRetentionPolicy(rInt, 8),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(
+						"tfe_workspace.foobar", "data_retention_policy.0.delete_older_than_n_days", "8"),
+				),
+			},
+			{
+				Config: testAccTFEWorkspace_dataRetentionPolicy(rInt, 20),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(
+						"tfe_workspace.foobar", "data_retention_policy.0.delete_older_than_n_days", "20"),
+				),
+			},
+			{
+				Config: testAccTFEWorkspace_basicForceDeleteEnabled(rInt),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckTFEWorkspaceExists(
+						"tfe_workspace.foobar", workspace, testAccProvider),
+					resource.TestCheckNoResourceAttr("tfe_workspace.foobar", "data_retention_policy.0.delete_older_than_n_days"),
+				),
+			},
+		},
+	})
+}
+
+func TestAccTFEWorkspace_importDataRetentionPolicy(t *testing.T) {
+	skipIfCloud(t)
+
+	rInt := rand.New(rand.NewSource(time.Now().UnixNano())).Int()
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckTFEWorkspaceDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccTFEWorkspace_dataRetentionPolicy(rInt, 10),
+			},
+			{
+				ResourceName:            "tfe_workspace.foobar",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"force_delete"},
+			},
+			{
+				ResourceName:            "tfe_workspace.foobar",
+				ImportState:             true,
+				ImportStateId:           fmt.Sprintf("tst-terraform-%d/workspace-test", rInt),
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"force_delete"},
+			},
+		},
+	})
+}
+
 func TestAccTFEWorkspace_updateGitHubAppRepo(t *testing.T) {
 	workspace := &tfe.Workspace{}
 	rInt := rand.New(rand.NewSource(time.Now().UnixNano())).Int()
@@ -3655,3 +3732,20 @@ func testAccTFEWorkspace_mismatchOrganization() string {
 		description        = "My favorite workspace!"
 	}`
 }
+
+func testAccTFEWorkspace_dataRetentionPolicy(rInt int, deleteOlderThanNDays int) string {
+	return fmt.Sprintf(`
+resource "tfe_organization" "foobar" {
+  name  = "tst-terraform-%d"
+  email = "admin@company.com"
+}
+
+resource "tfe_workspace" "foobar" {
+  name         = "workspace-test"
+  organization = tfe_organization.foobar.id
+  data_retention_policy {
+    delete_older_than_n_days = %d
+  }
+}
+`, rInt, deleteOlderThanNDays)
+}

website/docs/r/workspace.html.markdown

@@ -68,6 +68,7 @@ The following arguments are supported:
 * `assessments_enabled` - (Optional) Whether to regularly run health assessments such as drift detection on the workspace. Defaults to `false`.
 * `auto_apply` - (Optional) Whether to automatically apply changes when a Terraform plan is successful. Defaults to `false`.
 * `auto_apply_run_trigger` - (Optional) Whether to automatically apply changes for runs that were created by run triggers from another workspace. Defaults to `false`.
+* `data_retention_policy` - (Optional) The workspace's [data retention policy](https://developer.hashicorp.com/terraform/enterprise/workspaces/settings/deletion#data-retention-policies). 
 * `description` - (Optional) A description for the workspace.
 * `execution_mode` - (Optional) **Deprecated** Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) to use. Use [tfe_workspace_settings](workspace_settings) instead.
 * `file_triggers_enabled` - (Optional) Whether to filter runs based on the changed files
@@ -127,6 +128,10 @@ The following arguments are supported:
   workflows, where runs are not driven by webhooks on your VCS provider.
 * `working_directory` - (Optional) A relative path that Terraform will execute within.  Defaults to the root of your repository.
 
+The `data_retention_policy` block supports:
+
+* `delete_older_than_n_days` - (Required) Automatically delete backing data for state versions and configuration versions older than N days.
+
 The `vcs_repo` block supports:
 
 * `identifier` - (Required) A reference to your VCS repository in the format