passing tests

Signed-off-by: J. Harte <[email protected]>

Author: boonware

pkg/k8s/object/builders/agent/secrets/config_merger.go

@@ -0,0 +1,83 @@
+/*
+(c) Copyright IBM Corp. 2024
+*/
+
+package secrets
+
+import (
+	"context"
+	"fmt"
+	"reflect"
+
+	"github.com/go-logr/logr"
+	"gopkg.in/yaml.v3"
+	apiV1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	v1 "k8s.io/client-go/kubernetes/typed/core/v1"
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
+)
+
+const ConfigMapLabel = "instana.io/agent-config=true"
+
+type ConfigMerger struct {
+	logger    logr.Logger
+	k8sClient v1.CoreV1Interface
+}
+
+func NewConfigMergerBuilder(client v1.CoreV1Interface) *ConfigMerger {
+	return &ConfigMerger{
+		logger:    logf.Log.WithName("instana-agent-config-merger"),
+		k8sClient: client,
+	}
+}
+
+func (c *ConfigMerger) MergeConfigurationYaml(agentConfiguration string) []byte {
+	operator_data := make(map[string]interface{})
+	err := yaml.Unmarshal([]byte([]byte(agentConfiguration)), operator_data)
+	config := []byte{}
+	if err != nil {
+		c.logger.Error(err, "Failed to load agent configuration")
+	} else {
+		config_maps := c.fetchConfigMaps()
+		for _, config_map := range config_maps {
+			config_map_data := make(map[string]interface{})
+			err := yaml.Unmarshal([]byte(config_map.Data["configuration_yaml"]), &config_map_data)
+			if err != nil {
+				c.logger.Error(err, "Failed to parse agent configuration YAML")
+			} else {
+				operator_data = c.mergeConfig(operator_data, config_map_data)
+			}
+		}
+		config, err = yaml.Marshal(operator_data)
+	}
+	return config
+}
+
+func (c *ConfigMerger) mergeConfig(operator_data, config_map_data map[string]interface{}) map[string]interface{} {
+	for key, cm_value := range config_map_data {
+		if op_value, ok := operator_data[key]; ok {
+			op_value_kind := reflect.TypeOf(op_value).Kind()
+			if op_value_kind == reflect.Array || op_value_kind == reflect.Slice {
+				operator_data[key] = append(op_value.([]interface{}), cm_value.([]interface{})...)
+			} else {
+				c.mergeConfig(operator_data[key].(map[string]interface{}), cm_value.(map[string]interface{}))
+			}
+		} else {
+			operator_data[key] = cm_value
+		}
+	}
+	return operator_data
+}
+
+func (c *ConfigMerger) fetchConfigMaps() []apiV1.ConfigMap {
+	config_maps := []apiV1.ConfigMap{}
+	c.logger.Info(fmt.Sprintf("Fetching agent configmaps with label '%s'", ConfigMapLabel))
+	config_map_list, err := c.k8sClient.ConfigMaps("").List(context.TODO(), metav1.ListOptions{LabelSelector: ConfigMapLabel})
+	if err != nil {
+		c.logger.Error(err, fmt.Sprintf("Failed to fetch agent configmaps with label '%s'", ConfigMapLabel))
+	} else {
+		config_maps = config_map_list.Items
+		c.logger.Info(fmt.Sprintf("Found %d configmaps with label '%s'", len(config_maps), ConfigMapLabel))
+	}
+	return config_maps
+}

pkg/k8s/object/builders/agent/secrets/config_merger_test.go

@@ -0,0 +1,133 @@
+/*
+(c) Copyright IBM Corp. 2024
+*/
+
+package secrets
+
+import (
+	"context"
+	"errors"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/mock"
+	apiV1 "k8s.io/api/core/v1"
+	metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	coreV1 "k8s.io/client-go/kubernetes/typed/core/v1"
+)
+
+type CoreV1Mock struct {
+	coreV1.CoreV1Interface
+	mock.Mock
+}
+
+type ConfigMapMock struct {
+	coreV1.ConfigMapInterface
+	mock.Mock
+}
+
+func (mock *CoreV1Mock) ConfigMaps(namespace string) coreV1.ConfigMapInterface {
+	args := mock.Called()
+	return args.Get(0).(*ConfigMapMock)
+}
+
+func (mock *ConfigMapMock) List(ctx context.Context, opts metaV1.ListOptions) (*apiV1.ConfigMapList, error) {
+	args := mock.Called()
+	return args.Get(0).(*apiV1.ConfigMapList), nil
+}
+
+func TestMergeConfigurationYamlWithNoConfigMaps(t *testing.T) {
+	client := new(CoreV1Mock)
+	configMaps := new(ConfigMapMock)
+	client.On("ConfigMaps").Return(configMaps).Once()
+	configMapsList := new(apiV1.ConfigMapList)
+	configMapsList.Items = []apiV1.ConfigMap{}
+	configMaps.On("List").Return(configMapsList).Once()
+
+	merger := NewConfigMergerBuilder(client)
+	config_bytes := merger.MergeConfigurationYaml("c: d\n")
+
+	assert.Equal(t, "c: d\n", string(config_bytes))
+}
+
+func TestMergeConfigurationYamlWithOtherConfigMapData(t *testing.T) {
+	client := new(CoreV1Mock)
+	configMaps := new(ConfigMapMock)
+	client.On("ConfigMaps").Return(configMaps).Once()
+	configMapsList := new(apiV1.ConfigMapList)
+	configMapsList.Items = []apiV1.ConfigMap{{Data: map[string]string{"a": "b"}}}
+	configMaps.On("List").Return(configMapsList).Once()
+
+	merger := NewConfigMergerBuilder(client)
+	config_bytes := merger.MergeConfigurationYaml("c: d\n")
+
+	assert.Equal(t, "c: d\n", string(config_bytes))
+}
+
+func TestMergeConfigurationYamlWithEmptyConfigMapData(t *testing.T) {
+	client := new(CoreV1Mock)
+	configMaps := new(ConfigMapMock)
+	client.On("ConfigMaps").Return(configMaps).Once()
+	configMapsList := new(apiV1.ConfigMapList)
+	configMapsList.Items = []apiV1.ConfigMap{{Data: map[string]string{"configuration_yaml": ""}}}
+	configMaps.On("List").Return(configMapsList).Once()
+
+	merger := NewConfigMergerBuilder(client)
+	config_bytes := merger.MergeConfigurationYaml("c: d\n")
+
+	assert.Equal(t, "c: d\n", string(config_bytes))
+}
+
+func TestMergeConfigurationYamlWithNewTopLevelKey(t *testing.T) {
+	client := new(CoreV1Mock)
+	configMaps := new(ConfigMapMock)
+	client.On("ConfigMaps").Return(configMaps).Once()
+	configMapsList := new(apiV1.ConfigMapList)
+	configMapsList.Items = []apiV1.ConfigMap{{Data: map[string]string{"configuration_yaml": "a:\n b:\n  - 1\n"}}}
+	configMaps.On("List").Return(configMapsList).Once()
+
+	merger := NewConfigMergerBuilder(client)
+	config_bytes := merger.MergeConfigurationYaml("c: d\n")
+
+	assert.Equal(t, "a:\n    b:\n        - 1\nc: d\n", string(config_bytes))
+}
+
+func TestMergeConfigurationYamlWithNewListItem(t *testing.T) {
+	client := new(CoreV1Mock)
+	configMaps := new(ConfigMapMock)
+	client.On("ConfigMaps").Return(configMaps).Once()
+	configMapsList := new(apiV1.ConfigMapList)
+	configMapsList.Items = []apiV1.ConfigMap{{Data: map[string]string{"configuration_yaml": "a:\n b:\n  - 2\n"}}}
+	configMaps.On("List").Return(configMapsList).Once()
+
+	merger := NewConfigMergerBuilder(client)
+	config_bytes := merger.MergeConfigurationYaml("a:\n b:\n  - 1\nc: d\n")
+
+	assert.Equal(t, "a:\n    b:\n        - 1\n        - 2\nc: d\n", string(config_bytes))
+}
+
+func TestMergeConfigurationYamlWithMultipleNewListItems(t *testing.T) {
+	client := new(CoreV1Mock)
+	configMaps := new(ConfigMapMock)
+	client.On("ConfigMaps").Return(configMaps).Once()
+	configMapsList := new(apiV1.ConfigMapList)
+	configMapsList.Items = []apiV1.ConfigMap{{Data: map[string]string{"configuration_yaml": "a:\n b:\n  - 2\n  - 3\n"}}}
+	configMaps.On("List").Return(configMapsList).Once()
+
+	merger := NewConfigMergerBuilder(client)
+	config_bytes := merger.MergeConfigurationYaml("a:\n b:\n  - 1\nc: d\n")
+
+	assert.Equal(t, "a:\n    b:\n        - 1\n        - 2\n        - 3\nc: d\n", string(config_bytes))
+}
+
+func TestMergeConfigurationYamlForFailedRetrieval(t *testing.T) {
+	client := new(CoreV1Mock)
+	configMaps := new(ConfigMapMock)
+	client.On("ConfigMaps").Return(configMaps).Once()
+	configMaps.On("List").Return(&apiV1.ConfigMapList{}, errors.New("Failed")).Once()
+
+	merger := NewConfigMergerBuilder(client)
+	config_bytes := merger.MergeConfigurationYaml("a:\n b:\n  - 1\nc: d\n")
+
+	assert.Equal(t, "a:\n    b:\n        - 1\nc: d\n", string(config_bytes))
+}