CLOUDP-350407: refactor translate - improve unstructured tests

Author: josvazg

internal/autogen/translate/unstructured/unstructured.go

@@ -26,6 +26,8 @@ import (
 
 var ErrNotFound = errors.New("not found")
 
+var ErrNilObject = errors.New("nil object")
+
 // ToUnstructured returns an unstructured map holding the public field values
 // from the original input obj value
 func ToUnstructured(obj any) (map[string]any, error) {
@@ -56,6 +58,9 @@ func FromUnstructured[T any](target *T, source map[string]any) error {
 // AccessField gets the value of a named path within the given unstructured map
 func AccessField[T any](obj map[string]any, fields ...string) (T, error) {
 	var zeroValue T
+	if obj == nil {
+		return zeroValue, ErrNilObject
+	}
 	rawValue, ok, err := unstructured.NestedFieldNoCopy(obj, fields...)
 	if !ok {
 		return zeroValue, fmt.Errorf("path %v %w", fields, ErrNotFound)
@@ -80,7 +85,7 @@ func CreateField[T any](obj map[string]any, value T, fields ...string) error {
 		if rawNext, exists := current[fields[i]]; exists {
 			next, typeOk := rawNext.(map[string]any)
 			if !typeOk {
-				return fmt.Errorf("intermediate path %v exists but is of type %T", path, next)
+				return fmt.Errorf("intermediate path %v exists but is of type %T", path, rawNext)
 			}
 			current = next
 		} else {

internal/autogen/translate/unstructured/unstructured_test.go

@@ -207,3 +207,60 @@ func TestSkipKeysAndFieldsOf(t *testing.T) {
 		})
 	}
 }
+
+func TestAccessOrCreateField(t *testing.T) {
+	for _, tc := range []struct {
+		title        string
+		obj          map[string]any
+		path         []string
+		defaultValue any
+		want         any
+		wantErr      string
+	}{
+		{
+			title:        "create missing",
+			obj:          map[string]any{},
+			path:         []string{"deep", "field"},
+			defaultValue: "some string",
+			want:         "some string",
+		},
+		{
+			title: "read existing",
+			obj: map[string]any{
+				"deep": map[string]any{
+					"field": "other string",
+				},
+			},
+			path:         []string{"deep", "field"},
+			defaultValue: "some string",
+			want:         "other string",
+		},
+		{
+			title:        "nil object",
+			obj:          nil,
+			path:         []string{"deep", "field"},
+			defaultValue: "some string",
+			wantErr:      "nil object",
+		},
+		{
+			title: "wrong path type",
+			obj: map[string]any{
+				"deep": "an string",
+			},
+			path:         []string{"deep", "field"},
+			defaultValue: "some string",
+			wantErr:      "intermediate path [deep] exists but is of type string",
+		},
+	} {
+		t.Run(tc.title, func(t *testing.T) {
+			got, err := unstructured.AccessOrCreateField(tc.obj, tc.defaultValue, tc.path...)
+			if tc.wantErr != "" {
+				require.Nil(t, got)
+				assert.ErrorContains(t, err, tc.wantErr)
+			} else {
+				require.NoError(t, err)
+				assert.Equal(t, tc.want, got)
+			}
+		})
+	}
+}