Rename configparser package to configmap

Signed-off-by: Bogdan Drutu <[email protected]>

Author: bogdandrutu

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 🛑 Breaking changes 🛑
+- 
+- Rename `configparser` package to `configmap` (#4075)
+
 ## v0.36.0 Beta
 
 ## 🛑 Breaking changes 🛑

config/config.go

@@ -20,7 +20,7 @@ import (
 
 	"go.uber.org/zap/zapcore"
 
-	"go.opentelemetry.io/collector/config/configparser"
+	"go.opentelemetry.io/collector/config/configmap"
 )
 
 var (
@@ -206,7 +206,7 @@ type Unmarshallable interface {
 	// Unmarshal is a function that un-marshals a Parser into the unmarshable struct in a custom way.
 	// componentSection *Parser
 	//   The config for this specific component. May be nil or empty if no config available.
-	Unmarshal(componentSection *configparser.ConfigMap) error
+	Unmarshal(componentSection *configmap.ConfigMap) error
 }
 
 // DataType is the data type that is supported for collection. We currently support

config/configparser/parser.go renamed to config/configmap/configmap.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package configparser
+package configmap
 
 import (
 	"fmt"
@@ -73,7 +73,8 @@ func NewConfigMapFromStringMap(data map[string]interface{}) *ConfigMap {
 	return p
 }
 
-// ConfigMap loads configuration.
+// ConfigMap represents the raw configuration map for the OpenTelemetry Collector.
+// The ConfigMap can be unmarshalled into the Collector's config using the "configunmarshaler" package.
 type ConfigMap struct {
 	k *koanf.Koanf
 }

config/configparser/parser_test.go renamed to config/configmap/configmap_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package configparser
+package configmap
 
 import (
 	"testing"

config/configmap/doc.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Package configmap defines the configuration map and the map providers for
+// the OpenTelemetry Collector.
+package configmap

config/configparser/testdata/basic_types.yaml renamed to config/configmap/testdata/basic_types.yaml

@@ -22,7 +22,7 @@ import (
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config"
-	"go.opentelemetry.io/collector/config/configparser"
+	"go.opentelemetry.io/collector/config/configmap"
 	"go.opentelemetry.io/collector/config/configunmarshaler"
 	"go.opentelemetry.io/collector/consumer/consumererror"
 )
@@ -33,7 +33,7 @@ var configFieldTagRegExp = regexp.MustCompile("^[a-z0-9][a-z0-9_]*$")
 // LoadConfig loads a config from file, and does NOT validate the configuration.
 func LoadConfig(fileName string, factories component.Factories) (*config.Config, error) {
 	// Read yaml config from file
-	cp, err := configparser.NewConfigMapFromFile(fileName)
+	cp, err := configmap.NewConfigMapFromFile(fileName)
 	if err != nil {
 		return nil, err
 	}

config/configparser/testdata/config.yaml renamed to config/configmap/testdata/config.yaml

@@ -23,7 +23,7 @@ import (
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config"
-	"go.opentelemetry.io/collector/config/configparser"
+	"go.opentelemetry.io/collector/config/configmap"
 )
 
 // These are errors that can be returned by Unmarshal(). Note that error codes are not part
@@ -111,7 +111,7 @@ func NewDefault() ConfigUnmarshaler {
 
 // Unmarshal the Config from a Parser.
 // After the config is unmarshaled, `Validate()` must be called to validate.
-func (*defaultUnmarshaler) Unmarshal(v *configparser.ConfigMap, factories component.Factories) (*config.Config, error) {
+func (*defaultUnmarshaler) Unmarshal(v *configmap.ConfigMap, factories component.Factories) (*config.Config, error) {
 	var cfg config.Config
 
 	// Unmarshal the config.
@@ -209,7 +209,7 @@ func unmarshalExtensions(exts map[string]map[string]interface{}, factories map[c
 
 	// Iterate over extensions and create a config for each.
 	for key, value := range exts {
-		componentConfig := configparser.NewConfigMapFromStringMap(value)
+		componentConfig := configmap.NewConfigMapFromStringMap(value)
 		expandEnvConfig(componentConfig)
 
 		// Decode the key into type and fullName components.
@@ -280,7 +280,7 @@ func unmarshalService(rawService serviceSettings) (config.Service, error) {
 }
 
 // LoadReceiver loads a receiver config from componentConfig using the provided factories.
-func LoadReceiver(componentConfig *configparser.ConfigMap, id config.ComponentID, factory component.ReceiverFactory) (config.Receiver, error) {
+func LoadReceiver(componentConfig *configmap.ConfigMap, id config.ComponentID, factory component.ReceiverFactory) (config.Receiver, error) {
 	// Create the default config for this receiver.
 	receiverCfg := factory.CreateDefaultConfig()
 	receiverCfg.SetIDName(id.Name())
@@ -301,7 +301,7 @@ func unmarshalReceivers(recvs map[string]map[string]interface{}, factories map[c
 
 	// Iterate over input map and create a config for each.
 	for key, value := range recvs {
-		componentConfig := configparser.NewConfigMapFromStringMap(value)
+		componentConfig := configmap.NewConfigMapFromStringMap(value)
 		expandEnvConfig(componentConfig)
 
 		// Decode the key into type and fullName components.
@@ -338,7 +338,7 @@ func unmarshalExporters(exps map[string]map[string]interface{}, factories map[co
 
 	// Iterate over Exporters and create a config for each.
 	for key, value := range exps {
-		componentConfig := configparser.NewConfigMapFromStringMap(value)
+		componentConfig := configmap.NewConfigMapFromStringMap(value)
 		expandEnvConfig(componentConfig)
 
 		// Decode the key into type and fullName components.
@@ -380,7 +380,7 @@ func unmarshalProcessors(procs map[string]map[string]interface{}, factories map[
 
 	// Iterate over processors and create a config for each.
 	for key, value := range procs {
-		componentConfig := configparser.NewConfigMapFromStringMap(value)
+		componentConfig := configmap.NewConfigMapFromStringMap(value)
 		expandEnvConfig(componentConfig)
 
 		// Decode the key into type and fullName components.
@@ -475,9 +475,9 @@ func parseIDNames(pipelineID config.ComponentID, componentType string, names []s
 	return ret, nil
 }
 
-// expandEnvConfig updates a configparser.ConfigMap with expanded values for all the values (simple, list or map value).
+// expandEnvConfig updates a configmap.ConfigMap with expanded values for all the values (simple, list or map value).
 // It does not expand the keys.
-func expandEnvConfig(v *configparser.ConfigMap) {
+func expandEnvConfig(v *configmap.ConfigMap) {
 	for _, k := range v.AllKeys() {
 		v.Set(k, expandStringValues(v.Get(k)))
 	}
@@ -568,7 +568,7 @@ func expandEnv(s string) string {
 	})
 }
 
-func unmarshal(componentSection *configparser.ConfigMap, intoCfg interface{}) error {
+func unmarshal(componentSection *configmap.ConfigMap, intoCfg interface{}) error {
 	if cu, ok := intoCfg.(config.Unmarshallable); ok {
 		return cu.Unmarshal(componentSection)
 	}

config/configparser/testdata/embedded_keys.yaml renamed to config/configmap/testdata/embedded_keys.yaml

@@ -25,8 +25,8 @@ import (
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config"
+	"go.opentelemetry.io/collector/config/configmap"
 	"go.opentelemetry.io/collector/config/confignet"
-	"go.opentelemetry.io/collector/config/configparser"
 	"go.opentelemetry.io/collector/internal/testcomponents"
 )
 
@@ -462,10 +462,10 @@ func TestLoadEmptyAllSections(t *testing.T) {
 }
 
 func loadConfigFile(t *testing.T, fileName string, factories component.Factories) (*config.Config, error) {
-	v, err := configparser.NewConfigMapFromFile(fileName)
+	v, err := configmap.NewConfigMapFromFile(fileName)
 	require.NoError(t, err)
 
-	// Unmarshal the config from the configparser.ConfigMap using the given factories.
+	// Unmarshal the config from the configmap.ConfigMap using the given factories.
 	return NewDefault().Unmarshal(v, factories)
 }
 

config/configtest/configtest.go

@@ -17,11 +17,11 @@ package configunmarshaler
 import (
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config"
-	"go.opentelemetry.io/collector/config/configparser"
+	"go.opentelemetry.io/collector/config/configmap"
 )
 
-// ConfigUnmarshaler is the interface that unmarshalls the collector configuration from the configparser.ConfigMap.
+// ConfigUnmarshaler is the interface that unmarshalls the collector configuration from the configmap.ConfigMap.
 type ConfigUnmarshaler interface {
 	// Unmarshal the configuration from the given parser and factories.
-	Unmarshal(v *configparser.ConfigMap, factories component.Factories) (*config.Config, error)
+	Unmarshal(v *configmap.ConfigMap, factories component.Factories) (*config.Config, error)
 }

config/configunmarshaler/defaultunmarshaler.go

@@ -26,7 +26,7 @@ import (
 
 	"gopkg.in/yaml.v2"
 
-	"go.opentelemetry.io/collector/config/configparser"
+	"go.opentelemetry.io/collector/config/configmap"
 	"go.opentelemetry.io/collector/config/experimental/configsource"
 	"go.opentelemetry.io/collector/consumer/consumererror"
 )
@@ -173,7 +173,7 @@ type Manager struct {
 // NewManager creates a new instance of a Manager to be used to inject data from
 // ConfigSource objects into a configuration and watch for updates on the injected
 // data.
-func NewManager(_ *configparser.ConfigMap) (*Manager, error) {
+func NewManager(_ *configmap.ConfigMap) (*Manager, error) {
 	// TODO: Config sources should be extracted for the config itself, need Factories for that.
 
 	return &Manager{
@@ -185,8 +185,8 @@ func NewManager(_ *configparser.ConfigMap) (*Manager, error) {
 // Resolve inspects the given config.Parser and resolves all config sources referenced
 // in the configuration, returning a config.Parser fully resolved. This must be called only
 // once per lifetime of a Manager object.
-func (m *Manager) Resolve(ctx context.Context, parser *configparser.ConfigMap) (*configparser.ConfigMap, error) {
-	res := configparser.NewConfigMap()
+func (m *Manager) Resolve(ctx context.Context, parser *configmap.ConfigMap) (*configmap.ConfigMap, error) {
+	res := configmap.NewConfigMap()
 	allKeys := parser.AllKeys()
 	for _, k := range allKeys {
 		value, err := m.expandStringValues(ctx, parser.Get(k))
@@ -467,8 +467,8 @@ func parseCfgSrc(s string) (cfgSrcName, selector string, params interface{}, err
 		selector = strings.Trim(parts[0], " ")
 
 		if len(parts) > 1 && len(parts[1]) > 0 {
-			var cp *configparser.ConfigMap
-			cp, err = configparser.NewConfigMapFromBuffer(bytes.NewReader([]byte(parts[1])))
+			var cp *configmap.ConfigMap
+			cp, err = configmap.NewConfigMapFromBuffer(bytes.NewReader([]byte(parts[1])))
 			if err != nil {
 				return
 			}

config/configunmarshaler/defaultunmarshaler_test.go

@@ -25,7 +25,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"go.opentelemetry.io/collector/config/configparser"
+	"go.opentelemetry.io/collector/config/configmap"
 	"go.opentelemetry.io/collector/config/experimental/configsource"
 )
 
@@ -54,7 +54,7 @@ func TestConfigSourceManager_Simple(t *testing.T) {
 		},
 	}
 
-	cp := configparser.NewConfigMapFromStringMap(originalCfg)
+	cp := configmap.NewConfigMapFromStringMap(originalCfg)
 
 	actualParser, err := manager.Resolve(ctx, cp)
 	require.NoError(t, err)
@@ -107,7 +107,7 @@ func TestConfigSourceManager_ResolveErrors(t *testing.T) {
 			require.NoError(t, err)
 			manager.configSources = tt.configSourceMap
 
-			res, err := manager.Resolve(ctx, configparser.NewConfigMapFromStringMap(tt.config))
+			res, err := manager.Resolve(ctx, configmap.NewConfigMapFromStringMap(tt.config))
 			require.Error(t, err)
 			require.Nil(t, res)
 			require.NoError(t, manager.Close(ctx))
@@ -131,11 +131,11 @@ func TestConfigSourceManager_ArraysAndMaps(t *testing.T) {
 	}
 
 	file := path.Join("testdata", "arrays_and_maps.yaml")
-	cp, err := configparser.NewConfigMapFromFile(file)
+	cp, err := configmap.NewConfigMapFromFile(file)
 	require.NoError(t, err)
 
 	expectedFile := path.Join("testdata", "arrays_and_maps_expected.yaml")
-	expectedParser, err := configparser.NewConfigMapFromFile(expectedFile)
+	expectedParser, err := configmap.NewConfigMapFromFile(expectedFile)
 	require.NoError(t, err)
 
 	actualParser, err := manager.Resolve(ctx, cp)
@@ -183,11 +183,11 @@ func TestConfigSourceManager_ParamsHandling(t *testing.T) {
 	}
 
 	file := path.Join("testdata", "params_handling.yaml")
-	cp, err := configparser.NewConfigMapFromFile(file)
+	cp, err := configmap.NewConfigMapFromFile(file)
 	require.NoError(t, err)
 
 	expectedFile := path.Join("testdata", "params_handling_expected.yaml")
-	expectedParser, err := configparser.NewConfigMapFromFile(expectedFile)
+	expectedParser, err := configmap.NewConfigMapFromFile(expectedFile)
 	require.NoError(t, err)
 
 	actualParser, err := manager.Resolve(ctx, cp)
@@ -221,7 +221,7 @@ func TestConfigSourceManager_WatchForUpdate(t *testing.T) {
 		},
 	}
 
-	cp := configparser.NewConfigMapFromStringMap(originalCfg)
+	cp := configmap.NewConfigMapFromStringMap(originalCfg)
 	_, err = manager.Resolve(ctx, cp)
 	require.NoError(t, err)
 
@@ -277,7 +277,7 @@ func TestConfigSourceManager_MultipleWatchForUpdate(t *testing.T) {
 		},
 	}
 
-	cp := configparser.NewConfigMapFromStringMap(originalCfg)
+	cp := configmap.NewConfigMapFromStringMap(originalCfg)
 	_, err = manager.Resolve(ctx, cp)
 	require.NoError(t, err)
 
@@ -328,11 +328,11 @@ func TestConfigSourceManager_EnvVarHandling(t *testing.T) {
 	}
 
 	file := path.Join("testdata", "envvar_cfgsrc_mix.yaml")
-	cp, err := configparser.NewConfigMapFromFile(file)
+	cp, err := configmap.NewConfigMapFromFile(file)
 	require.NoError(t, err)
 
 	expectedFile := path.Join("testdata", "envvar_cfgsrc_mix_expected.yaml")
-	expectedParser, err := configparser.NewConfigMapFromFile(expectedFile)
+	expectedParser, err := configmap.NewConfigMapFromFile(expectedFile)
 	require.NoError(t, err)
 
 	actualParser, err := manager.Resolve(ctx, cp)

config/configunmarshaler/unmarshaler.go

@@ -19,7 +19,7 @@ import (
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config"
-	"go.opentelemetry.io/collector/config/configparser"
+	"go.opentelemetry.io/collector/config/configmap"
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/exporter/exporterhelper"
 	"go.opentelemetry.io/collector/model/pdata"
@@ -38,7 +38,7 @@ type ExampleExporter struct {
 }
 
 // Unmarshal a viper data into the config struct
-func (cfg *ExampleExporter) Unmarshal(componentParser *configparser.ConfigMap) error {
+func (cfg *ExampleExporter) Unmarshal(componentParser *configmap.ConfigMap) error {
 	return componentParser.UnmarshalExact(cfg)
 }
 

config/internal/configsource/manager.go

@@ -20,7 +20,7 @@ import (
 	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/config/configgrpc"
 	"go.opentelemetry.io/collector/config/confighttp"
-	"go.opentelemetry.io/collector/config/configparser"
+	"go.opentelemetry.io/collector/config/configmap"
 )
 
 const (
@@ -56,7 +56,7 @@ func (cfg *Config) Validate() error {
 }
 
 // Unmarshal a config.Parser into the config struct.
-func (cfg *Config) Unmarshal(componentParser *configparser.ConfigMap) error {
+func (cfg *Config) Unmarshal(componentParser *configmap.ConfigMap) error {
 	if componentParser == nil || len(componentParser.AllKeys()) == 0 {
 		return fmt.Errorf("empty config for OTLP receiver")
 	}
@@ -66,7 +66,7 @@ func (cfg *Config) Unmarshal(componentParser *configparser.ConfigMap) error {
 		return err
 	}
 
-	// next manually search for protocols in the configparser.ConfigMap, if a protocol is not present it means it is disable.
+	// next manually search for protocols in the configmap.ConfigMap, if a protocol is not present it means it is disable.
 	protocols, err := componentParser.Sub(protocolsFieldName)
 	if err != nil {
 		return err