fix: read ws before creating tfe_workspace_settings (#1795)

* fix: read ws before create settings

During create, the default boolean values coming from the model can easily overwrite the values that were set on the tfe_workspace.

The solution is to read the workspace before creating the settings resource so that the state is set correctly.

* chore: prep for 0.68.2 release

* fix underscores in variable names

Author: brandonc

CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
 
+## v0.68.2
+
+BUG FIXES:
+
+* `r/tfe_workspace_settings`: during create, true boolean values set on tfe_workspace can be overwritten if omitted from tfe_workspace_settings config. [#1795](https://github.com/hashicorp/terraform-provider-tfe/pull/1795)
+
 ## v0.68.1
 
 BUG FIXES:

README.md

@@ -28,7 +28,7 @@ Declare the provider in your configuration and `terraform init` will automatical
 terraform {
   required_providers {
     tfe = {
-      version = "~> 0.68.1"
+      version = "~> 0.68.2"
     }
   }
 }

internal/provider/resource_tfe_workspace_settings.go

@@ -22,6 +22,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
 	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
 )
 
 // tfe_workspace_settings resource
@@ -621,10 +622,52 @@ func (r *workspaceSettings) addAndRemoveRemoteStateConsumers(workspaceID string,
 }
 
 func (r *workspaceSettings) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
-	var data modelWorkspaceSettings
-	resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
+	var workspaceID string
+	resp.Diagnostics.Append(req.Plan.GetAttribute(ctx, path.Root("workspace_id"), &workspaceID)...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
 
-	if err := r.updateSettings(ctx, &data, &resp.State); err != nil {
+	// Start by reading the current settings of the workspace so we don't overwrite them with defaults
+	model, err := r.readSettings(ctx, workspaceID)
+	if err != nil {
+		resp.Diagnostics.AddError("Error reading workspace", fmt.Sprintf("Could not read workspace %s: %s", workspaceID, err.Error()))
+	}
+
+	planned := modelWorkspaceSettings{}
+	resp.Diagnostics.Append(req.Config.Get(ctx, &planned)...)
+
+	var autoApply types.Bool
+	var assessmentsEnabled types.Bool
+	var globalRemoteState types.Bool
+
+	resp.Diagnostics.Append(req.Config.GetAttribute(ctx, path.Root("auto_apply"), &autoApply)...)
+	resp.Diagnostics.Append(req.Config.GetAttribute(ctx, path.Root("assessments_enabled"), &assessmentsEnabled)...)
+	resp.Diagnostics.Append(req.Config.GetAttribute(ctx, path.Root("global_remote_state"), &globalRemoteState)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	// Prefer the read value if there is no config value
+	if autoApply.IsNull() {
+		tflog.Debug(ctx, fmt.Sprintf("auto_apply is not set in config, overwrite with the read value %v", model.AutoApply.ValueBool()))
+		planned.AutoApply = model.AutoApply
+	}
+	if assessmentsEnabled.IsNull() {
+		tflog.Debug(ctx, fmt.Sprintf("assessments_enabled is not set in config, overwrite with the read value %v", model.AssessmentsEnabled.ValueBool()))
+		planned.AssessmentsEnabled = model.AssessmentsEnabled
+	}
+	if globalRemoteState.IsNull() {
+		tflog.Debug(ctx, fmt.Sprintf("global_remote_state is not set in config, overwrite with the read value %v", model.GlobalRemoteState.ValueBool()))
+		planned.GlobalRemoteState = model.GlobalRemoteState
+	}
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	if err := r.updateSettings(ctx, &planned, &resp.State); err != nil {
 		resp.Diagnostics.AddError("Error updating workspace", err.Error())
 	}
 }

internal/provider/resource_tfe_workspace_settings_test.go

@@ -126,6 +126,39 @@ func TestAccTFEWorkspaceSettings_stateSharing(t *testing.T) {
 	})
 }
 
+func TestAccTFEWorkspaceSettings_overlappingBooleans(t *testing.T) {
+	tfeClient, err := getClientUsingEnv()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	org, cleanupOrg := createBusinessOrganization(t, tfeClient)
+	t.Cleanup(cleanupOrg)
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:                 func() { testAccPreCheck(t) },
+		ProtoV5ProviderFactories: testAccMuxedProviders,
+		Steps: []resource.TestStep{
+			// Start with local execution
+			{
+				Config: testAccTFEWorkspaceSettingsOverlappingBooleans(org.Name),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet(
+						"tfe_workspace.name", "id"),
+					resource.TestCheckResourceAttr(
+						"tfe_workspace.name", "auto_apply", "true"),
+					resource.TestCheckResourceAttr(
+						"tfe_workspace.name", "assessments_enabled", "false"),
+					resource.TestCheckResourceAttr(
+						"tfe_workspace_settings.self", "auto_apply", "true"),
+					resource.TestCheckResourceAttr(
+						"tfe_workspace_settings.self", "assessments_enabled", "false"),
+				),
+			},
+		},
+	})
+}
+
 func TestAccTFEWorkspaceSettings_basicOptions(t *testing.T) {
 	tfeClient, err := getClientUsingEnv()
 	if err != nil {
@@ -391,6 +424,20 @@ func testAccCheckTFEWorkspaceSettingsDestroy(s *terraform.State) error {
 	return nil
 }
 
+func testAccTFEWorkspaceSettingsOverlappingBooleans(orgName string) string {
+	return fmt.Sprintf(`
+resource "tfe_workspace_settings" "self" {
+  workspace_id        = tfe_workspace.name.id
+}
+
+resource "tfe_workspace" "name" {
+	organization = "%s"
+	name="permanent_auto_apply_drift"
+	auto_apply = true
+}
+`, orgName)
+}
+
 func testAccTFEWorkspaceSettingsUnknownIDRemoteState(orgName string) string {
 	return fmt.Sprintf(`
 resource "tfe_workspace" "foobar1" {

version/VERSION

@@ -1 +1 @@
-0.68.1
+0.68.2

website/docs/index.html.markdown

@@ -74,7 +74,7 @@ automatically installed by `terraform init` in the future:
 terraform {
   required_providers {
     tfe = {
-      version = "~> 0.68.1"
+      version = "~> 0.68.2"
     }
   }
 }
@@ -87,7 +87,7 @@ The above snippet using `required_providers` is for Terraform 0.13+; if you are
 
 ```hcl
 provider "tfe" {
-  version = "~> 0.68.1"
+  version = "~> 0.68.2"
   ...
 }
 ```
@@ -100,7 +100,7 @@ For more information on provider installation and constraining provider versions
 provider "tfe" {
   hostname = var.hostname # Optional, defaults to HCP Terraform `app.terraform.io`
   token    = var.token
-  version  = "~> 0.68.1"
+  version  = "~> 0.68.2"
 }
 
 # Create an organization