Add a new bytes provier, allows providing yaml bytes (#4998)

Open Question: Should the schema be "yaml:" or "bytes:"?

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>

CHANGELOG.md

@@ -16,6 +16,7 @@
 
 - Add `pdata.AttributeMap.RemoveIf`, which is a more performant way to remove multiple keys (#4914)
 - Add `pipeline` key with pipeline identifier to processor loggers (#4968)
+- Add a new yaml provider, allows providing yaml bytes (#4998)
 
 ### 🧰 Bug fixes 🧰
 

config/configmapprovider/yaml.go

@@ -0,0 +1,58 @@
+// 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 configmapprovider // import "go.opentelemetry.io/collector/config/configmapprovider"
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"gopkg.in/yaml.v2"
+
+	"go.opentelemetry.io/collector/config"
+)
+
+const bytesSchemeName = "yaml"
+
+type yamlMapProvider struct{}
+
+// NewYAML returns a new Provider that allows to provide yaml bytes.
+//
+// This Provider supports "yaml" scheme, and can be called with a "location" that follows:
+//   bytes-location   = "yaml:" yaml-bytes
+//
+// Examples:
+// `yaml:processors::batch::timeout: 2s`
+// `yaml:processors::batch/foo::timeout: 3s`
+func NewYAML() Provider {
+	return &yamlMapProvider{}
+}
+
+func (s *yamlMapProvider) Retrieve(_ context.Context, location string, _ WatcherFunc) (Retrieved, error) {
+	if !strings.HasPrefix(location, bytesSchemeName+":") {
+		return Retrieved{}, fmt.Errorf("%v location is not supported by %v provider", location, bytesSchemeName)
+	}
+
+	var data map[string]interface{}
+	if err := yaml.Unmarshal([]byte(location[len(bytesSchemeName)+1:]), &data); err != nil {
+		return Retrieved{}, fmt.Errorf("unable to parse yaml: %w", err)
+	}
+
+	return Retrieved{Map: config.NewMapFromStringMap(data)}, nil
+}
+
+func (s *yamlMapProvider) Shutdown(context.Context) error {
+	return nil
+}

config/configmapprovider/yaml_test.go

@@ -0,0 +1,106 @@
+// 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 configmapprovider
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestYamlProvider_Empty(t *testing.T) {
+	sp := NewYAML()
+	_, err := sp.Retrieve(context.Background(), "", nil)
+	assert.Error(t, err)
+	assert.NoError(t, sp.Shutdown(context.Background()))
+}
+
+func TestYamlProvider_InvalidValue(t *testing.T) {
+	sp := NewYAML()
+	_, err := sp.Retrieve(context.Background(), "yaml::2s", nil)
+	assert.Error(t, err)
+	assert.NoError(t, sp.Shutdown(context.Background()))
+}
+
+func TestYamlProvider(t *testing.T) {
+	sp := NewYAML()
+	ret, err := sp.Retrieve(context.Background(), "yaml:processors::batch::timeout: 2s", nil)
+	assert.NoError(t, err)
+	assert.Equal(t, map[string]interface{}{
+		"processors": map[string]interface{}{
+			"batch": map[string]interface{}{
+				"timeout": "2s",
+			},
+		},
+	}, ret.Map.ToStringMap())
+	assert.NoError(t, sp.Shutdown(context.Background()))
+}
+
+func TestYamlProvider_NamedComponent(t *testing.T) {
+	sp := NewYAML()
+	ret, err := sp.Retrieve(context.Background(), "yaml:processors::batch/foo::timeout: 3s", nil)
+	assert.NoError(t, err)
+	assert.Equal(t, map[string]interface{}{
+		"processors": map[string]interface{}{
+			"batch/foo": map[string]interface{}{
+				"timeout": "3s",
+			},
+		},
+	}, ret.Map.ToStringMap())
+	assert.NoError(t, sp.Shutdown(context.Background()))
+}
+
+func TestYamlProvider_MapEntry(t *testing.T) {
+	sp := NewYAML()
+	ret, err := sp.Retrieve(context.Background(), "yaml:processors: {batch/foo::timeout: 3s, batch::timeout: 2s}", nil)
+	assert.NoError(t, err)
+	assert.Equal(t, map[string]interface{}{
+		"processors": map[string]interface{}{
+			"batch/foo": map[string]interface{}{
+				"timeout": "3s",
+			},
+			"batch": map[string]interface{}{
+				"timeout": "2s",
+			},
+		},
+	}, ret.Map.ToStringMap())
+	assert.NoError(t, sp.Shutdown(context.Background()))
+}
+
+func TestYamlProvider_NewLine(t *testing.T) {
+	sp := NewYAML()
+	ret, err := sp.Retrieve(context.Background(), "yaml:processors::batch/foo::timeout: 3s\nprocessors::batch::timeout: 2s", nil)
+	assert.NoError(t, err)
+	assert.Equal(t, map[string]interface{}{
+		"processors": map[string]interface{}{
+			"batch/foo": map[string]interface{}{
+				"timeout": "3s",
+			},
+			"batch": map[string]interface{}{
+				"timeout": "2s",
+			},
+		},
+	}, ret.Map.ToStringMap())
+	assert.NoError(t, sp.Shutdown(context.Background()))
+}
+
+func TestYamlProvider_DotSeparator(t *testing.T) {
+	sp := NewYAML()
+	ret, err := sp.Retrieve(context.Background(), "yaml:processors.batch.timeout: 4s", nil)
+	assert.NoError(t, err)
+	assert.Equal(t, map[string]interface{}{"processors.batch.timeout": "4s"}, ret.Map.ToStringMap())
+	assert.NoError(t, sp.Shutdown(context.Background()))
+}

service/config_provider.go

@@ -106,6 +106,7 @@ func MustNewDefaultConfigProvider(configLocations []string, properties []string)
 		map[string]configmapprovider.Provider{
 			"file": configmapprovider.NewFile(),
 			"env":  configmapprovider.NewEnv(),
+			"yaml": configmapprovider.NewYAML(),
 		},
 		[]config.MapConverterFunc{
 			configmapprovider.NewOverwritePropertiesConverter(properties),