[chore] [pkg/ottl] Introduce ctxutil.GetMap() and ctxutil.GetMapKeyName() internal functions (open-telemetry#39952)

These functions have been requested
[here](open-telemetry#39681 (comment))
and
[here](open-telemetry#39681 (comment))
as prerequisite for OTTL attributes accessors for the profiles signal.

Also adds tests for `GetMap()`, that were missing.

Unit tests

---------

Co-authored-by: Edmo Vamerlatti Costa <[email protected]>

Author: rockdaboot

pkg/ottl/contexts/internal/ctxutil/map.go

@@ -14,9 +14,13 @@ import (
 )
 
 func GetMapValue[K any](ctx context.Context, tCtx K, m pcommon.Map, keys []ottl.Key[K]) (any, error) {
-	s, err := GetMapKeyName(ctx, tCtx, keys)
+	if len(keys) == 0 {
+		return nil, errors.New("cannot get map value without keys")
+	}
+
+	s, err := GetMapKeyName(ctx, tCtx, keys[0])
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("cannot get map value: %w", err)
 	}
 
 	val, ok := m.Get(*s)
@@ -28,9 +32,13 @@ func GetMapValue[K any](ctx context.Context, tCtx K, m pcommon.Map, keys []ottl.
 }
 
 func SetMapValue[K any](ctx context.Context, tCtx K, m pcommon.Map, keys []ottl.Key[K], val any) error {
-	s, err := GetMapKeyName(ctx, tCtx, keys)
+	if len(keys) == 0 {
+		return errors.New("cannot set map value without keys")
+	}
+
+	s, err := GetMapKeyName(ctx, tCtx, keys[0])
 	if err != nil {
-		return err
+		return fmt.Errorf("cannot set map value: %w", err)
 	}
 
 	currentValue, ok := m.Get(*s)
@@ -40,17 +48,13 @@ func SetMapValue[K any](ctx context.Context, tCtx K, m pcommon.Map, keys []ottl.
 	return SetIndexableValue[K](ctx, tCtx, currentValue, val, keys[1:])
 }
 
-func GetMapKeyName[K any](ctx context.Context, tCtx K, keys []ottl.Key[K]) (*string, error) {
-	if len(keys) == 0 {
-		return nil, errors.New("empty keys")
-	}
-
-	resolvedKey, err := keys[0].String(ctx, tCtx)
+func GetMapKeyName[K any](ctx context.Context, tCtx K, key ottl.Key[K]) (*string, error) {
+	resolvedKey, err := key.String(ctx, tCtx)
 	if err != nil {
 		return nil, err
 	}
 	if resolvedKey == nil {
-		resolvedKey, err = FetchValueFromExpression[K, string](ctx, tCtx, keys[0])
+		resolvedKey, err = FetchValueFromExpression[K, string](ctx, tCtx, key)
 		if err != nil {
 			return nil, fmt.Errorf("unable to resolve a string index in map: %w", err)
 		}

pkg/ottl/contexts/internal/ctxutil/map_test.go

@@ -40,7 +40,7 @@ func Test_GetMapValue_Invalid(t *testing.T) {
 					G: getSetter,
 				},
 			},
-			err: errors.New("unable to resolve a string index in map: could not resolve key for map/slice, expecting 'string' but got '<nil>'"),
+			err: errors.New("cannot get map value: unable to resolve a string index in map: could not resolve key for map/slice, expecting 'string' but got '<nil>'"),
 		},
 		{
 			name: "index map with int",
@@ -172,7 +172,7 @@ func Test_SetMapValue_Invalid(t *testing.T) {
 					G: getSetter,
 				},
 			},
-			err: errors.New("unable to resolve a string index in map: could not resolve key for map/slice, expecting 'string' but got '<nil>'"),
+			err: errors.New("cannot set map value: unable to resolve a string index in map: could not resolve key for map/slice, expecting 'string' but got '<nil>'"),
 		},
 		{
 			name: "index map with int",
@@ -320,22 +320,26 @@ func Test_SetMap(t *testing.T) {
 		return m
 	}
 	tests := []struct {
-		name string
-		val  any
-		err  error
+		name     string
+		val      any
+		err      error
+		expected any
 	}{
 		{
-			name: "invalid type",
-			val:  "invalid",
-			err:  errors.New("failed to convert type string into pcommon.Map"),
+			name:     "invalid type",
+			val:      "invalid",
+			err:      nil, // This is an issue in SetMap(), not returning an error here.
+			expected: pcommon.NewMap(),
 		},
 		{
-			name: "raw map",
-			val:  map[string]any{"foo": "bar"},
+			name:     "raw map",
+			val:      map[string]any{"foo": "bar"},
+			expected: createMap(),
 		},
 		{
-			name: "pcommon.Map",
-			val:  createMap(),
+			name:     "pcommon.Map",
+			val:      createMap(),
+			expected: createMap(),
 		},
 	}
 
@@ -347,7 +351,7 @@ func Test_SetMap(t *testing.T) {
 				require.Equal(t, tt.err, err)
 				return
 			}
-			assert.Equal(t, m, createMap())
+			assert.Equal(t, tt.expected, m)
 		})
 	}
 }
@@ -403,11 +407,14 @@ func Test_GetMapKeyName(t *testing.T) {
 		key  string
 	}{
 		{
+<<<<<<< HEAD
 			name: "empty keys",
 			keys: []ottl.Key[any]{},
 			err:  errors.New("empty keys"),
 		},
 		{
+=======
+>>>>>>> ec280e51f8 ([chore] [pkg/ottl] Introduce `ctxutil.GetMap()` and `ctxutil.GetMapKeyName()` internal functions (#39952))
 			name: "first key not a string",
 			keys: []ottl.Key[any]{
 				&pathtest.Key[any]{
@@ -437,7 +444,11 @@ func Test_GetMapKeyName(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
+<<<<<<< HEAD
 			resolvedKey, err := ctxutil.GetMapKeyName[any](context.Background(), nil, tt.keys)
+=======
+			resolvedKey, err := ctxutil.GetMapKeyName[any](context.Background(), nil, tt.keys[0])
+>>>>>>> ec280e51f8 ([chore] [pkg/ottl] Introduce `ctxutil.GetMap()` and `ctxutil.GetMapKeyName()` internal functions (#39952))
 			if tt.err != nil {
 				assert.Equal(t, tt.err.Error(), err.Error())
 				return

pkg/ottl/contexts/internal/ctxutil/value.go

@@ -74,17 +74,10 @@ func getIndexableValue[K any](ctx context.Context, tCtx K, value pcommon.Value,
 	for index := 0; index < len(keys); index++ {
 		switch val.Type() {
 		case pcommon.ValueTypeMap:
-			s, err := keys[index].String(ctx, tCtx)
+			s, err := GetMapKeyName(ctx, tCtx, keys[index])
 			if err != nil {
 				return nil, err
 			}
-			if s == nil {
-				resString, err := FetchValueFromExpression[K, string](ctx, tCtx, keys[index])
-				if err != nil {
-					return nil, fmt.Errorf("unable to resolve a string index in map: %w", err)
-				}
-				s = resString
-			}
 			val, ok = val.Map().Get(*s)
 			if !ok {
 				return nil, nil
@@ -128,17 +121,10 @@ func SetIndexableValue[K any](ctx context.Context, tCtx K, currentValue pcommon.
 	for index := 0; index < len(keys); index++ {
 		switch currentValue.Type() {
 		case pcommon.ValueTypeMap:
-			s, err := keys[index].String(ctx, tCtx)
+			s, err := GetMapKeyName(ctx, tCtx, keys[index])
 			if err != nil {
 				return err
 			}
-			if s == nil {
-				resString, err := FetchValueFromExpression[K, string](ctx, tCtx, keys[index])
-				if err != nil {
-					return fmt.Errorf("unable to resolve a string index in map: %w", err)
-				}
-				s = resString
-			}
 			potentialValue, ok := currentValue.Map().Get(*s)
 			if !ok {
 				currentValue = currentValue.Map().PutEmpty(*s)