Add support for empty yang containers to gnmi resource

Author: danischm

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 0.4.0 (unreleased)
 
 - BREAKING CHANGE: Refactor resource import functionality to use a comma separated list of key attribute values instead of a gNMI path
+- Add support for empty YANG containers to the `iosxr_gnmi` resource using the `<EMPTY>` keyword
 
 ## 0.3.2
 

docs/guides/changelog.md

@@ -10,6 +10,7 @@ description: |-
 ## 0.4.0 (unreleased)
 
 - BREAKING CHANGE: Refactor resource import functionality to use a comma separated list of key attribute values instead of a gNMI path
+- Add support for empty YANG containers to the `iosxr_gnmi` resource using the `<EMPTY>` keyword
 
 ## 0.3.2
 

docs/resources/gnmi.md

@@ -65,7 +65,7 @@ resource "iosxr_gnmi" "domain_host" {
 
 ### Optional
 
-- `attributes` (Map of String) Map of key-value pairs which represents the attributes and its values.
+- `attributes` (Map of String) Map of key-value pairs which represents the attributes and its values. To indicate an empty YANG container use `<EMPTY>` as the value.
 - `delete` (Boolean) Delete object during destroy operation. Default value is `true`.
 - `device` (String) A device name from the provider configuration.
 - `lists` (Attributes List) YANG lists. (see [below for nested schema](#nestedatt--lists))
@@ -83,7 +83,7 @@ Required:
 
 Optional:
 
-- `items` (List of Map of String) List of maps of key-value pairs which represents the attributes and its values.
+- `items` (List of Map of String) List of maps of key-value pairs which represents the attributes and its values. To indicate an empty YANG container use `<EMPTY>` as the value.
 - `key` (String) YANG list key attribute(s). In case of multiple keys, those should be separated by a comma (`,`).
 - `values` (List of String) YANG leaf-list values.
 

internal/provider/model_iosxr_gnmi.go

@@ -25,10 +25,15 @@ import (
 	"github.com/CiscoDevNet/terraform-provider-iosxr/internal/provider/helpers"
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/tidwall/gjson"
 	"github.com/tidwall/sjson"
 )
 
+const (
+	EMPTY_TAG string = "<EMPTY>"
+)
+
 type Gnmi struct {
 	Device     types.String `tfsdk:"device"`
 	Id         types.String `tfsdk:"id"`
@@ -64,7 +69,12 @@ func (data Gnmi) toBody(ctx context.Context) string {
 
 	for attr, value := range attributes {
 		attr = strings.ReplaceAll(attr, "/", ".")
-		body, _ = sjson.Set(body, attr, value)
+		tflog.Debug(ctx, fmt.Sprintf("Setting attribute %s to %s", attr, value))
+		if value == EMPTY_TAG {
+			body, _ = sjson.Set(body, attr, map[string]interface{}{})
+		} else {
+			body, _ = sjson.Set(body, attr, value)
+		}
 	}
 
 	for i := range data.Lists {
@@ -77,7 +87,11 @@ func (data Gnmi) toBody(ctx context.Context) string {
 				attrs := ""
 				for attr, value := range listAttributes {
 					attr = strings.ReplaceAll(attr, "/", ".")
-					attrs, _ = sjson.Set(attrs, attr, value)
+					if value == EMPTY_TAG {
+						attrs, _ = sjson.Set(attrs, attr, map[string]interface{}{})
+					} else {
+						attrs, _ = sjson.Set(attrs, attr, value)
+					}
 				}
 				body, _ = sjson.SetRaw(body, listName+".-1", attrs)
 			}
@@ -107,10 +121,9 @@ func (data *Gnmi) fromBody(ctx context.Context, res []byte) diag.Diagnostics {
 	for attr := range attributes {
 		attrPath := strings.ReplaceAll(attr, "/", ".")
 		value := gjson.GetBytes(res, attrPath)
-		if !value.Exists() ||
-			(value.IsObject() && len(value.Map()) == 0) ||
-			value.Raw == "[null]" {
-
+		if value.IsObject() && len(value.Map()) == 0 {
+			attributes[attr] = types.StringValue(EMPTY_TAG)
+		} else if !value.Exists() || value.Raw == "[null]" {
 			if !helpers.Contains(keys, attr) {
 				attributes[attr] = types.StringValue("")
 			}
@@ -166,10 +179,9 @@ func (data *Gnmi) fromBody(ctx context.Context, res []byte) diag.Diagnostics {
 				for attr := range listAttributes {
 					attrPath := strings.ReplaceAll(attr, "/", ".")
 					value := r.Get(attrPath)
-					if !value.Exists() ||
-						(value.IsObject() && len(value.Map()) == 0) ||
-						value.Raw == "[null]" {
-
+					if value.IsObject() && len(value.Map()) == 0 {
+						listAttributes[attr] = types.StringValue(EMPTY_TAG)
+					} else if !value.Exists() || value.Raw == "[null]" {
 						listAttributes[attr] = types.StringValue("")
 					} else {
 						listAttributes[attr] = types.StringValue(value.String())

internal/provider/resource_iosxr_gnmi.go

@@ -79,7 +79,7 @@ func (r *GnmiResource) Schema(ctx context.Context, req resource.SchemaRequest, r
 				Default:             booldefault.StaticBool(true),
 			},
 			"attributes": schema.MapAttribute{
-				MarkdownDescription: "Map of key-value pairs which represents the attributes and its values.",
+				MarkdownDescription: "Map of key-value pairs which represents the attributes and its values. To indicate an empty YANG container use `<EMPTY>` as the value.",
 				Optional:            true,
 				ElementType:         types.StringType,
 			},
@@ -97,7 +97,7 @@ func (r *GnmiResource) Schema(ctx context.Context, req resource.SchemaRequest, r
 							Optional:            true,
 						},
 						"items": schema.ListAttribute{
-							MarkdownDescription: "List of maps of key-value pairs which represents the attributes and its values.",
+							MarkdownDescription: "List of maps of key-value pairs which represents the attributes and its values. To indicate an empty YANG container use `<EMPTY>` as the value.",
 							Optional:            true,
 							ElementType:         types.MapType{ElemType: types.StringType},
 						},

internal/provider/resource_iosxr_gnmi_test.go

@@ -70,6 +70,12 @@ func TestAccIosxrGnmi(t *testing.T) {
 					resource.TestCheckResourceAttr("iosxr_gnmi.test", "lists.0.values.0", "1.2.3.4"),
 				),
 			},
+			{
+				Config: testAccIosxrGnmiConfig_yangEmpty(),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("iosxr_gnmi.test", "attributes.redistribute/static", "<EMPTY>"),
+				),
+			},
 		},
 	})
 }
@@ -133,3 +139,15 @@ func testAccIosxrGnmiConfig_leafList() string {
 	}
 	`
 }
+
+func testAccIosxrGnmiConfig_yangEmpty() string {
+	return `
+	resource "iosxr_gnmi" "test" {
+		path = "Cisco-IOS-XR-um-router-bgp-cfg:/router/bgp/as[as-number=10]/address-families/address-family[af-name=ipv6-unicast]"
+		attributes = {
+			"af-name" = "ipv6-unicast"
+			"redistribute/static" = "<EMPTY>"
+		}
+	}
+	`
+}

templates/guides/changelog.md.tmpl

@@ -10,6 +10,7 @@ description: |-
 ## 0.4.0 (unreleased)
 
 - BREAKING CHANGE: Refactor resource import functionality to use a comma separated list of key attribute values instead of a gNMI path
+- Add support for empty YANG containers to the `iosxr_gnmi` resource using the `<EMPTY>` keyword
 
 ## 0.3.2