Use cmp instead of reflect and json in tests. (#122)

* Use cmp instead of reflect and json in tests.

* Add test ID to error message.

Author: songy23

equivalence_test.go

@@ -16,10 +16,8 @@ package stackdriver
 
 import (
 	"context"
-	"encoding/json"
 	"errors"
 	"net"
-	"reflect"
 	"sync"
 	"testing"
 	"time"
@@ -103,17 +101,16 @@ func TestStatsAndMetricsEquivalence(t *testing.T) {
 		if err != nil {
 			t.Errorf("#%d: Stats.protoMetricDescriptorToMetricDescriptor: %v", i, err)
 		}
-		if !reflect.DeepEqual(sMD, pMD) {
-			t.Errorf("MetricDescriptor Mismatch\nStats MetricDescriptor:\n\t%v\nProto MetricDescriptor:\n\t%v\n", sMD, pMD)
+		if diff := cmpMDReq(pMD, sMD); diff != "" {
+			t.Fatalf("MetricDescriptor Mismatch -FromMetrics +FromStats: %s", diff)
 		}
 
 		vdl := []*view.Data{vd}
 		sctreql := se.makeReq(vdl, maxTimeSeriesPerUpload)
 		tsl, _ := se.protoMetricToTimeSeries(ctx, last.Node, last.Resource, last.Metrics[0])
 		pctreql := se.combineTimeSeriesToCreateTimeSeriesRequest(tsl)
-		if !reflect.DeepEqual(sctreql, pctreql) {
-			t.Errorf("#%d: TimeSeries Mismatch\nStats CreateTimeSeriesRequest:\n\t%v\nProto CreateTimeSeriesRequest:\n\t%v\n",
-				i, sctreql, pctreql)
+		if diff := cmpTSReqs(pctreql, sctreql); diff != "" {
+			t.Fatalf("TimeSeries Mismatch -FromMetrics +FromStats: %s", diff)
 		}
 	}
 }
@@ -277,18 +274,13 @@ func TestEquivalenceStatsVsMetricsUploads(t *testing.T) {
 	})
 
 	// The results should be equal now
-	if !reflect.DeepEqual(stackdriverTimeSeriesFromMetrics, stackdriverTimeSeriesFromStats) {
-		blobFromMetrics := jsonBlob(stackdriverTimeSeriesFromMetrics)
-		blobFromStats := jsonBlob(stackdriverTimeSeriesFromStats)
-		t.Errorf("StackdriverTimeSeriesFromMetrics (%d):\n%s\n\nStackdriverTimeSeriesFromStats (%d):\n%s\n\n",
-			len(stackdriverTimeSeriesFromMetrics), blobFromMetrics,
-			len(stackdriverTimeSeriesFromStats), blobFromStats)
+	if diff := cmpTSReqs(stackdriverTimeSeriesFromMetrics, stackdriverTimeSeriesFromStats); diff != "" {
+		t.Fatalf("Unexpected CreateTimeSeriesRequests -FromMetrics +FromStats: %s", diff)
 	}
 
 	// Examining the metric descriptors too.
-	if !reflect.DeepEqual(stackdriverMetricDescriptorsFromMetrics, stackdriverMetricDescriptorsFromStats) {
-		t.Errorf("StackdriverMetricDescriptorsFromMetrics:\n%v\nStackdriverMetricDescriptors:\n%v\n\n",
-			stackdriverMetricDescriptorsFromMetrics, stackdriverMetricDescriptorsFromStats)
+	if diff := cmpMDReqs(stackdriverMetricDescriptorsFromMetrics, stackdriverMetricDescriptorsFromStats); diff != "" {
+		t.Fatalf("Unexpected CreateMetricDescriptorRequests -FromMetrics +FromStats: %s", diff)
 	}
 }
 
@@ -425,8 +417,3 @@ func (ma *metricsAgent) GetMonitoredResourceDescriptor(ctx context.Context, req
 func (ma *metricsAgent) ListMonitoredResourceDescriptors(ctx context.Context, req *monitoringpb.ListMonitoredResourceDescriptorsRequest) (*monitoringpb.ListMonitoredResourceDescriptorsResponse, error) {
 	return new(monitoringpb.ListMonitoredResourceDescriptorsResponse), nil
 }
-
-func jsonBlob(v interface{}) []byte {
-	blob, _ := json.MarshalIndent(v, "", "   ")
-	return blob
-}

metrics_proto_test.go

@@ -16,14 +16,13 @@ package stackdriver
 
 import (
 	"context"
-	"encoding/json"
-	"reflect"
 	"strings"
 	"testing"
 
 	monitoring "cloud.google.com/go/monitoring/apiv3"
 	"github.com/golang/protobuf/ptypes/timestamp"
 	distributionpb "google.golang.org/genproto/googleapis/api/distribution"
+	labelpb "google.golang.org/genproto/googleapis/api/label"
 	googlemetricpb "google.golang.org/genproto/googleapis/api/metric"
 	monitoredrespb "google.golang.org/genproto/googleapis/api/monitoredres"
 	monitoringpb "google.golang.org/genproto/googleapis/monitoring/v3"
@@ -71,11 +70,8 @@ func TestProtoResourceToMonitoringResource(t *testing.T) {
 
 	for i, tt := range tests {
 		got := protoResourceToMonitoredResource(tt.in)
-		if !reflect.DeepEqual(got, tt.want) {
-			gj, wj := serializeAsJSON(got), serializeAsJSON(tt.want)
-			if gj != wj {
-				t.Errorf("#%d: Unmatched JSON\nGot:\n\t%s\nWant:\n\t%s", i, gj, wj)
-			}
+		if diff := cmpResource(got, tt.want); diff != "" {
+			t.Fatalf("Test %d failed. Unexpected Resource -got +want: %s", i, diff)
 		}
 	}
 }
@@ -141,7 +137,8 @@ func TestProtoMetricToCreateTimeSeriesRequest(t *testing.T) {
 					TimeSeries: []*monitoringpb.TimeSeries{
 						{
 							Metric: &googlemetricpb.Metric{
-								Type: "custom.googleapis.com/opencensus/with_metric_descriptor",
+								Type:   "custom.googleapis.com/opencensus/with_metric_descriptor",
+								Labels: map[string]string{},
 							},
 							Resource: &monitoredrespb.MonitoredResource{
 								Type: "global",
@@ -196,13 +193,10 @@ func TestProtoMetricToCreateTimeSeriesRequest(t *testing.T) {
 		}
 
 		got := se.combineTimeSeriesToCreateTimeSeriesRequest(tsl)
-		if !reflect.DeepEqual(got, tt.want) {
-			// Our saving grace is serialization equality since some
-			// unexported fields could be present in the various values.
-			gj, wj := serializeAsJSON(got), serializeAsJSON(tt.want)
-			if gj != wj {
-				t.Errorf("#%d: Unmatched JSON\nGot:\n\t%s\nWant:\n\t%s", i, gj, wj)
-			}
+		// Our saving grace is serialization equality since some
+		// unexported fields could be present in the various values.
+		if diff := cmpTSReqs(got, tt.want); diff != "" {
+			t.Fatalf("Test %d failed. Unexpected CreateTimeSeriesRequests -got +want: %s", i, diff)
 		}
 	}
 }
@@ -234,6 +228,7 @@ func TestProtoToMonitoringMetricDescriptor(t *testing.T) {
 			want: &googlemetricpb.MetricDescriptor{
 				Name:        "projects/test/metricDescriptors/custom.googleapis.com/opencensus/with_metric_descriptor",
 				Type:        "custom.googleapis.com/opencensus/with_metric_descriptor",
+				Labels:      []*labelpb.LabelDescriptor{},
 				DisplayName: "OpenCensus/with_metric_descriptor",
 				Description: "This is with metric descriptor",
 				Unit:        "By",
@@ -259,13 +254,10 @@ func TestProtoToMonitoringMetricDescriptor(t *testing.T) {
 			continue
 		}
 
-		if !reflect.DeepEqual(got, tt.want) {
-			// Our saving grace is serialization equality since some
-			// unexported fields could be present in the various values.
-			gj, wj := serializeAsJSON(got), serializeAsJSON(tt.want)
-			if gj != wj {
-				t.Errorf("#%d: Unmatched JSON\nGot:\n\t%s\nWant:\n\t%s", i, gj, wj)
-			}
+		// Our saving grace is serialization equality since some
+		// unexported fields could be present in the various values.
+		if diff := cmpMD(got, tt.want); diff != "" {
+			t.Fatalf("Test %d failed. Unexpected MetricDescriptor -got +want: %s", i, diff)
 		}
 	}
 }
@@ -374,13 +366,10 @@ func TestProtoMetricsToMonitoringMetrics_fromProtoPoint(t *testing.T) {
 			continue
 		}
 
-		if g, w := mpt, tt.want; !reflect.DeepEqual(g, w) {
-			// Our saving grace is serialization equality since some
-			// unexported fields could be present in the various values.
-			gj, wj := serializeAsJSON(g), serializeAsJSON(w)
-			if gj != wj {
-				t.Errorf("#%d: Unmatched JSON\nGot:\n\t%s\nWant:\n\t%s", i, gj, wj)
-			}
+		// Our saving grace is serialization equality since some
+		// unexported fields could be present in the various values.
+		if diff := cmpPoint(mpt, tt.want); diff != "" {
+			t.Fatalf("Test %d failed. Unexpected Point -got +want: %s", i, diff)
 		}
 	}
 }
@@ -480,17 +469,8 @@ func TestCombineTimeSeriesAndDeduplication(t *testing.T) {
 
 	for i, tt := range tests {
 		got := se.combineTimeSeriesToCreateTimeSeriesRequest(tt.in)
-		want := tt.want
-		if !reflect.DeepEqual(got, want) {
-			gj, wj := serializeAsJSON(got), serializeAsJSON(want)
-			if gj != wj {
-				t.Errorf("#%d: Unmatched JSON\nGot:\n\t%s\nWant:\n\t%s", i, gj, wj)
-			}
+		if diff := cmpTSReqs(got, tt.want); diff != "" {
+			t.Fatalf("Test %d failed. Unexpected CreateTimeSeriesRequests -got +want: %s", i, diff)
 		}
 	}
 }
-
-func serializeAsJSON(v interface{}) string {
-	blob, _ := json.MarshalIndent(v, "", "  ")
-	return string(blob)
-}

metrics_test.go

@@ -16,19 +16,19 @@ package stackdriver
 
 import (
 	"context"
-	"reflect"
 	"strings"
 	"testing"
 
 	"github.com/golang/protobuf/ptypes/timestamp"
+
 	distributionpb "google.golang.org/genproto/googleapis/api/distribution"
+	labelpb "google.golang.org/genproto/googleapis/api/label"
 	googlemetricpb "google.golang.org/genproto/googleapis/api/metric"
 	monitoredrespb "google.golang.org/genproto/googleapis/api/monitoredres"
 	monitoringpb "google.golang.org/genproto/googleapis/monitoring/v3"
 
 	"go.opencensus.io/metric/metricdata"
 	"go.opencensus.io/resource"
-	"time"
 )
 
 var se = &statsExporter{
@@ -74,11 +74,8 @@ func TestMetricResourceToMonitoringResource(t *testing.T) {
 
 	for i, tt := range tests {
 		got := metricRscToMpbRsc(tt.in)
-		if !reflect.DeepEqual(got, tt.want) {
-			gj, wj := serializeAsJSON(got), serializeAsJSON(tt.want)
-			if gj != wj {
-				t.Errorf("#%d: Unmatched JSON\nGot:\n\t%s\nWant:\n\t%s", i, gj, wj)
-			}
+		if diff := cmpResource(got, tt.want); diff != "" {
+			t.Fatalf("Test %d failed. Unexpected Resource -got +want: %s", i, diff)
 		}
 	}
 }
@@ -136,7 +133,8 @@ func TestMetricToCreateTimeSeriesRequest(t *testing.T) {
 					TimeSeries: []*monitoringpb.TimeSeries{
 						{
 							Metric: &googlemetricpb.Metric{
-								Type: "custom.googleapis.com/opencensus/with_metric_descriptor",
+								Type:   "custom.googleapis.com/opencensus/with_metric_descriptor",
+								Labels: map[string]string{},
 							},
 							Resource: &monitoredrespb.MonitoredResource{
 								Type: "global",
@@ -207,7 +205,8 @@ func TestMetricToCreateTimeSeriesRequest(t *testing.T) {
 					TimeSeries: []*monitoringpb.TimeSeries{
 						{
 							Metric: &googlemetricpb.Metric{
-								Type: "custom.googleapis.com/opencensus/with_metric_descriptor",
+								Type:   "custom.googleapis.com/opencensus/with_metric_descriptor",
+								Labels: map[string]string{},
 							},
 							Resource: &monitoredrespb.MonitoredResource{
 								Type: "global",
@@ -258,13 +257,10 @@ func TestMetricToCreateTimeSeriesRequest(t *testing.T) {
 		}
 
 		got := se.combineTimeSeriesToCreateTimeSeriesRequest(tsl)
-		if !reflect.DeepEqual(got, tt.want) {
-			// Our saving grace is serialization equality since some
-			// unexported fields could be present in the various values.
-			gj, wj := serializeAsJSON(got), serializeAsJSON(tt.want)
-			if gj != wj {
-				t.Errorf("#%d: Unmatched JSON\nGot:\n\t%s\nWant:\n\t%s", i, gj, wj)
-			}
+		// Our saving grace is serialization equality since some
+		// unexported fields could be present in the various values.
+		if diff := cmpTSReqs(got, tt.want); diff != "" {
+			t.Fatalf("Test %d failed. Unexpected CreateTimeSeriesRequests -got +want: %s", i, diff)
 		}
 	}
 }
@@ -281,6 +277,7 @@ func TestMetricDescriptorToMonitoringMetricDescriptor(t *testing.T) {
 			want: &googlemetricpb.MetricDescriptor{
 				Name:        "projects/foo/metricDescriptors/custom.googleapis.com/opencensus",
 				Type:        "custom.googleapis.com/opencensus",
+				Labels:      []*labelpb.LabelDescriptor{},
 				DisplayName: "OpenCensus",
 				MetricKind:  googlemetricpb.MetricDescriptor_GAUGE,
 				ValueType:   googlemetricpb.MetricDescriptor_INT64,
@@ -298,6 +295,7 @@ func TestMetricDescriptorToMonitoringMetricDescriptor(t *testing.T) {
 			want: &googlemetricpb.MetricDescriptor{
 				Name:        "projects/foo/metricDescriptors/custom.googleapis.com/opencensus/with_metric_descriptor",
 				Type:        "custom.googleapis.com/opencensus/with_metric_descriptor",
+				Labels:      []*labelpb.LabelDescriptor{},
 				DisplayName: "OpenCensus/with_metric_descriptor",
 				Description: "This is with metric descriptor",
 				Unit:        "By",
@@ -321,13 +319,10 @@ func TestMetricDescriptorToMonitoringMetricDescriptor(t *testing.T) {
 			continue
 		}
 
-		if !reflect.DeepEqual(got, tt.want) {
-			// Our saving grace is serialization equality since some
-			// unexported fields could be present in the various values.
-			gj, wj := serializeAsJSON(got), serializeAsJSON(tt.want)
-			if gj != wj {
-				t.Errorf("#%d: Unmatched JSON\nGot:\n\t%s\nWant:\n\t%s", i, gj, wj)
-			}
+		// Our saving grace is serialization equality since some
+		// unexported fields could be present in the various values.
+		if diff := cmpMD(got, tt.want); diff != "" {
+			t.Fatalf("Test %d failed. Unexpected MetricDescriptor -got +want: %s", i, diff)
 		}
 	}
 }
@@ -505,21 +500,10 @@ func TestMetricsToMonitoringMetrics_fromProtoPoint(t *testing.T) {
 			continue
 		}
 
-		if g, w := mpt, tt.want; !reflect.DeepEqual(g, w) {
-			// Our saving grace is serialization equality since some
-			// unexported fields could be present in the various values.
-			gj, wj := serializeAsJSON(g), serializeAsJSON(w)
-			if gj != wj {
-				t.Errorf("#%d: Unmatched JSON\nGot:\n\t%s\nWant:\n\t%s", i, gj, wj)
-			}
+		// Our saving grace is serialization equality since some
+		// unexported fields could be present in the various values.
+		if diff := cmpPoint(mpt, tt.want); diff != "" {
+			t.Fatalf("Test %d failed. Unexpected Point -got +want: %s", i, diff)
 		}
 	}
 }
-
-func timestampToTime(ts *timestamp.Timestamp) time.Time {
-	if ts == nil {
-		return time.Unix(0, 0).UTC()
-	} else {
-		return time.Unix(ts.Seconds, int64(ts.Nanos)).UTC()
-	}
-}

metrics_test_utils.go

@@ -0,0 +1,63 @@
+// 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 stackdriver
+
+/*
+Common test utilities for comparing Stackdriver metrics.
+*/
+
+import (
+	"github.com/golang/protobuf/ptypes/timestamp"
+	"github.com/google/go-cmp/cmp"
+	"github.com/google/go-cmp/cmp/cmpopts"
+
+	googlemetricpb "google.golang.org/genproto/googleapis/api/metric"
+	monitoredrespb "google.golang.org/genproto/googleapis/api/monitoredres"
+	monitoringpb "google.golang.org/genproto/googleapis/monitoring/v3"
+
+	"time"
+)
+
+func timestampToTime(ts *timestamp.Timestamp) time.Time {
+	if ts == nil {
+		return time.Unix(0, 0).UTC()
+	} else {
+		return time.Unix(ts.Seconds, int64(ts.Nanos)).UTC()
+	}
+}
+
+func cmpResource(got, want *monitoredrespb.MonitoredResource) string {
+	return cmp.Diff(got, want, cmpopts.IgnoreUnexported(monitoredrespb.MonitoredResource{}))
+}
+
+func cmpTSReqs(got, want []*monitoringpb.CreateTimeSeriesRequest) string {
+	return cmp.Diff(got, want, cmpopts.IgnoreUnexported(monitoringpb.CreateTimeSeriesRequest{}))
+}
+
+func cmpMD(got, want *googlemetricpb.MetricDescriptor) string {
+	return cmp.Diff(got, want, cmpopts.IgnoreUnexported(googlemetricpb.MetricDescriptor{}))
+}
+
+func cmpMDReq(got, want *monitoringpb.CreateMetricDescriptorRequest) string {
+	return cmp.Diff(got, want, cmpopts.IgnoreUnexported(monitoringpb.CreateMetricDescriptorRequest{}))
+}
+
+func cmpMDReqs(got, want []*monitoringpb.CreateMetricDescriptorRequest) string {
+	return cmp.Diff(got, want, cmpopts.IgnoreUnexported(monitoringpb.CreateMetricDescriptorRequest{}))
+}
+
+func cmpPoint(got, want *monitoringpb.Point) string {
+	return cmp.Diff(got, want, cmpopts.IgnoreUnexported(monitoringpb.Point{}))
+}