Merge pull request #163 from magodo/update_body_patches_remove

`restful_resource` - Supports `update_body_patches.*.removed` to remove values from the update body

Author: magodo

docs/resources/resource.md

@@ -300,7 +300,11 @@ Optional:
 Required:
 
 - `path` (String) The path (in [gjson syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md)) to the attribute to [patch](https://github.com/tidwall/sjson?tab=readme-ov-file#set-a-value).
-- `raw_json` (String) The raw json used as the patch value. It can contain `$(body.x.y.z)` parameter that reference property from the `state.output`.
+
+Optional:
+
+- `raw_json` (String) The raw json used as the patch value. It can contain `$(body.x.y.z)` parameter that reference property from the `state.output`. Exactly one of `raw_json` and `removed` shall be specified.
+- `removed` (Boolean) Remove the value specified by `path` from the update body. Exactly one of `raw_json` and `removed` shall be specified
 
 ## Import
 

internal/provider/resource.go

@@ -9,6 +9,7 @@ import (
 	"strings"
 
 	jsonpatch "github.com/evanphx/json-patch"
+	"github.com/hashicorp/terraform-plugin-framework-validators/boolvalidator"
 	"github.com/hashicorp/terraform-plugin-framework-validators/dynamicvalidator"
 	"github.com/hashicorp/terraform-plugin-framework-validators/objectvalidator"
 	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
@@ -105,6 +106,7 @@ type resourceData struct {
 type bodyPatchData struct {
 	Path    types.String `tfsdk:"path"`
 	RawJSON types.String `tfsdk:"raw_json"`
+	Removed types.Bool   `tfsdk:"removed"`
 }
 
 type pollData struct {
@@ -422,9 +424,25 @@ func (r *Resource) Schema(ctx context.Context, req resource.SchemaRequest, resp
 							Required:            true,
 						},
 						"raw_json": schema.StringAttribute{
-							Description:         "The raw json used as the patch value. It can contain `$(body.x.y.z)` parameter that reference property from the `state.output`.",
-							MarkdownDescription: "The raw json used as the patch value. It can contain `$(body.x.y.z)` parameter that reference property from the `state.output`.",
-							Required:            true,
+							MarkdownDescription: "The raw json used as the patch value. It can contain `$(body.x.y.z)` parameter that reference property from the `state.output`. Exactly one of `raw_json` and `removed` shall be specified.",
+							Optional:            true,
+							Validators: []validator.String{
+								stringvalidator.ExactlyOneOf(
+									path.MatchRelative().AtParent().AtName("raw_json"),
+									path.MatchRelative().AtParent().AtName("removed"),
+								),
+							},
+						},
+						"removed": schema.BoolAttribute{
+							MarkdownDescription: "Remove the value specified by `path` from the update body. Exactly one of `raw_json` and `removed` shall be specified",
+							Optional:            true,
+							Validators: []validator.Bool{
+								boolvalidator.Equals(true),
+								boolvalidator.ExactlyOneOf(
+									path.MatchRelative().AtParent().AtName("raw_json"),
+									path.MatchRelative().AtParent().AtName("removed"),
+								),
+							},
 						},
 					},
 				},
@@ -1356,22 +1374,34 @@ func (r Resource) Update(ctx context.Context, req resource.UpdateRequest, resp *
 	if len(patches) != 0 {
 		planBodyStr := string(planBody)
 		for i, patch := range patches {
-			pv, err := exparam.ExpandBody(patch.RawJSON.ValueString(), stateOutput)
-			if err != nil {
-				resp.Diagnostics.AddError(
-					fmt.Sprintf("Failed to expand the %d-th patch for expression params", i),
-					err.Error(),
-				)
-				return
-			}
+			switch {
+			case !patch.Removed.IsNull():
+				planBodyStr, err = sjson.Delete(planBodyStr, patch.Path.ValueString())
+				if err != nil {
+					resp.Diagnostics.AddError(
+						fmt.Sprintf("Failed to delete json for the %d-th patch at path %q", i, patch.Path.ValueString()),
+						err.Error(),
+					)
+					return
+				}
+			case !patch.RawJSON.IsNull():
+				pv, err := exparam.ExpandBody(patch.RawJSON.ValueString(), stateOutput)
+				if err != nil {
+					resp.Diagnostics.AddError(
+						fmt.Sprintf("Failed to expand the %d-th patch for expression params", i),
+						err.Error(),
+					)
+					return
+				}
 
-			planBodyStr, err = sjson.SetRaw(planBodyStr, patch.Path.ValueString(), pv)
-			if err != nil {
-				resp.Diagnostics.AddError(
-					fmt.Sprintf("Failed to set json for the %d-th patch for expression params", i),
-					err.Error(),
-				)
-				return
+				planBodyStr, err = sjson.SetRaw(planBodyStr, patch.Path.ValueString(), pv)
+				if err != nil {
+					resp.Diagnostics.AddError(
+						fmt.Sprintf("Failed to set json for the %d-th patch with %q", i, pv),
+						err.Error(),
+					)
+					return
+				}
 			}
 		}
 		planBody = []byte(planBodyStr)

internal/provider/resource_jsonserver_test.go

@@ -282,18 +282,29 @@ func TestResource_JSONServer_UpdateBodyPatch(t *testing.T) {
 		ProtoV6ProviderFactories: acceptance.ProviderFactory(),
 		Steps: []resource.TestStep{
 			{
-				Config: d.updateBodyPatch("foo"),
+				// The initial creation won't honor the "update_body_patches"
+				Config: d.updateBodyPatchBase(),
 				ConfigStateChecks: []statecheck.StateCheck{
 					statecheck.ExpectKnownValue(addr, tfjsonpath.New("output").AtMapKey("id"), knownvalue.NotNull()),
 					statecheck.ExpectKnownValue(addr, tfjsonpath.New("output").AtMapKey("foo"), knownvalue.NotNull()),
 					statecheck.ExpectKnownValue(addr, tfjsonpath.New("output"), knownvalue.MapSizeExact(2)),
 				},
 			},
 			{
-				Config: d.updateBodyPatch("bar"),
+				Config: d.updateBodyPatchUpdate(),
 				ConfigStateChecks: []statecheck.StateCheck{
-					statecheck.ExpectKnownValue(addr, tfjsonpath.New("output").AtMapKey("addon").AtMapKey("a"), knownvalue.StringExact("hmm")),
-					statecheck.ExpectKnownValue(addr, tfjsonpath.New("output").AtMapKey("addon").AtMapKey("b"), knownvalue.NotNull()),
+					statecheck.ExpectKnownValue(addr, tfjsonpath.New("output"), knownvalue.MapExact(
+						map[string]knownvalue.Check{
+							"addon": knownvalue.MapExact(
+								map[string]knownvalue.Check{
+									"a": knownvalue.StringExact("hmm"),
+									"b": knownvalue.NotNull(),
+								},
+							),
+							"id": knownvalue.NotNull(),
+						},
+					)),
+					statecheck.ExpectKnownValue(addr, tfjsonpath.New("output"), knownvalue.MapSizeExact(2)),
 				},
 			},
 		},
@@ -644,7 +655,7 @@ resource "restful_resource" "test" {
 `, d.url, v)
 }
 
-func (d jsonServerData) updateBodyPatch(v string) string {
+func (d jsonServerData) updateBodyPatchBase() string {
 	return fmt.Sprintf(`
 provider "restful" {
   base_url = %q
@@ -653,8 +664,24 @@ provider "restful" {
 resource "restful_resource" "test" {
   path = "posts"
   body = {
-  	foo = %q
+  	foo = "bar"
   }
+  read_path = "$(path)/$(body.id)"
+}
+`, d.url)
+}
+func (d jsonServerData) updateBodyPatchUpdate() string {
+	return fmt.Sprintf(`
+provider "restful" {
+  base_url = %q
+}
+
+resource "restful_resource" "test" {
+  path = "posts"
+  body = {
+  	foo = "bar"
+  }
+  read_path = "$(path)/$(body.id)"
   update_body_patches = [
     {
 	  path = "addon.a"
@@ -664,10 +691,16 @@ resource "restful_resource" "test" {
 	  path = "addon.b"
 	  raw_json = "$(body.id)"
 	},
+	{
+	  path = "foo"
+	  removed = true
+	},
   ]
-  read_path = "$(path)/$(body.id)"
+  lifecycle {
+	ignore_changes = [body.foo]
+  }
 }
-`, d.url, v)
+`, d.url)
 }
 
 func (d jsonServerData) ephemeralBodyOverlap() string {