Use Factory instead of ProcessorFactory when package contains processor (#131)

bogdandrutu · web-flow · commit f38e2932001f · 2019-07-03T16:43:49.000-07:00
* Use Factory instead of ReceiverFactory when package contains receiver

* Change the name of the test factory in processor
diff --git a/cmd/occollector/app/builder/pipelines_builder.go b/cmd/occollector/app/builder/pipelines_builder.go
@@ -96,7 +96,7 @@ func (pb *PipelinesBuilder) buildPipeline(
 		procName := pipelineCfg.Processors[i]
 		procCfg := pb.config.Processors[procName]
 
-		factory := processor.GetProcessorFactory(procCfg.Type())
+		factory := processor.GetFactory(procCfg.Type())
 
 		// This processor must point to the next consumer and then
 		// it becomes the next for the previous one (previous in the pipeline,
diff --git a/configv2/configv2.go b/configv2/configv2.go
@@ -306,7 +306,7 @@ func loadProcessors(v *viper.Viper) (models.Processors, error) {
 		}
 
 		// Find processor factory based on "type" that we read from config source.
-		factory := processor.GetProcessorFactory(typeStr)
+		factory := processor.GetFactory(typeStr)
 		if factory == nil {
 			return nil, &configError{
 				code: errUnknownProcessorType,
diff --git a/configv2/example_factories.go b/configv2/example_factories.go
@@ -330,6 +330,6 @@ func RegisterTestFactories() error {
 	_ = receiver.RegisterFactory(&ExampleReceiverFactory{})
 	_ = receiver.RegisterFactory(&MultiProtoReceiverFactory{})
 	_ = exporter.RegisterFactory(&ExampleExporterFactory{})
-	_ = processor.RegisterProcessorFactory(&ExampleProcessorFactory{})
+	_ = processor.RegisterFactory(&ExampleProcessorFactory{})
 	return nil
 }
diff --git a/internal/collector/processor/nodebatcher/config_test.go b/internal/collector/processor/nodebatcher/config_test.go
@@ -31,7 +31,7 @@ var _ = configv2.RegisterTestFactories()
 
 func TestLoadConfig(t *testing.T) {
 
-	factory := processor.GetProcessorFactory(typeStr)
+	factory := processor.GetFactory(typeStr)
 
 	config, err := configv2.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"))
 
diff --git a/internal/collector/processor/nodebatcher/factory.go b/internal/collector/processor/nodebatcher/factory.go
@@ -23,24 +23,24 @@ import (
 	"github.com/open-telemetry/opentelemetry-service/processor"
 )
 
-var _ = processor.RegisterProcessorFactory(&processorFactory{})
+var _ = processor.RegisterFactory(&factory{})
 
 const (
 	// The value of "type" key in configuration.
 	typeStr = "batch"
 )
 
-// processorFactory is the factory for batch processor.
-type processorFactory struct {
+// factory is the factory for batch processor.
+type factory struct {
 }
 
 // Type gets the type of the config created by this factory.
-func (f *processorFactory) Type() string {
+func (f *factory) Type() string {
 	return typeStr
 }
 
 // CreateDefaultConfig creates the default configuration for processor.
-func (f *processorFactory) CreateDefaultConfig() models.Processor {
+func (f *factory) CreateDefaultConfig() models.Processor {
 	removeAfterTicks := int(defaultRemoveAfterCycles)
 	sendBatchSize := int(defaultSendBatchSize)
 	tickTime := defaultTickTime
@@ -60,7 +60,7 @@ func (f *processorFactory) CreateDefaultConfig() models.Processor {
 }
 
 // CreateTraceProcessor creates a trace processor based on this config.
-func (f *processorFactory) CreateTraceProcessor(
+func (f *factory) CreateTraceProcessor(
 	logger *zap.Logger,
 	nextConsumer consumer.TraceConsumer,
 	c models.Processor,
@@ -96,7 +96,7 @@ func (f *processorFactory) CreateTraceProcessor(
 }
 
 // CreateMetricsProcessor creates a metrics processor based on this config.
-func (f *processorFactory) CreateMetricsProcessor(
+func (f *factory) CreateMetricsProcessor(
 	logger *zap.Logger,
 	nextConsumer consumer.MetricsConsumer,
 	cfg models.Processor,
diff --git a/internal/collector/processor/nodebatcher/factory_test.go b/internal/collector/processor/nodebatcher/factory_test.go
@@ -26,15 +26,15 @@ import (
 )
 
 func TestCreateDefaultConfig(t *testing.T) {
-	factory := processor.GetProcessorFactory(typeStr)
+	factory := processor.GetFactory(typeStr)
 	require.NotNil(t, factory)
 
 	cfg := factory.CreateDefaultConfig()
 	assert.NotNil(t, cfg, "failed to create default config")
 }
 
 func TestCreateProcessor(t *testing.T) {
-	factory := processor.GetProcessorFactory(typeStr)
+	factory := processor.GetFactory(typeStr)
 	require.NotNil(t, factory)
 
 	cfg := factory.CreateDefaultConfig()
diff --git a/internal/collector/processor/queued/config_test.go b/internal/collector/processor/queued/config_test.go
@@ -31,7 +31,7 @@ var _ = configv2.RegisterTestFactories()
 
 func TestLoadConfig(t *testing.T) {
 
-	factory := processor.GetProcessorFactory(typeStr)
+	factory := processor.GetFactory(typeStr)
 
 	config, err := configv2.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"))
 
diff --git a/internal/collector/processor/queued/factory.go b/internal/collector/processor/queued/factory.go
@@ -24,24 +24,24 @@ import (
 	"go.uber.org/zap"
 )
 
-var _ = processor.RegisterProcessorFactory(&processorFactory{})
+var _ = processor.RegisterFactory(&factory{})
 
 const (
 	// The value of "type" key in configuration.
 	typeStr = "queued-retry"
 )
 
-// processorFactory is the factory for OpenCensus exporter.
-type processorFactory struct {
+// factory is the factory for OpenCensus exporter.
+type factory struct {
 }
 
 // Type gets the type of the Option config created by this factory.
-func (f *processorFactory) Type() string {
+func (f *factory) Type() string {
 	return typeStr
 }
 
 // CreateDefaultConfig creates the default configuration for exporter.
-func (f *processorFactory) CreateDefaultConfig() models.Processor {
+func (f *factory) CreateDefaultConfig() models.Processor {
 	return &ConfigV2{
 		ProcessorSettings: models.ProcessorSettings{
 			TypeVal: typeStr,
@@ -55,7 +55,7 @@ func (f *processorFactory) CreateDefaultConfig() models.Processor {
 }
 
 // CreateTraceProcessor creates a trace processor based on this config.
-func (f *processorFactory) CreateTraceProcessor(
+func (f *factory) CreateTraceProcessor(
 	logger *zap.Logger,
 	nextConsumer consumer.TraceConsumer,
 	cfg models.Processor,
@@ -70,7 +70,7 @@ func (f *processorFactory) CreateTraceProcessor(
 }
 
 // CreateMetricsProcessor creates a metrics processor based on this config.
-func (f *processorFactory) CreateMetricsProcessor(
+func (f *factory) CreateMetricsProcessor(
 	logger *zap.Logger,
 	nextConsumer consumer.MetricsConsumer,
 	cfg models.Processor,
diff --git a/internal/collector/processor/queued/factory_test.go b/internal/collector/processor/queued/factory_test.go
@@ -26,15 +26,15 @@ import (
 )
 
 func TestCreateDefaultConfig(t *testing.T) {
-	factory := processor.GetProcessorFactory(typeStr)
+	factory := processor.GetFactory(typeStr)
 	require.NotNil(t, factory)
 
 	cfg := factory.CreateDefaultConfig()
 	assert.NotNil(t, cfg, "failed to create default config")
 }
 
 func TestCreateProcessor(t *testing.T) {
-	factory := processor.GetProcessorFactory(typeStr)
+	factory := processor.GetFactory(typeStr)
 	require.NotNil(t, factory)
 
 	cfg := factory.CreateDefaultConfig()
diff --git a/processor/addattributesprocessor/config_test.go b/processor/addattributesprocessor/config_test.go
@@ -30,7 +30,7 @@ var _ = configv2.RegisterTestFactories()
 
 func TestLoadConfig(t *testing.T) {
 
-	factory := processor.GetProcessorFactory(typeStr)
+	factory := processor.GetFactory(typeStr)
 
 	config, err := configv2.LoadConfigFile(t, path.Join(".", "testdata", "config.yaml"))
 
diff --git a/processor/addattributesprocessor/factory.go b/processor/addattributesprocessor/factory.go
@@ -23,24 +23,24 @@ import (
 	"github.com/open-telemetry/opentelemetry-service/processor"
 )
 
-var _ = processor.RegisterProcessorFactory(&processorFactory{})
+var _ = processor.RegisterFactory(&factory{})
 
 const (
 	// The value of "type" key in configuration.
 	typeStr = "attributes"
 )
 
-// processorFactory is the factory for Attributes processor.
-type processorFactory struct {
+// factory is the factory for Attributes processor.
+type factory struct {
 }
 
 // Type gets the type of the config created by this factory.
-func (f *processorFactory) Type() string {
+func (f *factory) Type() string {
 	return typeStr
 }
 
 // CreateDefaultConfig creates the default configuration for processor.
-func (f *processorFactory) CreateDefaultConfig() models.Processor {
+func (f *factory) CreateDefaultConfig() models.Processor {
 	return &ConfigV2{
 		ProcessorSettings: models.ProcessorSettings{
 			TypeVal: typeStr,
@@ -51,7 +51,7 @@ func (f *processorFactory) CreateDefaultConfig() models.Processor {
 }
 
 // CreateTraceProcessor creates a trace processor based on this config.
-func (f *processorFactory) CreateTraceProcessor(
+func (f *factory) CreateTraceProcessor(
 	logger *zap.Logger,
 	nextConsumer consumer.TraceConsumer,
 	cfg models.Processor,
@@ -61,7 +61,7 @@ func (f *processorFactory) CreateTraceProcessor(
 }
 
 // CreateMetricsProcessor creates a metrics processor based on this config.
-func (f *processorFactory) CreateMetricsProcessor(
+func (f *factory) CreateMetricsProcessor(
 	logger *zap.Logger,
 	nextConsumer consumer.MetricsConsumer,
 	cfg models.Processor,
diff --git a/processor/addattributesprocessor/factory_test.go b/processor/addattributesprocessor/factory_test.go
@@ -26,15 +26,15 @@ import (
 )
 
 func TestCreateDefaultConfig(t *testing.T) {
-	factory := processor.GetProcessorFactory(typeStr)
+	factory := processor.GetFactory(typeStr)
 	require.NotNil(t, factory)
 
 	cfg := factory.CreateDefaultConfig()
 	assert.NotNil(t, cfg, "failed to create default config")
 }
 
 func TestCreateProcessor(t *testing.T) {
-	factory := processor.GetProcessorFactory(typeStr)
+	factory := processor.GetFactory(typeStr)
 	require.NotNil(t, factory)
 
 	cfg := factory.CreateDefaultConfig()
diff --git a/processor/factory.go b/processor/factory.go
@@ -47,8 +47,8 @@ type Factory interface {
 // List of registered processor factories.
 var processorFactories = make(map[string]Factory)
 
-// RegisterProcessorFactory registers a processor factory.
-func RegisterProcessorFactory(factory Factory) error {
+// RegisterFactory registers a processor factory.
+func RegisterFactory(factory Factory) error {
 	if processorFactories[factory.Type()] != nil {
 		panic(fmt.Sprintf("duplicate processor factory %q", factory.Type()))
 	}
@@ -57,7 +57,7 @@ func RegisterProcessorFactory(factory Factory) error {
 	return nil
 }
 
-// GetProcessorFactory gets a processor factory by type string.
-func GetProcessorFactory(typeStr string) Factory {
+// GetFactory gets a processor factory by type string.
+func GetFactory(typeStr string) Factory {
 	return processorFactories[typeStr]
 }
diff --git a/processor/factory_test.go b/processor/factory_test.go
@@ -24,21 +24,21 @@ import (
 	"github.com/open-telemetry/opentelemetry-service/models"
 )
 
-type ExampleProcessorFactory struct {
+type TestFactory struct {
 }
 
 // Type gets the type of the Processor config created by this factory.
-func (f *ExampleProcessorFactory) Type() string {
+func (f *TestFactory) Type() string {
 	return "exampleoption"
 }
 
 // CreateDefaultConfig creates the default configuration for the Processor.
-func (f *ExampleProcessorFactory) CreateDefaultConfig() models.Processor {
+func (f *TestFactory) CreateDefaultConfig() models.Processor {
 	return nil
 }
 
 // CreateTraceProcessor creates a trace processor based on this config.
-func (f *ExampleProcessorFactory) CreateTraceProcessor(
+func (f *TestFactory) CreateTraceProcessor(
 	logger *zap.Logger,
 	nextConsumer consumer.TraceConsumer,
 	cfg models.Processor,
@@ -47,7 +47,7 @@ func (f *ExampleProcessorFactory) CreateTraceProcessor(
 }
 
 // CreateMetricsProcessor creates a metrics processor based on this config.
-func (f *ExampleProcessorFactory) CreateMetricsProcessor(
+func (f *TestFactory) CreateMetricsProcessor(
 	logger *zap.Logger,
 	nextConsumer consumer.MetricsConsumer,
 	cfg models.Processor,
@@ -56,13 +56,13 @@ func (f *ExampleProcessorFactory) CreateMetricsProcessor(
 }
 
 func TestRegisterProcessorFactory(t *testing.T) {
-	f := ExampleProcessorFactory{}
-	err := RegisterProcessorFactory(&f)
+	f := TestFactory{}
+	err := RegisterFactory(&f)
 	if err != nil {
 		t.Fatalf("cannot register factory")
 	}
 
-	if &f != GetProcessorFactory(f.Type()) {
+	if &f != GetFactory(f.Type()) {
 		t.Fatalf("cannot find factory")
 	}
 
@@ -75,7 +75,7 @@ func TestRegisterProcessorFactory(t *testing.T) {
 			}
 		}()
 
-		err = RegisterProcessorFactory(&f)
+		err = RegisterFactory(&f)
 	}()
 
 	if !paniced {

Original file line number	Diff line number	Diff line change
`@@ -306,7 +306,7 @@ func loadProcessors(v *viper.Viper) (models.Processors, error) {`
`306`	`306`	`}`
`307`	`307`
`308`	`308`	`// Find processor factory based on "type" that we read from config source.`
`309`		`- factory := processor.GetProcessorFactory(typeStr)`
	`309`	`+ factory := processor.GetFactory(typeStr)`
`310`	`310`	`if factory == nil {`
`311`	`311`	`return nil, &configError{`
`312`	`312`	`code: errUnknownProcessorType,`
Original file line number	Diff line number	Diff line change
`@@ -330,6 +330,6 @@ func RegisterTestFactories() error {`
`330`	`330`	`_ = receiver.RegisterFactory(&ExampleReceiverFactory{})`
`331`	`331`	`_ = receiver.RegisterFactory(&MultiProtoReceiverFactory{})`
`332`	`332`	`_ = exporter.RegisterFactory(&ExampleExporterFactory{})`
`333`		`- _ = processor.RegisterProcessorFactory(&ExampleProcessorFactory{})`
	`333`	`+ _ = processor.RegisterFactory(&ExampleProcessorFactory{})`
`334`	`334`	`return nil`
`335`	`335`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,15 +26,15 @@ import (`
`26`	`26`	`)`
`27`	`27`
`28`	`28`	`func TestCreateDefaultConfig(t *testing.T) {`
`29`		`- factory := processor.GetProcessorFactory(typeStr)`
	`29`	`+ factory := processor.GetFactory(typeStr)`
`30`	`30`	`require.NotNil(t, factory)`
`31`	`31`
`32`	`32`	`cfg := factory.CreateDefaultConfig()`
`33`	`33`	`assert.NotNil(t, cfg, "failed to create default config")`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`func TestCreateProcessor(t *testing.T) {`
`37`		`- factory := processor.GetProcessorFactory(typeStr)`
	`37`	`+ factory := processor.GetFactory(typeStr)`
`38`	`38`	`require.NotNil(t, factory)`
`39`	`39`
`40`	`40`	`cfg := factory.CreateDefaultConfig()`