Add tests for intereceptor

Author: easyCZ

interceptor_test.go

@@ -0,0 +1,91 @@
+package connect_go_prometheus
+
+import (
+	"context"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/bufbuild/connect-go"
+	"github.com/easyCZ/connect-go-prometheus/gen/greet"
+	"github.com/easyCZ/connect-go-prometheus/gen/greet/greetconnect"
+	prom "github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/testutil"
+	"github.com/stretchr/testify/require"
+)
+
+func TestInterceptor_WithHistogram(t *testing.T) {
+	reg := prom.NewRegistry()
+	opts := []MetricsOption{
+		WithHistogram(true),
+		WithNamespace("namespace"),
+		WithSubsystem("subsystem"),
+		WithConstLabels(prom.Labels{"component": "foo"}),
+		WithHistogramBuckets([]float64{1, 5}),
+	}
+	clientMetrics := NewClientMetrics(opts...)
+	serverMetrics := NewServerMetrics(opts...)
+
+	reg.MustRegister(clientMetrics, serverMetrics)
+
+	intereceptor := NewInterceptor(clientMetrics, serverMetrics)
+
+	_, handler := greetconnect.NewGreetServiceHandler(greetconnect.UnimplementedGreetServiceHandler{}, connect.WithInterceptors(intereceptor))
+	srv := httptest.NewServer(handler)
+
+	client := greetconnect.NewGreetServiceClient(http.DefaultClient, srv.URL, connect.WithInterceptors(intereceptor))
+	_, err := client.Greet(context.Background(), connect.NewRequest(&greet.GreetRequest{
+		Name: "elza",
+	}))
+	require.Error(t, err)
+	require.Equal(t, connect.CodeOf(err), connect.CodeUnimplemented)
+
+	expectedMetrics := []string{
+		"namespace_subsystem_connect_client_handled_seconds",
+		"namespace_subsystem_connect_client_handled_total",
+		"namespace_subsystem_connect_client_started_total",
+
+		"namespace_subsystem_connect_server_handled_seconds",
+		"namespace_subsystem_connect_server_handled_total",
+		"namespace_subsystem_connect_server_started_total",
+	}
+	count, err := testutil.GatherAndCount(reg, expectedMetrics...)
+	require.NoError(t, err)
+	require.Equal(t, len(expectedMetrics), count)
+}
+
+func TestInterceptor_WithoutHistogram(t *testing.T) {
+	reg := prom.NewRegistry()
+	opts := []MetricsOption{
+		WithNamespace("namespace"),
+		WithSubsystem("subsystem"),
+		WithConstLabels(prom.Labels{"component": "foo"}),
+	}
+	clientMetrics := NewClientMetrics(opts...)
+	serverMetrics := NewServerMetrics(opts...)
+
+	reg.MustRegister(clientMetrics, serverMetrics)
+
+	intereceptor := NewInterceptor(clientMetrics, serverMetrics)
+
+	_, handler := greetconnect.NewGreetServiceHandler(greetconnect.UnimplementedGreetServiceHandler{}, connect.WithInterceptors(intereceptor))
+	srv := httptest.NewServer(handler)
+
+	client := greetconnect.NewGreetServiceClient(http.DefaultClient, srv.URL, connect.WithInterceptors(intereceptor))
+	_, err := client.Greet(context.Background(), connect.NewRequest(&greet.GreetRequest{
+		Name: "elza",
+	}))
+	require.Error(t, err)
+	require.Equal(t, connect.CodeOf(err), connect.CodeUnimplemented)
+
+	expectedMetrics := []string{
+		"namespace_subsystem_connect_client_handled_total",
+		"namespace_subsystem_connect_client_started_total",
+
+		"namespace_subsystem_connect_server_handled_total",
+		"namespace_subsystem_connect_server_started_total",
+	}
+	count, err := testutil.GatherAndCount(reg, expectedMetrics...)
+	require.NoError(t, err)
+	require.Equal(t, len(expectedMetrics), count)
+}

metrics.go

@@ -83,29 +83,30 @@ func NewClientMetrics(opts ...MetricsOption) *Metrics {
 	return m
 }
 
+var _ prom.Collector = (*Metrics)(nil)
+
 type Metrics struct {
 	requestStarted        *prom.CounterVec
 	requestHandled        *prom.CounterVec
 	requestHandledSeconds *prom.HistogramVec
 }
 
-// Register registers the ClientMetrics with a prometheus.Registry
-func (m *Metrics) Register(registry *prom.Registry) error {
-	if err := registry.Register(m.requestStarted); err != nil {
-		return err
-	}
-
-	if err := registry.Register(m.requestHandled); err != nil {
-		return err
+// Describe implements Describe as required by prom.Collector
+func (m *Metrics) Describe(c chan<- *prom.Desc) {
+	m.requestStarted.Describe(c)
+	m.requestHandled.Describe(c)
+	if m.requestHandledSeconds != nil {
+		m.requestHandledSeconds.Describe(c)
 	}
+}
 
+// Collect implements collect as required by prom.Collector
+func (m *Metrics) Collect(c chan<- prom.Metric) {
+	m.requestStarted.Collect(c)
+	m.requestHandled.Collect(c)
 	if m.requestHandledSeconds != nil {
-		if err := registry.Register(m.requestHandledSeconds); err != nil {
-			return err
-		}
+		m.requestHandledSeconds.Collect(c)
 	}
-
-	return nil
 }
 
 func (m *Metrics) ReportStarted(callType, service, method string) {

metrics_test.go

@@ -20,7 +20,7 @@ func TestServerMetrics(t *testing.T) {
 		WithConstLabels(prom.Labels{"component": "foo"}),
 		WithHistogramBuckets([]float64{0.5, 1, 1.5}),
 	)
-	require.NoError(t, sm.Register(reg))
+	require.NoError(t, reg.Register(sm))
 
 	started := sm.requestStarted.WithLabelValues("unary", greetconnect.GreetServiceName, "Greet")
 	started.Inc()
@@ -50,28 +50,28 @@ func TestServerMetrics(t *testing.T) {
 
 func TestClientMetrics(t *testing.T) {
 	reg := prom.NewRegistry()
-	sm := NewClientMetrics(
+	cm := NewClientMetrics(
 		WithHistogram(true),
 		WithNamespace("namespace"),
 		WithSubsystem("subsystem"),
 		WithConstLabels(prom.Labels{"component": "foo"}),
 		WithHistogramBuckets([]float64{0.5, 1, 1.5}),
 	)
-	require.NoError(t, sm.Register(reg))
+	require.NoError(t, reg.Register(cm))
 
-	started := sm.requestStarted.WithLabelValues("unary", greetconnect.GreetServiceName, "Greet")
+	started := cm.requestStarted.WithLabelValues("unary", greetconnect.GreetServiceName, "Greet")
 	started.Inc()
 	require.EqualValues(t, float64(1), testutil.ToFloat64(started))
 
-	handled := sm.requestHandled.WithLabelValues("unary", greetconnect.GreetServiceName, "Greet", connect.CodeAborted.String())
+	handled := cm.requestHandled.WithLabelValues("unary", greetconnect.GreetServiceName, "Greet", connect.CodeAborted.String())
 	handled.Inc()
 	require.EqualValues(t, 1, testutil.ToFloat64(handled))
 
-	if sm.requestHandledSeconds != nil {
-		handledHist := sm.requestHandledSeconds.WithLabelValues("unary", greetconnect.GreetServiceName, "Greet", connect.CodeAborted.String())
+	if cm.requestHandledSeconds != nil {
+		handledHist := cm.requestHandledSeconds.WithLabelValues("unary", greetconnect.GreetServiceName, "Greet", connect.CodeAborted.String())
 		handledHist.Observe(1)
 
-		err := testutil.CollectAndCompare(sm.requestHandledSeconds, strings.NewReader(`
+		err := testutil.CollectAndCompare(cm.requestHandledSeconds, strings.NewReader(`
 			# HELP namespace_subsystem_connect_client_handled_seconds Histogram of RPCs handled client-side
 			# TYPE namespace_subsystem_connect_client_handled_seconds histogram
 			namespace_subsystem_connect_client_handled_seconds_bucket{code="aborted",component="foo",method="Greet",service="greet.v1.GreetService",type="unary",le="0.5"} 0