Split LoadConfig into LoadConfig and LoadAndVerifyConfig.

Signed-off-by: Bogdan Drutu <[email protected]>
open-telemetry · May 4, 2020 · d494396 · d494396
1 parent 5bdba60
commit d494396
Show file tree

Hide file tree

Showing 29 changed files with 61 additions and 47 deletions.
diff --git a/config/config_test.go b/config/config_test.go
@@ -29,7 +29,7 @@ func TestDecodeConfig(t *testing.T) {
 	assert.NoError(t, err)
 
 	// Load the config
-	config, err := LoadConfigFile(t, path.Join(".", "testdata", "valid-config.yaml"), factories)
+	config, err := LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "valid-config.yaml"), factories)
 	if err != nil {
 		t.Fatalf("unable to load config, %v", err)
 	}
@@ -195,7 +195,7 @@ func TestSimpleConfig(t *testing.T) {
 		assert.NoError(t, err)
 
 		// Load the config
-		config, err := LoadConfigFile(t, path.Join(".", "testdata", test.name+".yaml"), factories)
+		config, err := LoadAndVerifyConfigFile(t, path.Join(".", "testdata", test.name+".yaml"), factories)
 		if err != nil {
 			t.Fatalf("TEST[%s] unable to load config, %v", test.name, err)
 		}
@@ -290,7 +290,7 @@ func TestDecodeConfig_MultiProto(t *testing.T) {
 	assert.NoError(t, err)
 
 	// Load the config
-	config, err := LoadConfigFile(t, path.Join(".", "testdata", "multiproto-config.yaml"), factories)
+	config, err := LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "multiproto-config.yaml"), factories)
 	if err != nil {
 		t.Fatalf("unable to load config, %v", err)
 	}
@@ -386,7 +386,7 @@ func TestDecodeConfig_Invalid(t *testing.T) {
 	assert.NoError(t, err)
 
 	for _, test := range testCases {
-		_, err := LoadConfigFile(t, path.Join(".", "testdata", test.name+".yaml"), factories)
+		_, err := LoadAndVerifyConfigFile(t, path.Join(".", "testdata", test.name+".yaml"), factories)
 		if err == nil {
 			t.Errorf("expected error but succeeded on invalid config case: %s", test.name)
 		} else if test.expected != 0 {
@@ -407,3 +407,11 @@ func TestDecodeConfig_Invalid(t *testing.T) {
 		}
 	}
 }
+
+func TestLoadEmptyConfig(t *testing.T) {
+	factories, err := ExampleComponents()
+	assert.NoError(t, err)
+
+	_, err = LoadConfigFile(t, path.Join(".", "testdata", "empty-config.yaml"), factories)
+	assert.NoError(t, err)
+}
diff --git a/config/test_helpers.go b/config/test_helpers.go
@@ -24,7 +24,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-collector/config/configmodels"
 )
 
-// LoadConfigFile loads a config from file.
+// LoadConfigFile loads a config from file, without verifying it.
 func LoadConfigFile(t *testing.T, fileName string, factories Factories) (*configmodels.Config, error) {
 	// Open the file for reading.
 	file, err := os.Open(filepath.Clean(fileName))
@@ -49,10 +49,16 @@ func LoadConfigFile(t *testing.T, fileName string, factories Factories) (*config
 	}
 
 	// Load the config from viper using the given factories.
-	cfg, err := Load(v, factories)
+	return Load(v, factories)
+}
+
+// LoadAndVerifyConfigFile loads and verifies a config from file.
+func LoadAndVerifyConfigFile(t *testing.T, fileName string, factories Factories) (*configmodels.Config, error) {
+	cfg, err := LoadConfigFile(t, fileName, factories)
 	if err != nil {
 		return nil, err
 	}
+
 	err = ValidateConfig(cfg, zap.NewNop())
 	if err != nil {
 		return nil, err

diff --git a/exporter/fileexporter/config_test.go b/exporter/fileexporter/config_test.go
@@ -31,7 +31,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Exporters[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)

diff --git a/exporter/jaegerexporter/config_test.go b/exporter/jaegerexporter/config_test.go
@@ -33,7 +33,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Exporters[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)

diff --git a/exporter/loggingexporter/config_test.go b/exporter/loggingexporter/config_test.go
@@ -31,7 +31,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Exporters[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)

diff --git a/exporter/opencensusexporter/config_test.go b/exporter/opencensusexporter/config_test.go
@@ -32,7 +32,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Exporters[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)

diff --git a/exporter/otlpexporter/config_test.go b/exporter/otlpexporter/config_test.go
@@ -32,7 +32,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Exporters[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)

diff --git a/exporter/prometheusexporter/config_test.go b/exporter/prometheusexporter/config_test.go
@@ -31,7 +31,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Exporters[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)

diff --git a/exporter/zipkinexporter/config_test.go b/exporter/zipkinexporter/config_test.go
@@ -31,7 +31,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Exporters[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)

diff --git a/extension/healthcheckextension/config_test.go b/extension/healthcheckextension/config_test.go
@@ -31,7 +31,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Extensions[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.Nil(t, err)
 	require.NotNil(t, cfg)

diff --git a/extension/pprofextension/config_test.go b/extension/pprofextension/config_test.go
@@ -31,7 +31,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Extensions[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.Nil(t, err)
 	require.NotNil(t, cfg)

diff --git a/extension/zpagesextension/config_test.go b/extension/zpagesextension/config_test.go
@@ -31,7 +31,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Extensions[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.Nil(t, err)
 	require.NotNil(t, cfg)

diff --git a/processor/attributesprocessor/config_test.go b/processor/attributesprocessor/config_test.go
@@ -32,7 +32,7 @@ func TestLoadingConifg(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Processors[typeStr] = factory
-	config, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	config, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	assert.Nil(t, err)
 	require.NotNil(t, config)

diff --git a/processor/batchprocessor/config_test.go b/processor/batchprocessor/config_test.go
@@ -32,7 +32,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Processors[typeStr] = &Factory{}
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.Nil(t, err)
 	require.NotNil(t, cfg)

diff --git a/processor/memorylimiter/config_test.go b/processor/memorylimiter/config_test.go
@@ -33,7 +33,7 @@ func TestLoadConfig(t *testing.T) {
 	factories.Processors[typeStr] = factory
 	require.NoError(t, err)
 
-	config, err := config.LoadConfigFile(
+	config, err := config.LoadAndVerifyConfigFile(
 		t,
 		path.Join(".", "testdata", "config.yaml"),
 		factories)

diff --git a/processor/queuedprocessor/config_test.go b/processor/queuedprocessor/config_test.go
@@ -32,7 +32,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Processors[typeStr] = &Factory{}
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.Nil(t, err)
 	require.NotNil(t, cfg)

diff --git a/processor/resourceprocessor/config_test.go b/processor/resourceprocessor/config_test.go
@@ -31,7 +31,7 @@ func TestLoadConfig(t *testing.T) {
 	factory := &Factory{}
 	factories.Processors[typeStr] = &Factory{}
 
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 	assert.NoError(t, err)
 	assert.NotNil(t, cfg)
 

diff --git a/processor/samplingprocessor/probabilisticsamplerprocessor/config_test.go b/processor/samplingprocessor/probabilisticsamplerprocessor/config_test.go
@@ -32,7 +32,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Processors[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.Nil(t, err)
 	require.NotNil(t, cfg)
@@ -57,7 +57,7 @@ func TestLoadConfigEmpty(t *testing.T) {
 	require.NotNil(t, factories.Processors)
 	require.NoError(t, err)
 
-	config, err := config.LoadConfigFile(t, path.Join(".", "testdata", "empty.yaml"), factories)
+	config, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "empty.yaml"), factories)
 
 	require.Nil(t, err)
 	require.NotNil(t, config)

diff --git a/processor/samplingprocessor/tailsamplingprocessor/config_test.go b/processor/samplingprocessor/tailsamplingprocessor/config_test.go
@@ -33,7 +33,7 @@ func TestLoadConfig(t *testing.T) {
 	factory := &Factory{}
 	factories.Processors[factory.Type()] = factory
 
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "tail_sampling_config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "tail_sampling_config.yaml"), factories)
 	require.Nil(t, err)
 	require.NotNil(t, cfg)
 

diff --git a/processor/spanprocessor/config_test.go b/processor/spanprocessor/config_test.go
@@ -32,7 +32,7 @@ func TestLoadConfig(t *testing.T) {
 	factory := &Factory{}
 	factories.Processors[typeStr] = factory
 
-	config, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	config, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	assert.Nil(t, err)
 	assert.NotNil(t, config)

diff --git a/receiver/hostmetricsreceiver/config_test.go b/receiver/hostmetricsreceiver/config_test.go
@@ -34,7 +34,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := NewFactory()
 	factories.Receivers[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)

diff --git a/receiver/jaegerreceiver/config_test.go b/receiver/jaegerreceiver/config_test.go
@@ -32,7 +32,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Receivers[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)
@@ -152,12 +152,12 @@ func TestFailedLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Receivers[typeStr] = factory
-	_, err = config.LoadConfigFile(t, path.Join(".", "testdata", "bad_proto_config.yaml"), factories)
+	_, err = config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "bad_proto_config.yaml"), factories)
 	assert.EqualError(t, err, `error reading settings for receiver type "jaeger": unknown Jaeger protocol badproto`)
 
-	_, err = config.LoadConfigFile(t, path.Join(".", "testdata", "bad_no_proto_config.yaml"), factories)
+	_, err = config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "bad_no_proto_config.yaml"), factories)
 	assert.EqualError(t, err, `error reading settings for receiver type "jaeger": must specify at least one protocol when using the Jaeger receiver`)
 
-	_, err = config.LoadConfigFile(t, path.Join(".", "testdata", "bad_empty_config.yaml"), factories)
+	_, err = config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "bad_empty_config.yaml"), factories)
 	assert.EqualError(t, err, `error reading settings for receiver type "jaeger": empty config for Jaeger receiver`)
 }
diff --git a/receiver/opencensusreceiver/config_test.go b/receiver/opencensusreceiver/config_test.go
@@ -33,7 +33,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Receivers[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)

diff --git a/receiver/otlpreceiver/config_test.go b/receiver/otlpreceiver/config_test.go
@@ -33,7 +33,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Receivers[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)

diff --git a/receiver/prometheusreceiver/config_test.go b/receiver/prometheusreceiver/config_test.go
@@ -33,7 +33,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Receivers[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)
@@ -65,7 +65,7 @@ func TestLoadConfigWithEnvVar(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Receivers[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config_env.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config_env.yaml"), factories)
 	require.NoError(t, err)
 	require.NotNil(t, cfg)
 
@@ -86,7 +86,7 @@ func TestLoadConfigFailsOnUnknownSection(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Receivers[typeStr] = factory
-	cfg, err := config.LoadConfigFile(
+	cfg, err := config.LoadAndVerifyConfigFile(
 		t,
 		path.Join(".", "testdata", "invalid-config-section.yaml"), factories)
 
@@ -103,7 +103,7 @@ func TestLoadConfigFailsOnUnknownPrometheusSection(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Receivers[typeStr] = factory
-	cfg, err := config.LoadConfigFile(
+	cfg, err := config.LoadAndVerifyConfigFile(
 		t,
 		path.Join(".", "testdata", "invalid-config-prometheus-section.yaml"), factories)
 

diff --git a/receiver/vmmetricsreceiver/config_test.go b/receiver/vmmetricsreceiver/config_test.go
@@ -32,7 +32,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Receivers[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)

diff --git a/receiver/zipkinreceiver/config_test.go b/receiver/zipkinreceiver/config_test.go
@@ -31,7 +31,7 @@ func TestLoadConfig(t *testing.T) {
 
 	factory := &Factory{}
 	factories.Receivers[typeStr] = factory
-	cfg, err := config.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, path.Join(".", "testdata", "config.yaml"), factories)
 
 	require.NoError(t, err)
 	require.NotNil(t, cfg)

diff --git a/service/builder/pipelines_builder_test.go b/service/builder/pipelines_builder_test.go
@@ -149,7 +149,7 @@ func testPipeline(t *testing.T, pipelineName string, exporterNames []string) {
 	assert.Nil(t, err)
 	attrFactory := &attributesprocessor.Factory{}
 	factories.Processors[attrFactory.Type()] = attrFactory
-	cfg, err := config.LoadConfigFile(t, "testdata/pipelines_builder.yaml", factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, "testdata/pipelines_builder.yaml", factories)
 	// Load the config
 	require.Nil(t, err)
 
@@ -209,11 +209,11 @@ func TestPipelinesBuilder_Error(t *testing.T) {
 	assert.Nil(t, err)
 	attrFactory := &attributesprocessor.Factory{}
 	factories.Processors[attrFactory.Type()] = attrFactory
-	cfg, err := config.LoadConfigFile(t, "testdata/pipelines_builder.yaml", factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, "testdata/pipelines_builder.yaml", factories)
 	require.Nil(t, err)
 
 	// Corrupt the pipeline, change data type to metrics. We have to forcedly do it here
-	// since there is no way to have such config loaded by LoadConfigFile, it would not
+	// since there is no way to have such config loaded by LoadAndVerifyConfigFile, it would not
 	// pass validation. We are doing this to test failure mode of PipelinesBuilder.
 	pipeline := cfg.Service.Pipelines["traces"]
 	pipeline.InputType = configmodels.MetricsDataType
@@ -235,7 +235,7 @@ func TestProcessorsBuilder_ErrorOnNilProcessor(t *testing.T) {
 	bf := &badProcessorFactory{}
 	factories.Processors[bf.Type()] = bf
 
-	cfg, err := config.LoadConfigFile(t, "testdata/bad_processor_factory.yaml", factories)
+	cfg, err := config.LoadAndVerifyConfigFile(t, "testdata/bad_processor_factory.yaml", factories)
 	require.Nil(t, err)
 
 	allExporters, err := NewExportersBuilder(zap.NewNop(), cfg, factories.Exporters).Build()