Compare metric descriptions at the Prometheus matcher

cloudfoundry · Dec 23, 2017 · 81fb3d6 · 81fb3d6
1 parent ef96f16
commit 81fb3d6
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 8 deletions.
diff --git a/utils/test_matchers/prometheus_metric_matcher.go b/utils/test_matchers/prometheus_metric_matcher.go
@@ -16,12 +16,14 @@ func PrometheusMetric(expected prometheus.Metric) types.GomegaMatcher {
 	expected.Write(expectedMetric)
 
 	return &PrometheusMetricMatcher{
-		Expected: expectedMetric,
+		Desc:   expected.Desc(),
+		Metric: expectedMetric,
 	}
 }
 
 type PrometheusMetricMatcher struct {
-	Expected *dto.Metric
+	Desc   *prometheus.Desc
+	Metric *dto.Metric
 }
 
 func (matcher *PrometheusMetricMatcher) Match(actual interface{}) (success bool, err error) {
@@ -33,20 +35,28 @@ func (matcher *PrometheusMetricMatcher) Match(actual interface{}) (success bool,
 	actualMetric := &dto.Metric{}
 	metric.Write(actualMetric)
 
-	return reflect.DeepEqual(actualMetric.String(), matcher.Expected.String()), nil
+	if !reflect.DeepEqual(metric.Desc().String(), matcher.Desc.String()) {
+		return false, nil
+	}
+
+	return reflect.DeepEqual(actualMetric.String(), matcher.Metric.String()), nil
 }
 
 func (matcher *PrometheusMetricMatcher) FailureMessage(actual interface{}) (message string) {
 	metric, ok := actual.(prometheus.Metric)
 	if ok {
 		actualMetric := &dto.Metric{}
 		metric.Write(actualMetric)
-		return format.Message(actualMetric.String(), "to equal", matcher.Expected.String())
+		return format.Message(
+			fmt.Sprintf("\n%s\nMetric{%s}", metric.Desc().String(), actualMetric.String()),
+			"to equal",
+			fmt.Sprintf("\n%s\nMetric{%s}", matcher.Desc.String(), matcher.Metric.String()),
+		)
 	}
 
-	return format.Message(actual, "to equal", matcher.Expected)
+	return format.Message(actual, "to equal", matcher)
 }
 
 func (matcher *PrometheusMetricMatcher) NegatedFailureMessage(actual interface{}) (message string) {
-	return format.Message(actual, "not to equal", matcher.Expected)
+	return format.Message(actual, "not to equal", matcher)
 }
diff --git a/utils/test_matchers/prometheus_metric_matcher_test.go b/utils/test_matchers/prometheus_metric_matcher_test.go
@@ -185,7 +185,7 @@ var _ = Describe("PrometheusMetric", func() {
 			)
 			actualMetric.WithLabelValues(metricLabelValue).Observe(float64(1))
 
-			Expect(expectedMetric.WithLabelValues(metricLabelValue)).To(PrometheusMetric(actualMetric.WithLabelValues(metricLabelValue)))
+			Expect(expectedMetric.WithLabelValues(metricLabelValue)).To(PrometheusMetric(actualMetric.MetricVec.WithLabelValues(metricLabelValue)))
 		})
 	})
 
@@ -241,7 +241,7 @@ var _ = Describe("PrometheusMetric", func() {
 			)
 			actualMetric.WithLabelValues(metricLabelValue).Observe(float64(1))
 
-			Expect(expectedMetric.WithLabelValues(metricLabelValue)).To(PrometheusMetric(actualMetric.WithLabelValues(metricLabelValue)))
+			Expect(expectedMetric.WithLabelValues(metricLabelValue)).To(PrometheusMetric(actualMetric.MetricVec.WithLabelValues(metricLabelValue)))
 		})
 	})
 })