Files
threshold/internal/daemon/worker/internal/metric/cluster_client_test.go
T
HaotianandTodd 5c715478e4 feat(workers): Add metrics for worker server-side grpc connections, refactor repeated code into common location (#2367)
* feat(workers): added latencies histogram for server side multihop workers

* refactor(daemon): combine common grpc metric functions into daemon/internal/metric

Co-authored-by: Todd <github@quaddi.com>
2022-09-06 13:40:52 -07:00

130 lines
4.1 KiB
Go

package metric
import (
"context"
"fmt"
"testing"
"time"
metric "github.com/hashicorp/boundary/internal/daemon/internal/metric"
"github.com/prometheus/client_golang/prometheus"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/types/known/wrapperspb"
)
func TestInitializeClusterClientCollectors(t *testing.T) {
require.NotPanics(t, func() { InitializeClusterClientCollectors(nil) })
require.NotPanics(t, func() { InitializeClusterClientCollectors(prometheus.NewRegistry()) })
}
func TestRecorder(t *testing.T) {
cases := []struct {
name string
methodName string
err error
wantedLabels prometheus.Labels
}{
{
name: "basic",
methodName: "/some.service.path/method",
err: nil,
wantedLabels: map[string]string{
metric.LabelGrpcCode: "OK",
metric.LabelGrpcMethod: "method",
metric.LabelGrpcService: "some.service.path",
},
},
{
name: "unrecognized method path format",
methodName: "unrecognized",
err: nil,
wantedLabels: map[string]string{
metric.LabelGrpcCode: "OK",
metric.LabelGrpcMethod: "unknown",
metric.LabelGrpcService: "unknown",
},
},
{
name: "cancel error",
methodName: "/some.service.path/method",
err: status.Error(codes.Canceled, ""),
wantedLabels: map[string]string{
metric.LabelGrpcCode: "Canceled",
metric.LabelGrpcMethod: "method",
metric.LabelGrpcService: "some.service.path",
},
},
{
name: "permission error",
methodName: "/some.service.path/method",
err: status.Error(codes.PermissionDenied, ""),
wantedLabels: map[string]string{
metric.LabelGrpcCode: "PermissionDenied",
metric.LabelGrpcMethod: "method",
metric.LabelGrpcService: "some.service.path",
},
},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
ogReqLatency := grpcRequestLatency
defer func() { grpcRequestLatency = ogReqLatency }()
testableLatency := &metric.TestableObserverVec{}
start := time.Now()
tested := newRequestRecorder(tc.methodName, testableLatency)
tested.Record(tc.err)
require.Len(t, testableLatency.Observations, 1)
assert.Greater(t, testableLatency.Observations[0].Observation, float64(0))
assert.LessOrEqual(t, testableLatency.Observations[0].Observation, time.Since(start).Seconds())
assert.Equal(t, testableLatency.Observations[0].Labels, tc.wantedLabels)
})
}
}
func TestInstrumentClusterClient(t *testing.T) {
ogReqLatency := grpcRequestLatency
defer func() { grpcRequestLatency = ogReqLatency }()
testableLatency := &metric.TestableObserverVec{}
grpcRequestLatency = testableLatency
interceptor := InstrumentClusterClient()
i := &metric.TestInvoker{T: t, RetErr: nil}
start := time.Now()
err := interceptor(context.Background(), "/some.service.path/method", wrapperspb.Bytes([]byte{1}), nil, nil, i.Invoke, []grpc.CallOption{}...)
require.NoError(t, err)
require.True(t, i.Called)
require.Len(t, testableLatency.Observations, 1)
assert.Greater(t, testableLatency.Observations[0].Observation, float64(0))
assert.LessOrEqual(t, testableLatency.Observations[0].Observation, time.Since(start).Seconds())
}
func TestInstrumentClusterClient_InvokerError(t *testing.T) {
ogReqLatency := grpcRequestLatency
defer func() { grpcRequestLatency = ogReqLatency }()
testableLatency := &metric.TestableObserverVec{}
grpcRequestLatency = testableLatency
interceptor := InstrumentClusterClient()
i := &metric.TestInvoker{T: t, RetErr: fmt.Errorf("oops!")}
start := time.Now()
err := interceptor(context.Background(), "/some.service.path/method", wrapperspb.Bytes([]byte{1}), nil, nil, i.Invoke, []grpc.CallOption{}...)
require.EqualError(t, err, "oops!")
require.True(t, i.Called)
// We still assert request latency in error states.
require.Len(t, testableLatency.Observations, 1)
assert.Greater(t, testableLatency.Observations[0].Observation, float64(0))
assert.LessOrEqual(t, testableLatency.Observations[0].Observation, time.Since(start).Seconds())
}