From cf20e0919004fe2625ab651e5c15a852d5726946 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jacob=20L=C3=A4rfors?=
 <1135394+jlarfors@users.noreply.github.com>
Date: Wed, 17 Apr 2024 12:02:04 +0300
Subject: [PATCH] hcl encoding should skip nil pointer values

---
 pkg/internal/hcl/encode.go      | 24 ++++++++++++++++++------
 pkg/internal/hcl/encode_test.go | 13 +++++++++++++
 2 files changed, 31 insertions(+), 6 deletions(-)

diff --git a/pkg/internal/hcl/encode.go b/pkg/internal/hcl/encode.go
index 51b92fb..d749a0c 100644
--- a/pkg/internal/hcl/encode.go
+++ b/pkg/internal/hcl/encode.go
@@ -76,7 +76,9 @@ func Encode(wr io.Writer, args EncodeArgs) error {
 
 	// Encode provider blocks
 	if len(args.Providers) > 0 {
-		fileBody.AppendUnstructuredTokens(hclwrite.TokensForIdentifier("// Provider blocks"))
+		fileBody.AppendUnstructuredTokens(
+			hclwrite.TokensForIdentifier("// Provider blocks"),
+		)
 		fileBody.AppendNewline()
 	}
 	for _, provider := range args.Providers {
@@ -100,7 +102,9 @@ func Encode(wr io.Writer, args EncodeArgs) error {
 	}
 	// Encode data blocks
 	if len(args.DataSources) > 0 {
-		fileBody.AppendUnstructuredTokens(hclwrite.TokensForIdentifier("// Data blocks"))
+		fileBody.AppendUnstructuredTokens(
+			hclwrite.TokensForIdentifier("// Data blocks"),
+		)
 		fileBody.AppendNewline()
 	}
 	for _, data := range args.DataSources {
@@ -125,7 +129,9 @@ func Encode(wr io.Writer, args EncodeArgs) error {
 	}
 	// Encode resource blocks
 	if len(args.Resources) > 0 {
-		fileBody.AppendUnstructuredTokens(hclwrite.TokensForIdentifier("// Resource blocks"))
+		fileBody.AppendUnstructuredTokens(
+			hclwrite.TokensForIdentifier("// Resource blocks"),
+		)
 		fileBody.AppendNewline()
 	}
 	for _, resource := range args.Resources {
@@ -252,6 +258,10 @@ func encodeStruct(
 					body.SetAttributeRaw(tagName, tokens)
 				}
 			default:
+				// If the field is a nil pointer, we do not want to render it.
+				if fv.Kind() == reflect.Ptr && fv.IsNil() {
+					continue
+				}
 				if fv.CanInterface() && fv.Interface() != nil {
 					ctyVal, err := impliedCtyValue(fv)
 					if err != nil {
@@ -293,11 +303,13 @@ func encodeStruct(
 	}
 
 	if len(labels) > 0 {
-		// When working against the top-level Go struct, no HCL block exists, so `hcl:",label"` tags
-		// are not allowed here.
+		// When working against the top-level Go struct, no HCL block exists, so
+		// `hcl:",label"` tags are not allowed here.
 		// Only on the root Go struct is the block nil.
 		if block == nil {
-			return fmt.Errorf("cannot set hcl label tag on struct without a block")
+			return fmt.Errorf(
+				"cannot set hcl label tag on struct without a block",
+			)
 		}
 		block.SetLabels(labels)
 	}
diff --git a/pkg/internal/hcl/encode_test.go b/pkg/internal/hcl/encode_test.go
index bff897c..79c7f96 100644
--- a/pkg/internal/hcl/encode_test.go
+++ b/pkg/internal/hcl/encode_test.go
@@ -5,10 +5,12 @@ package hcl
 
 import (
 	"bytes"
+	"reflect"
 	"testing"
 
 	tu "github.com/golingon/lingon/pkg/testutil"
 	"github.com/hashicorp/hcl/v2/hclsimple"
+	"github.com/hashicorp/hcl/v2/hclwrite"
 )
 
 type TerraformBlock struct {
@@ -228,3 +230,14 @@ func TestEncodeRaw(t *testing.T) {
 		t.Error(tu.Callers(), diff)
 	}
 }
+
+func TestEncode_StructWithNil(t *testing.T) {
+	type StructWithNil struct {
+		ShouldBeNil *string `hcl:"should_be_nil"`
+	}
+	block := hclwrite.NewBlock("block", nil)
+	err := encodeStruct(reflect.ValueOf(StructWithNil{}), block, block.Body())
+	tu.AssertNoError(t, err)
+
+	tu.AssertEqual(t, len(block.Body().Attributes()), 0)
+}