Add helper for converting cty.Objects to string

Author: dbanck

internal/command/views/hook_ui.go

@@ -19,6 +19,7 @@ import (
 	"github.com/hashicorp/terraform/internal/plans"
 	"github.com/hashicorp/terraform/internal/providers"
 	"github.com/hashicorp/terraform/internal/terraform"
+	"github.com/hashicorp/terraform/internal/tfdiags"
 )
 
 // How long to wait between sending heartbeat/progress messages
@@ -327,7 +328,7 @@ func (h *UiHook) PrePlanImport(id terraform.HookResourceIdentity, importTarget c
 	if importTarget.Type().IsObjectType() {
 		h.println(fmt.Sprintf(
 			h.view.colorize.Color("[reset][bold]%s: Preparing import... [identity=%s]"),
-			id.Addr, importTarget.GoString(), // TODO improve
+			id.Addr, tfdiags.ObjectToString(importTarget),
 		))
 	} else {
 		h.println(fmt.Sprintf(

internal/terraform/node_resource_plan_instance.go

@@ -681,7 +681,7 @@ func (n *NodePlannableResourceInstance) importState(ctx EvalContext, addr addrs.
 	var importValue string
 	if importTarget.Type().IsObjectType() {
 		importType = "Identity"
-		importValue = importTarget.GoString() // TODO improve
+		importValue = tfdiags.ObjectToString(importTarget)
 	} else {
 		importValue = importTarget.AsString()
 	}

internal/tfdiags/object.go

@@ -0,0 +1,72 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+package tfdiags
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/zclconf/go-cty/cty"
+)
+
+// ObjectToString is a helper function that converts a go-cty object to a string representation
+func ObjectToString(obj cty.Value) string {
+	if obj.IsNull() {
+		return "<null>"
+	}
+
+	if !obj.IsKnown() {
+		return "<unknown>"
+	}
+
+	if obj.Type().IsObjectType() && len(obj.Type().AttributeTypes()) == 0 {
+		return "<empty>"
+	}
+
+	if obj.Type().IsObjectType() {
+		result := ""
+		it := obj.ElementIterator()
+		for it.Next() {
+			key, val := it.Element()
+			keyStr := key.AsString()
+
+			if result != "" {
+				result += ","
+			}
+
+			switch val.Type() {
+			case cty.Bool:
+				result += fmt.Sprintf("%s=%t", keyStr, val.True())
+			case cty.Number:
+				result += fmt.Sprintf("%s=%s", keyStr, val.AsBigFloat().String())
+			case cty.String:
+				result += fmt.Sprintf("%s=%s", keyStr, val.AsString())
+			case cty.List(cty.Bool):
+				elements := val.AsValueSlice()
+				parts := make([]string, len(elements))
+				for i, element := range elements {
+					parts[i] = fmt.Sprintf("%t", element.True())
+				}
+				result += fmt.Sprintf("%s=[%s]", keyStr, strings.Join(parts, ","))
+			case cty.List(cty.Number):
+				elements := val.AsValueSlice()
+				parts := make([]string, len(elements))
+				for i, element := range elements {
+					parts[i] = element.AsBigFloat().String()
+				}
+				result += fmt.Sprintf("%s=[%s]", keyStr, strings.Join(parts, ","))
+			case cty.List(cty.String):
+				elements := val.AsValueSlice()
+				parts := make([]string, len(elements))
+				for i, element := range elements {
+					parts[i] = element.AsString()
+				}
+				result += fmt.Sprintf("%s=[%s]", keyStr, strings.Join(parts, ","))
+			}
+		}
+
+		return result
+	}
+
+	panic("not an object")
+}

internal/tfdiags/object_test.go

@@ -0,0 +1,64 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+package tfdiags
+
+import (
+	"testing"
+
+	"github.com/zclconf/go-cty/cty"
+)
+
+func Test_ObjectToString(t *testing.T) {
+	testCases := []struct {
+		name     string
+		value    cty.Value
+		expected string
+	}{
+		{
+			name:     "null",
+			value:    cty.NullVal(cty.Object(map[string]cty.Type{})),
+			expected: "<null>",
+		},
+		{
+			name:     "unknown",
+			value:    cty.UnknownVal(cty.Object(map[string]cty.Type{})),
+			expected: "<unknown>",
+		},
+		{
+			name:     "empty",
+			value:    cty.EmptyObjectVal,
+			expected: "<empty>",
+		},
+		{
+			name: "primitive",
+			value: cty.ObjectVal(map[string]cty.Value{
+				"number": cty.NumberIntVal(42),
+				"string": cty.StringVal("hello"),
+				"bool":   cty.BoolVal(true),
+			}),
+			expected: "bool=true,number=42,string=hello",
+		},
+		{
+			name: "list",
+			value: cty.ObjectVal(map[string]cty.Value{
+				"string": cty.StringVal("hello"),
+				"list": cty.ListVal([]cty.Value{
+					cty.StringVal("a"),
+					cty.StringVal("b"),
+					cty.StringVal("c"),
+				}),
+			}),
+			expected: "list=[a,b,c],string=hello",
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			actual := ObjectToString(tc.value)
+
+			if actual != tc.expected {
+				t.Errorf("expected %q, got %q", tc.expected, actual)
+			}
+		})
+	}
+}