r/group_raw: add planmodifier on config to

remove blank lines in the value

Author: jeremmfr

internal/provider/resource_group_raw.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/jeremmfr/terraform-provider-junos/internal/junos"
 	"github.com/jeremmfr/terraform-provider-junos/internal/tfdiag"
+	"github.com/jeremmfr/terraform-provider-junos/internal/tfplanmodifier"
 	"github.com/jeremmfr/terraform-provider-junos/internal/tfvalidator"
 
 	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
@@ -97,6 +98,9 @@ func (rsc *groupRaw) Schema(
 			"config": schema.StringAttribute{
 				Required:    true,
 				Description: "The raw configuration to load.",
+				PlanModifiers: []planmodifier.String{
+					tfplanmodifier.StringRemoveBlankLines(),
+				},
 				Validators: []validator.String{
 					stringvalidator.LengthAtLeast(1),
 				},

internal/tfplanmodifier/string.go

@@ -2,8 +2,10 @@ package tfplanmodifier
 
 import (
 	"context"
+	"strings"
 
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
 // StringUseStateNullForUnknown returns a plan modifier that copies a null prior state
@@ -45,3 +47,50 @@ func (m stringUseStateNullForUnknownModifier) PlanModifyString(
 
 	resp.PlanValue = req.StateValue
 }
+
+// StringRemoveBlankLines returns a plan modifier that removes all blank lines
+// (empty lines and lines containing only whitespace) from multiline string values.
+func StringRemoveBlankLines() planmodifier.String {
+	return stringRemoveBlankLines{}
+}
+
+type stringRemoveBlankLines struct{}
+
+func (m stringRemoveBlankLines) Description(_ context.Context) string {
+	return "Removes blank lines (empty lines and lines containing only whitespace) from multiline strings."
+}
+
+func (m stringRemoveBlankLines) MarkdownDescription(_ context.Context) string {
+	return "Removes blank lines (empty lines and lines containing only whitespace) from multiline strings."
+}
+
+// PlanModifyString implements the plan modification logic.
+func (m stringRemoveBlankLines) PlanModifyString(
+	_ context.Context, req planmodifier.StringRequest, resp *planmodifier.StringResponse,
+) {
+	// Do nothing if there is a null planned value.
+	if req.PlanValue.IsNull() {
+		return
+	}
+
+	// Do nothing if there is an unknown planned value.
+	if req.PlanValue.IsUnknown() {
+		return
+	}
+
+	// Do nothing if value doesn't have multiple lines.
+	if !strings.Contains(req.PlanValue.ValueString(), "\n") {
+		return
+	}
+
+	newValue := strings.Builder{}
+	for item := range strings.SplitSeq(req.PlanValue.ValueString(), "\n") {
+		if strings.TrimSpace(item) == "" {
+			continue
+		}
+
+		_, _ = newValue.WriteString(item + "\n")
+	}
+
+	resp.PlanValue = types.StringValue(newValue.String())
+}

internal/tfplanmodifier/string_test.go

@@ -0,0 +1,118 @@
+package tfplanmodifier_test
+
+import (
+	"context"
+	"reflect"
+	"testing"
+
+	"github.com/jeremmfr/terraform-provider-junos/internal/tfplanmodifier"
+
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+func TestStringRemoveBlankLines(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		request  planmodifier.StringRequest
+		expected *planmodifier.StringResponse
+	}{
+		"null value": {
+			request: planmodifier.StringRequest{
+				PlanValue: types.StringNull(),
+			},
+			expected: &planmodifier.StringResponse{
+				PlanValue: types.StringNull(),
+			},
+		},
+		"unknown value": {
+			request: planmodifier.StringRequest{
+				PlanValue: types.StringUnknown(),
+			},
+			expected: &planmodifier.StringResponse{
+				PlanValue: types.StringUnknown(),
+			},
+		},
+		"single line without newline": {
+			request: planmodifier.StringRequest{
+				PlanValue: types.StringValue("single line"),
+			},
+			expected: &planmodifier.StringResponse{
+				PlanValue: types.StringValue("single line"),
+			},
+		},
+		"multiline with blank lines": {
+			request: planmodifier.StringRequest{
+				PlanValue: types.StringValue("line1\n\nline2\n\nline3\n"),
+			},
+			expected: &planmodifier.StringResponse{
+				PlanValue: types.StringValue("line1\nline2\nline3\n"),
+			},
+		},
+		"multiline with only spaces": {
+			request: planmodifier.StringRequest{
+				PlanValue: types.StringValue("line1\n     \nline2\n  \nline3\n"),
+			},
+			expected: &planmodifier.StringResponse{
+				PlanValue: types.StringValue("line1\nline2\nline3\n"),
+			},
+		},
+		"multiline with tabs and spaces": {
+			request: planmodifier.StringRequest{
+				PlanValue: types.StringValue("line1\n\t  \t\nline2\n  \t  \nline3\n"),
+			},
+			expected: &planmodifier.StringResponse{
+				PlanValue: types.StringValue("line1\nline2\nline3\n"),
+			},
+		},
+		"all blank lines": {
+			request: planmodifier.StringRequest{
+				PlanValue: types.StringValue("\n\n   \n\t\n"),
+			},
+			expected: &planmodifier.StringResponse{
+				PlanValue: types.StringValue(""),
+			},
+		},
+		"no blank lines": {
+			request: planmodifier.StringRequest{
+				PlanValue: types.StringValue("line1\nline2\nline3\n"),
+			},
+			expected: &planmodifier.StringResponse{
+				PlanValue: types.StringValue("line1\nline2\nline3\n"),
+			},
+		},
+		"preserve indentation": {
+			request: planmodifier.StringRequest{
+				PlanValue: types.StringValue("  line1\n\n    line2\n"),
+			},
+			expected: &planmodifier.StringResponse{
+				PlanValue: types.StringValue("  line1\n    line2\n"),
+			},
+		},
+		"empty string": {
+			request: planmodifier.StringRequest{
+				PlanValue: types.StringValue(""),
+			},
+			expected: &planmodifier.StringResponse{
+				PlanValue: types.StringValue(""),
+			},
+		},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			resp := &planmodifier.StringResponse{
+				PlanValue: testCase.request.PlanValue,
+			}
+
+			tfplanmodifier.StringRemoveBlankLines().PlanModifyString(context.Background(), testCase.request, resp)
+
+			if !reflect.DeepEqual(testCase.expected, resp) {
+				t.Errorf("unexpected StringResponse: want %#v, got %#v", testCase.expected, resp)
+			}
+		})
+	}
+}