[internal/core]: Introduce OrderMapByKey() function

Signed-off-by: odubajDT <ondrej.dubaj@dynatrace.com>

.chloggen/order-map.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: internal/core
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Introduce new OrderMapByKey() function to order maps depending on their keys.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [34297]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []

internal/common/maps/maps.go

@@ -3,6 +3,8 @@
 
 package maps // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/common/maps"
 
+import "sort"
+
 // MergeRawMaps merges n maps with a later map's keys overriding earlier maps.
 func MergeRawMaps(maps ...map[string]any) map[string]any {
 	ret := map[string]any{}
@@ -37,3 +39,22 @@ func CloneStringMap(m map[string]string) map[string]string {
 	}
 	return m2
 }
+
+func OrderMapByKey[K any](input map[string]K) map[string]K {
+	// Create a slice to hold the keys
+	keys := make([]string, 0, len(input))
+	for k := range input {
+		keys = append(keys, k)
+	}
+
+	// Sort the keys
+	sort.Strings(keys)
+
+	// Create a new map to hold the sorted key-value pairs
+	orderedMap := make(map[string]K, len(input))
+	for _, k := range keys {
+		orderedMap[k] = input[k]
+	}
+
+	return orderedMap
+}

internal/common/maps/maps_test.go

@@ -39,3 +39,25 @@ func TestCloneStringMap(t *testing.T) {
 
 	require.Equal(t, expected, actual)
 }
+
+func TestOrderMapByKey(t *testing.T) {
+	ordered := map[string]string{
+		"a": "val-1",
+		"b": "val-2",
+		"c": "val-3",
+		"d": "val-4",
+		"e": "val-5",
+	}
+
+	require.Equal(t, ordered, OrderMapByKey(ordered))
+
+	unordered := map[string]string{
+		"e": "val-5",
+		"a": "val-1",
+		"c": "val-3",
+		"d": "val-4",
+		"b": "val-2",
+	}
+
+	require.Equal(t, ordered, OrderMapByKey(unordered))
+}