Create configload.Parser struct to abstract away from Viper

component/component.go

@@ -17,8 +17,6 @@ package component
 import (
 	"context"
 
-	"github.com/spf13/viper"
-
 	"go.opentelemetry.io/collector/config/configmodels"
 )
 
@@ -68,17 +66,17 @@ type Factory interface {
 // the configuration loading system will use to unmarshal the config.
 type ConfigUnmarshaler interface {
 	// Unmarshal is a function that un-marshals a viper data into a config struct in a custom way.
-	// componentViperSection *viper.Viper
+	// componentSection map[string]interface{}
 	//   The config for this specific component. May be nil or empty if no config available.
 	// intoCfg interface{}
 	//   An empty interface wrapping a pointer to the config struct to unmarshal into.
-	Unmarshal(componentViperSection *viper.Viper, intoCfg interface{}) error
+	Unmarshal(componentSection map[string]interface{}, intoCfg interface{}) error
 }
 
-// CustomUnmarshaler is a function that un-marshals a viper data into a config struct
+// CustomUnmarshaler is a function that un-marshals map data into a config struct
 // in a custom way.
-// componentViperSection *viper.Viper
+// componentViperSection map[string]interface{}
 //   The config for this specific component. May be nil or empty if no config available.
 // intoCfg interface{}
 //   An empty interface wrapping a pointer to the config struct to unmarshal into.
-type CustomUnmarshaler func(componentViperSection *viper.Viper, intoCfg interface{}) error
+type CustomUnmarshaler func(componentSection map[string]interface{}, intoCfg interface{}) error

config/config.go

@@ -104,6 +104,71 @@ func NewViper() *viper.Viper {
 	return viper.NewWithOptions(viper.KeyDelimiter(ViperDelimiter))
 }
 
+// fromStringMap creates a Viper object from a map[string]interface{}
+func fromStringMap(cfg map[string]interface{}) *viper.Viper {
+	viperCfg := NewViper()
+	viperCfg.MergeConfigMap(cfg)
+	return viperCfg
+}
+
+// deepSearch scans deep maps, following the key indexes listed in the
+// sequence "path".
+// The last value is expected to be another map, and is returned.
+//
+// In case intermediate keys do not exist, or map to a non-map value,
+// a new map is created and inserted, and the search continues from there:
+// the initial map "m" may be modified!
+// This function comes from Viper code https://github.com/spf13/viper/blob/5253694/util.go#L201-L230
+// It is used here because of https://github.com/spf13/viper/issues/819
+func deepSearch(m map[string]interface{}, path []string) map[string]interface{} {
+	for _, k := range path {
+		m2, ok := m[k]
+		if !ok {
+			// intermediate key does not exist
+			// => create it and continue from there
+			m3 := make(map[string]interface{})
+			m[k] = m3
+			m = m3
+			continue
+		}
+		m3, ok := m2.(map[string]interface{})
+		if !ok {
+			// intermediate key is a value
+			// => replace with a new map
+			m3 = make(map[string]interface{})
+			m[k] = m3
+		}
+		// continue search from here
+		m = m3
+	}
+	return m
+}
+
+// toStringMap creates a map[string]interface{} from a Viper object
+// It is equivalent to v.AllSettings() but it maps nil values
+// It is used here because of https://github.com/spf13/viper/issues/819
+func toStringMap(v *viper.Viper) map[string]interface{} {
+	m := map[string]interface{}{}
+	// start from the list of keys, and construct the map one value at a time
+	for _, k := range v.AllKeys() {
+		value := v.Get(k)
+		path := strings.Split(k, ViperDelimiter)
+		lastKey := strings.ToLower(path[len(path)-1])
+		deepestMap := deepSearch(m, path[0:len(path)-1])
+		// set innermost value
+		deepestMap[lastKey] = value
+	}
+	return m
+}
+
+// ToCustomUnmarshaler creates a custom unmarshaler from a Viper unmarshaled.
+// It should not be used by new code.
+func ToCustomUnmarshaler(viperUnmarshaler func(*viper.Viper, interface{}) error) component.CustomUnmarshaler {
+	return func(componentSection map[string]interface{}, intoCfg interface{}) error {
+		return viperUnmarshaler(fromStringMap(componentSection), intoCfg)
+	}
+}
+
 // Load loads a Config from Viper.
 // After loading the config, need to check if it is valid by calling `ValidateConfig`.
 func Load(
@@ -262,7 +327,7 @@ func loadExtensions(exts map[string]interface{}, factories map[configmodels.Type
 		// Now that the default config struct is created we can Unmarshal into it
 		// and it will apply user-defined config on top of the default.
 		unm := unmarshaler(factory)
-		if err := unm(componentConfig, extensionCfg); err != nil {
+		if err := unm(toStringMap(componentConfig), extensionCfg); err != nil {
 			return nil, errorUnmarshalError(extensionsKeyName, fullName, err)
 		}
 
@@ -298,7 +363,7 @@ func LoadReceiver(componentConfig *viper.Viper, typeStr configmodels.Type, fullN
 	// Now that the default config struct is created we can Unmarshal into it
 	// and it will apply user-defined config on top of the default.
 	unm := unmarshaler(factory)
-	if err := unm(componentConfig, receiverCfg); err != nil {
+	if err := unm(toStringMap(componentConfig), receiverCfg); err != nil {
 		return nil, errorUnmarshalError(receiversKeyName, fullName, err)
 	}
 
@@ -371,7 +436,7 @@ func loadExporters(exps map[string]interface{}, factories map[configmodels.Type]
 		// Now that the default config struct is created we can Unmarshal into it
 		// and it will apply user-defined config on top of the default.
 		unm := unmarshaler(factory)
-		if err := unm(componentConfig, exporterCfg); err != nil {
+		if err := unm(toStringMap(componentConfig), exporterCfg); err != nil {
 			return nil, errorUnmarshalError(exportersKeyName, fullName, err)
 		}
 
@@ -414,7 +479,7 @@ func loadProcessors(procs map[string]interface{}, factories map[configmodels.Typ
 		// Now that the default config struct is created we can Unmarshal into it
 		// and it will apply user-defined config on top of the default.
 		unm := unmarshaler(factory)
-		if err := unm(componentConfig, processorCfg); err != nil {
+		if err := unm(toStringMap(componentConfig), processorCfg); err != nil {
 			return nil, errorUnmarshalError(processorsKeyName, fullName, err)
 		}
 
@@ -556,7 +621,8 @@ func unmarshaler(factory component.Factory) component.CustomUnmarshaler {
 	return defaultUnmarshaler
 }
 
-func defaultUnmarshaler(componentViperSection *viper.Viper, intoCfg interface{}) error {
+func defaultUnmarshaler(componentSection map[string]interface{}, intoCfg interface{}) error {
+	componentViperSection := fromStringMap(componentSection)
 	return componentViperSection.UnmarshalExact(intoCfg)
 }
 

exporter/exporterhelper/factory.go

@@ -17,8 +17,6 @@ package exporterhelper
 import (
 	"context"
 
-	"github.com/spf13/viper"
-
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config/configerror"
 	"go.opentelemetry.io/collector/config/configmodels"
@@ -148,6 +146,6 @@ type factoryWithUnmarshaler struct {
 }
 
 // Unmarshal un-marshals the config using the provided custom unmarshaler.
-func (f *factoryWithUnmarshaler) Unmarshal(componentViperSection *viper.Viper, intoCfg interface{}) error {
-	return f.customUnmarshaler(componentViperSection, intoCfg)
+func (f *factoryWithUnmarshaler) Unmarshal(componentSection map[string]interface{}, intoCfg interface{}) error {
+	return f.customUnmarshaler(componentSection, intoCfg)
 }

exporter/exporterhelper/factory_test.go

@@ -19,7 +19,6 @@ import (
 	"errors"
 	"testing"
 
-	"github.com/spf13/viper"
 	"github.com/stretchr/testify/assert"
 	"go.uber.org/zap"
 
@@ -107,6 +106,6 @@ func createLogsExporter(context.Context, component.ExporterCreateParams, configm
 	return nopLogsExporter, nil
 }
 
-func customUnmarshaler(*viper.Viper, interface{}) error {
+func customUnmarshaler(map[string]interface{}, interface{}) error {
 	return errors.New("my error")
 }

extension/extensionhelper/factory.go

@@ -17,8 +17,6 @@ package extensionhelper
 import (
 	"context"
 
-	"github.com/spf13/viper"
-
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config/configmodels"
 )
@@ -94,6 +92,6 @@ type factoryWithUnmarshaler struct {
 }
 
 // Unmarshal un-marshals the config using the provided custom unmarshaler.
-func (f *factoryWithUnmarshaler) Unmarshal(componentViperSection *viper.Viper, intoCfg interface{}) error {
-	return f.customUnmarshaler(componentViperSection, intoCfg)
+func (f *factoryWithUnmarshaler) Unmarshal(componentSection map[string]interface{}, intoCfg interface{}) error {
+	return f.customUnmarshaler(componentSection, intoCfg)
 }

extension/extensionhelper/factory_test.go

@@ -19,7 +19,6 @@ import (
 	"errors"
 	"testing"
 
-	"github.com/spf13/viper"
 	"github.com/stretchr/testify/assert"
 
 	"go.opentelemetry.io/collector/component"
@@ -74,7 +73,7 @@ func createExtension(context.Context, component.ExtensionCreateParams, configmod
 	return nopExtensionInstance, nil
 }
 
-func customUnmarshaler(*viper.Viper, interface{}) error {
+func customUnmarshaler(map[string]interface{}, interface{}) error {
 	return errors.New("my error")
 }
 

processor/processorhelper/factory.go

@@ -17,8 +17,6 @@ package processorhelper
 import (
 	"context"
 
-	"github.com/spf13/viper"
-
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config/configerror"
 	"go.opentelemetry.io/collector/config/configmodels"
@@ -144,6 +142,6 @@ type factoryWithUnmarshaler struct {
 }
 
 // Unmarshal un-marshals the config using the provided custom unmarshaler.
-func (f *factoryWithUnmarshaler) Unmarshal(componentViperSection *viper.Viper, intoCfg interface{}) error {
-	return f.customUnmarshaler(componentViperSection, intoCfg)
+func (f *factoryWithUnmarshaler) Unmarshal(componentSection map[string]interface{}, intoCfg interface{}) error {
+	return f.customUnmarshaler(componentSection, intoCfg)
 }

processor/processorhelper/factory_test.go

@@ -19,7 +19,6 @@ import (
 	"errors"
 	"testing"
 
-	"github.com/spf13/viper"
 	"github.com/stretchr/testify/assert"
 
 	"go.opentelemetry.io/collector/component"
@@ -91,6 +90,6 @@ func createLogsProcessor(context.Context, component.ProcessorCreateParams, confi
 	return nil, nil
 }
 
-func customUnmarshaler(*viper.Viper, interface{}) error {
+func customUnmarshaler(map[string]interface{}, interface{}) error {
 	return errors.New("my error")
 }

receiver/hostmetricsreceiver/factory.go

@@ -71,7 +71,7 @@ func NewFactory() component.ReceiverFactory {
 		typeStr,
 		createDefaultConfig,
 		receiverhelper.WithMetrics(createMetricsReceiver),
-		receiverhelper.WithCustomUnmarshaler(customUnmarshaler))
+		receiverhelper.WithCustomUnmarshaler(config.ToCustomUnmarshaler(customUnmarshaler)))
 }
 
 // customUnmarshaler returns custom unmarshaler for this config.

receiver/jaegerreceiver/factory.go

@@ -25,6 +25,7 @@ import (
 	"github.com/spf13/viper"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/config/configgrpc"
 	"go.opentelemetry.io/collector/config/confighttp"
 	"go.opentelemetry.io/collector/config/configmodels"
@@ -56,7 +57,7 @@ func NewFactory() component.ReceiverFactory {
 		typeStr,
 		createDefaultConfig,
 		receiverhelper.WithTraces(createTraceReceiver),
-		receiverhelper.WithCustomUnmarshaler(customUnmarshaler))
+		receiverhelper.WithCustomUnmarshaler(config.ToCustomUnmarshaler(customUnmarshaler)))
 }
 
 // customUnmarshaler is used to add defaults for named but empty protocols

receiver/jaegerreceiver/factory_test.go

@@ -26,7 +26,6 @@ import (
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/component/componenttest"
-	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/config/configcheck"
 	"go.opentelemetry.io/collector/config/configerror"
 	"go.opentelemetry.io/collector/config/configgrpc"
@@ -344,9 +343,9 @@ func TestCustomUnmarshalErrors(t *testing.T) {
 	fu, ok := factory.(component.ConfigUnmarshaler)
 	assert.True(t, ok)
 
-	err := fu.Unmarshal(config.NewViper(), nil)
+	err := fu.Unmarshal(nil, nil)
 	assert.Error(t, err, "should not have been able to marshal to a nil config")
 
-	err = fu.Unmarshal(config.NewViper(), &RemoteSamplingConfig{})
+	err = fu.Unmarshal(nil, &RemoteSamplingConfig{})
 	assert.Error(t, err, "should not have been able to marshal to a non-jaegerreceiver config")
 }

receiver/otlpreceiver/factory.go

@@ -22,6 +22,7 @@ import (
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/config/configgrpc"
 	"go.opentelemetry.io/collector/config/confighttp"
 	"go.opentelemetry.io/collector/config/configmodels"
@@ -51,7 +52,7 @@ func NewFactory() component.ReceiverFactory {
 		receiverhelper.WithTraces(createTraceReceiver),
 		receiverhelper.WithMetrics(createMetricsReceiver),
 		receiverhelper.WithLogs(createLogReceiver),
-		receiverhelper.WithCustomUnmarshaler(customUnmarshaler))
+		receiverhelper.WithCustomUnmarshaler(config.ToCustomUnmarshaler(customUnmarshaler)))
 }
 
 // createDefaultConfig creates the default configuration for receiver.

receiver/prometheusreceiver/factory.go

@@ -24,6 +24,7 @@ import (
 	"gopkg.in/yaml.v2"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/config/configmodels"
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/receiver/receiverhelper"
@@ -48,7 +49,7 @@ func NewFactory() component.ReceiverFactory {
 		typeStr,
 		createDefaultConfig,
 		receiverhelper.WithMetrics(createMetricsReceiver),
-		receiverhelper.WithCustomUnmarshaler(customUnmarshaler))
+		receiverhelper.WithCustomUnmarshaler(config.ToCustomUnmarshaler(customUnmarshaler)))
 }
 
 func customUnmarshaler(componentViperSection *viper.Viper, intoCfg interface{}) error {

receiver/receiverhelper/factory.go

@@ -17,8 +17,6 @@ package receiverhelper
 import (
 	"context"
 
-	"github.com/spf13/viper"
-
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config/configerror"
 	"go.opentelemetry.io/collector/config/configmodels"
@@ -152,6 +150,6 @@ type factoryWithUnmarshaler struct {
 }
 
 // Unmarshal un-marshals the config using the provided custom unmarshaler.
-func (f *factoryWithUnmarshaler) Unmarshal(componentViperSection *viper.Viper, intoCfg interface{}) error {
-	return f.customUnmarshaler(componentViperSection, intoCfg)
+func (f *factoryWithUnmarshaler) Unmarshal(componentSection map[string]interface{}, intoCfg interface{}) error {
+	return f.customUnmarshaler(componentSection, intoCfg)
 }

receiver/receiverhelper/factory_test.go

@@ -19,7 +19,6 @@ import (
 	"errors"
 	"testing"
 
-	"github.com/spf13/viper"
 	"github.com/stretchr/testify/assert"
 
 	"go.opentelemetry.io/collector/component"
@@ -91,6 +90,6 @@ func createLogsReceiver(context.Context, component.ReceiverCreateParams, configm
 	return nil, nil
 }
 
-func customUnmarshaler(*viper.Viper, interface{}) error {
+func customUnmarshaler(map[string]interface{}, interface{}) error {
 	return errors.New("my error")
 }