Rename noop to nop, add nop exporter, rename TraceDataExporter to TraceExporter. (#447)

* Rename noop to nop, add nop exporter, rename TraceDataExporter to TraceExporter.

* Rename pointers to match the new struct name.

* Change nop_processor comments.

* Cleanup more names and add tests.

Author: Bogdan Drutu

exporter/exportertest/nop_exporter.go

@@ -0,0 +1,51 @@
+// Copyright 2019, OpenCensus 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 exportertest
+
+import (
+	"context"
+
+	"github.com/census-instrumentation/opencensus-service/data"
+	"github.com/census-instrumentation/opencensus-service/exporter"
+)
+
+type nopExporter int
+
+var _ exporter.TraceExporter = (*nopExporter)(nil)
+var _ exporter.MetricsExporter = (*nopExporter)(nil)
+
+func (ne *nopExporter) ProcessTraceData(ctx context.Context, td data.TraceData) error {
+	return nil
+}
+
+func (ne *nopExporter) ProcessMetricsData(ctx context.Context, md data.MetricsData) error {
+	return nil
+}
+
+const nopExportFormat = "NopExporter"
+
+func (ne *nopExporter) ExportFormat() string {
+	return nopExportFormat
+}
+
+// NewNopTraceExporter creates an TraceExporter that just drops the received data.
+func NewNopTraceExporter() exporter.TraceExporter {
+	return new(nopExporter)
+}
+
+// NewNopMetricsExporter creates an MetricsExporter that just drops the received data.
+func NewNopMetricsExporter() exporter.MetricsExporter {
+	return new(nopExporter)
+}

…sor/processortest/noop_processor_test.go …porter/exportertest/nop_exporter_test.goprocessor/processortest/noop_processor_test.go renamed to exporter/exportertest/nop_exporter_test.go processor/processortest/noop_processor_test.go renamed to exporter/exportertest/nop_exporter_test.go

@@ -11,7 +11,7 @@
 // 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 processortest
+package exportertest
 
 import (
 	"context"
@@ -22,24 +22,32 @@ import (
 	"github.com/census-instrumentation/opencensus-service/data"
 )
 
-func TestNoopTraceDataProcessorNoErrors(t *testing.T) {
-	ntdp := NewNoopTraceDataProcessor()
+func TestNopTraceExporterNoErrors(t *testing.T) {
+	nte := NewNopTraceExporter()
 	td := data.TraceData{
 		Spans: make([]*tracepb.Span, 7),
 	}
-	if err := ntdp.ProcessTraceData(context.Background(), td); err != nil {
+	if err := nte.ProcessTraceData(context.Background(), td); err != nil {
 		t.Errorf("Wanted nil got error")
 		return
 	}
+	if "NopExporter" != nte.ExportFormat() {
+		t.Errorf("Wanted NopExporter got %s", nte.ExportFormat())
+		return
+	}
 }
 
-func TestNoopMetricsDataProcessorNoErrors(t *testing.T) {
-	nmdp := NewNoopMetricsDataProcessor()
+func TestNoopMetricsExporterNoErrors(t *testing.T) {
+	nme := NewNopMetricsExporter()
 	md := data.MetricsData{
 		Metrics: make([]*metricspb.Metric, 7),
 	}
-	if err := nmdp.ProcessMetricsData(context.Background(), md); err != nil {
+	if err := nme.ProcessMetricsData(context.Background(), md); err != nil {
 		t.Errorf("Wanted nil got error")
 		return
 	}
+	if "NopExporter" != nme.ExportFormat() {
+		t.Errorf("Wanted NopExporter got %s", nme.ExportFormat())
+		return
+	}
 }

exporter/exportertest/sink_exporter.go

@@ -0,0 +1,94 @@
+// Copyright 2018, OpenCensus 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 exportertest
+
+import (
+	"context"
+	"encoding/json"
+	"sync"
+
+	"github.com/census-instrumentation/opencensus-service/data"
+	"github.com/census-instrumentation/opencensus-service/exporter"
+)
+
+// SinkTraceExporter acts as a trace receiver for use in tests.
+type SinkTraceExporter struct {
+	mu     sync.Mutex
+	traces []data.TraceData
+}
+
+var _ exporter.TraceExporter = (*SinkTraceExporter)(nil)
+
+// ProcessTraceData stores traces for tests.
+func (ste *SinkTraceExporter) ProcessTraceData(ctx context.Context, td data.TraceData) error {
+	ste.mu.Lock()
+	defer ste.mu.Unlock()
+
+	ste.traces = append(ste.traces, td)
+
+	return nil
+}
+
+const sinkExportFormat = "SinkExporter"
+
+// ExportFormat retruns the name of this TraceExporter
+func (ste *SinkTraceExporter) ExportFormat() string {
+	return sinkExportFormat
+}
+
+// AllTraces returns the traces sent to the test sink.
+func (ste *SinkTraceExporter) AllTraces() []data.TraceData {
+	ste.mu.Lock()
+	defer ste.mu.Unlock()
+
+	return ste.traces[:]
+}
+
+// SinkMetricsExporter acts as a metrics receiver for use in tests.
+type SinkMetricsExporter struct {
+	mu      sync.Mutex
+	metrics []data.MetricsData
+}
+
+var _ exporter.MetricsExporter = (*SinkMetricsExporter)(nil)
+
+// ProcessMetricsData stores traces for tests.
+func (sme *SinkMetricsExporter) ProcessMetricsData(ctx context.Context, md data.MetricsData) error {
+	sme.mu.Lock()
+	defer sme.mu.Unlock()
+
+	sme.metrics = append(sme.metrics, md)
+
+	return nil
+}
+
+// ExportFormat retruns the name of this TraceExporter
+func (sme *SinkMetricsExporter) ExportFormat() string {
+	return sinkExportFormat
+}
+
+// AllMetrics returns the metrics sent to the test sink.
+func (sme *SinkMetricsExporter) AllMetrics() []data.MetricsData {
+	sme.mu.Lock()
+	defer sme.mu.Unlock()
+
+	return sme.metrics[:]
+}
+
+// ToJSON marshals a generic interface to JSON to enable easy comparisons.
+func ToJSON(v interface{}) []byte {
+	b, _ := json.MarshalIndent(v, "", "  ")
+	return b
+}

exporter/exportertest/sink_exporter_test.go

@@ -0,0 +1,70 @@
+// Copyright 2019, OpenCensus 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 exportertest
+
+import (
+	"context"
+	"reflect"
+	"testing"
+
+	metricspb "github.com/census-instrumentation/opencensus-proto/gen-go/metrics/v1"
+	tracepb "github.com/census-instrumentation/opencensus-proto/gen-go/trace/v1"
+	"github.com/census-instrumentation/opencensus-service/data"
+)
+
+func TestSinkTraceExporter(t *testing.T) {
+	sink := new(SinkTraceExporter)
+	td := data.TraceData{
+		Spans: make([]*tracepb.Span, 7),
+	}
+	want := make([]data.TraceData, 0, 7)
+	for i := 0; i < 7; i++ {
+		if err := sink.ProcessTraceData(context.Background(), td); err != nil {
+			t.Errorf("Wanted nil got error")
+			return
+		}
+		want = append(want, td)
+	}
+	got := sink.AllTraces()
+	if !reflect.DeepEqual(got, want) {
+		t.Errorf("Mismatches responses\nGot:\n\t%v\nWant:\n\t%v\n", got, want)
+	}
+	if "SinkExporter" != sink.ExportFormat() {
+		t.Errorf("Wanted SinkExporter got %s", sink.ExportFormat())
+		return
+	}
+}
+
+func TestSinkMetricsExporter(t *testing.T) {
+	sink := new(SinkMetricsExporter)
+	md := data.MetricsData{
+		Metrics: make([]*metricspb.Metric, 7),
+	}
+	want := make([]data.MetricsData, 0, 7)
+	for i := 0; i < 7; i++ {
+		if err := sink.ProcessMetricsData(context.Background(), md); err != nil {
+			t.Errorf("Wanted nil got error")
+			return
+		}
+		want = append(want, md)
+	}
+	got := sink.AllMetrics()
+	if !reflect.DeepEqual(got, want) {
+		t.Errorf("Mismatches responses\nGot:\n\t%v\nWant:\n\t%v\n", got, want)
+	}
+	if "SinkExporter" != sink.ExportFormat() {
+		t.Errorf("Wanted SinkExporter got %s", sink.ExportFormat())
+		return
+	}
+}

exporter/factory.go

@@ -20,48 +20,48 @@ import (
 	"github.com/census-instrumentation/opencensus-service/processor"
 )
 
-// TraceDataExporter composes TraceDataProcessor with some additional
+// TraceExporter composes TraceDataProcessor with some additional
 // exporter-specific functions. This helps the service core to identify which
 // TraceDataProcessors are Exporters and which are internal processing
 // components, so that better validation of pipelines can be done.
-type TraceDataExporter interface {
+type TraceExporter interface {
 	processor.TraceDataProcessor
 
 	// ExportFormat gets the name of the format in which this exporter sends its data.
 	ExportFormat() string
 }
 
-// TraceDataExporterFactory is an interface that builds a new TraceDataExporter based on
+// TraceExporterFactory is an interface that builds a new TraceExporter based on
 // some viper.Viper configuration.
-type TraceDataExporterFactory interface {
-	// Type gets the type of the TraceDataExporter created by this factory.
+type TraceExporterFactory interface {
+	// Type gets the type of the TraceExporter created by this factory.
 	Type() string
-	// NewFromViper takes a viper.Viper config and creates a new TraceDataExporter.
-	NewFromViper(cfg *viper.Viper) (TraceDataExporter, error)
-	// DefaultConfig returns the default configuration for TraceDataExporter
+	// NewFromViper takes a viper.Viper config and creates a new TraceExporter.
+	NewFromViper(cfg *viper.Viper) (TraceExporter, error)
+	// DefaultConfig returns the default configuration for TraceExporter
 	// created by this factory.
 	DefaultConfig() *viper.Viper
 }
 
-// MetricsDataExporter composes MetricsDataProcessor with some additional
+// MetricsExporter composes MetricsDataProcessor with some additional
 // exporter-specific functions. This helps the service core to identify which
 // MetricsDataProcessors are Exporters and which are internal processing
 // components, so that better validation of pipelines can be done.
-type MetricsDataExporter interface {
+type MetricsExporter interface {
 	processor.MetricsDataProcessor
 
 	// ExportFormat gets the name of the format in which this exporter sends its data.
 	ExportFormat() string
 }
 
-// MetricsDataExporterFactory is an interface that builds a new MetricsDataExporter based on
+// MetricsExporterFactory is an interface that builds a new MetricsExporter based on
 // some viper.Viper configuration.
-type MetricsDataExporterFactory interface {
-	// Type gets the type of the MetricsDataExporter created by this factory.
+type MetricsExporterFactory interface {
+	// Type gets the type of the MetricsExporter created by this factory.
 	Type() string
-	// NewFromViper takes a viper.Viper config and creates a new MetricsDataExporter.
-	NewFromViper(cfg *viper.Viper) (MetricsDataExporter, error)
-	// DefaultConfig returns the default configuration for MetricsDataExporter
+	// NewFromViper takes a viper.Viper config and creates a new MetricsExporter.
+	NewFromViper(cfg *viper.Viper) (MetricsExporter, error)
+	// DefaultConfig returns the default configuration for MetricsExporter
 	// created by this factory.
 	DefaultConfig() *viper.Viper
 }

exporter/loggingexporter/logging_exporter.go

@@ -27,18 +27,18 @@ const exportFormat = "LoggingExporter"
 // A logging exporter that does not sends the data to any destination but logs debugging messages.
 type loggingExporter struct{ logger *zap.Logger }
 
-var _ exporter.TraceDataExporter = (*loggingExporter)(nil)
-var _ exporter.MetricsDataExporter = (*loggingExporter)(nil)
+var _ exporter.TraceExporter = (*loggingExporter)(nil)
+var _ exporter.MetricsExporter = (*loggingExporter)(nil)
 
 func (sp *loggingExporter) ProcessTraceData(ctx context.Context, td data.TraceData) error {
 	// TODO: Record metrics
 	// TODO: Add ability to record the received data
-	sp.logger.Debug("loggingTraceDataExporter", zap.Int("#spans", len(td.Spans)))
+	sp.logger.Debug("loggingTraceExporter", zap.Int("#spans", len(td.Spans)))
 	return nil
 }
 
 func (sp *loggingExporter) ProcessMetricsData(ctx context.Context, md data.MetricsData) error {
-	sp.logger.Debug("loggingMetricsDataExporter", zap.Int("#metrics", len(md.Metrics)))
+	sp.logger.Debug("loggingMetricsExporter", zap.Int("#metrics", len(md.Metrics)))
 	// TODO: Record metrics
 	// TODO: Add ability to record the received data
 	return nil
@@ -48,14 +48,14 @@ func (sp *loggingExporter) ExportFormat() string {
 	return exportFormat
 }
 
-// NewTraceExporter creates an exporter.TraceDataExporter that just drops the
+// NewTraceExporter creates an exporter.TraceExporter that just drops the
 // received data and logs debugging messages.
-func NewTraceExporter(logger *zap.Logger) exporter.TraceDataExporter {
+func NewTraceExporter(logger *zap.Logger) exporter.TraceExporter {
 	return &loggingExporter{logger: logger}
 }
 
-// NewMetricsExporter creates an exporter.MetricsDataExporter that just drops the
+// NewMetricsExporter creates an exporter.MetricsExporter that just drops the
 // received data and logs debugging messages.
-func NewMetricsExporter(logger *zap.Logger) exporter.MetricsDataExporter {
+func NewMetricsExporter(logger *zap.Logger) exporter.MetricsExporter {
 	return &loggingExporter{logger: logger}
 }