core: prevent side effects in Annotations.Merge

This commit updates the Annotations.Merge function to fix an issue where
the original Annotations map was unintentionally modified.
The new implementation creates a separate map to ensure
the original map remains unchanged during the merge process.

Signed-off-by: Oded Viner <oviner@redhat.com>
(cherry picked from commit f1d3e0d4c0)
This commit is contained in:
Oded Viner authored and Mergify committed 2024-12-04 17:30:42 +00:00
1 parent 7a6b64f04b
commit 7f6a942768
2 files changed
+15 -4

No files matched your search

+10 -4
View File
@@ -110,14 +110,20 @@ func (a Annotations) ApplyToObjectMeta(t *metav1.ObjectMeta) {
// original Annotations with the attributes of the supplied one. The supplied
// Annotation attributes will override the original ones if defined.
func (a Annotations) Merge(with map[string]string) Annotations {
ret := a
if ret == nil {
ret = map[string]string{}
// Create a new map of type Annotations to hold the merged results
ret := Annotations{}
// Copy the contents of the original map (a) into ret
for k, v := range a {
ret[k] = v
}
// Add entries from the 'with' map only if the key does not already exist
for k, v := range with {
if _, ok := ret[k]; !ok {
if _, exists := ret[k]; !exists {
ret[k] = v
}
}
return ret
}
@@ -62,6 +62,7 @@ func TestCephAnnotationsMerge(t *testing.T) {
"mgr": {"mgrkey": "mgrval"},
"cmdreporter": {"myversions": "detect"},
"crashcollector": {"crash": "crashval"},
"osd": {"osdkey": "osdval"},
}
a = GetMonAnnotations(testAnnotations)
assert.Equal(t, "allval1", a["allkey1"])
@@ -80,6 +81,10 @@ func TestCephAnnotationsMerge(t *testing.T) {
assert.Equal(t, "crashval", c["crash"])
assert.Equal(t, "allval1", c["allkey1"])
assert.Equal(t, "allval2", c["allkey2"])
d := GetOSDAnnotations(testAnnotations)
assert.Equal(t, "allval1", d["allkey1"])
assert.Equal(t, "allval2", d["allkey2"])
assert.Equal(t, "osdval", d["osdkey"])
}
func TestAnnotationsSpec(t *testing.T) {