1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
package metadatahandler
import (
"context"
"fmt"
"testing"
"time"
grpcmwtags "github.com/grpc-ecosystem/go-grpc-middleware/tags"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper"
"gitlab.com/gitlab-org/labkit/correlation"
"google.golang.org/grpc/metadata"
)
const (
correlationID = "CORRELATION_ID"
clientName = "CLIENT_NAME"
)
func TestAddMetadataTags(t *testing.T) {
baseContext := testhelper.Context(t)
testCases := []struct {
desc string
metadata metadata.MD
deadline bool
expectedMetatags metadataTags
}{
{
desc: "empty metadata",
metadata: metadata.Pairs(),
deadline: false,
expectedMetatags: metadataTags{
clientName: unknownValue,
callSite: unknownValue,
authVersion: unknownValue,
deadlineType: "none",
},
},
{
desc: "context containing metadata",
metadata: metadata.Pairs("call_site", "testsite"),
deadline: false,
expectedMetatags: metadataTags{
clientName: unknownValue,
callSite: "testsite",
authVersion: unknownValue,
deadlineType: "none",
},
},
{
desc: "context containing metadata and a deadline",
metadata: metadata.Pairs("call_site", "testsite"),
deadline: true,
expectedMetatags: metadataTags{
clientName: unknownValue,
callSite: "testsite",
authVersion: unknownValue,
deadlineType: unknownValue,
},
},
{
desc: "context containing metadata and a deadline type",
metadata: metadata.Pairs("deadline_type", "regular"),
deadline: true,
expectedMetatags: metadataTags{
clientName: unknownValue,
callSite: unknownValue,
authVersion: unknownValue,
deadlineType: "regular",
},
},
{
desc: "a context without deadline but with deadline type",
metadata: metadata.Pairs("deadline_type", "regular"),
deadline: false,
expectedMetatags: metadataTags{
clientName: unknownValue,
callSite: unknownValue,
authVersion: unknownValue,
deadlineType: "none",
},
},
{
desc: "with a context containing metadata",
metadata: metadata.Pairs("deadline_type", "regular", "client_name", "rails"),
deadline: true,
expectedMetatags: metadataTags{
clientName: "rails",
callSite: unknownValue,
authVersion: unknownValue,
deadlineType: "regular",
},
},
}
for _, testCase := range testCases {
t.Run(testCase.desc, func(t *testing.T) {
ctx := metadata.NewIncomingContext(baseContext, testCase.metadata)
if testCase.deadline {
var cancel func()
//nolint:forbidigo // We explicitly need to test whether deadlines
// propagate as expected.
ctx, cancel = context.WithDeadline(ctx, time.Now().Add(50*time.Millisecond))
defer cancel()
}
require.Equal(t, testCase.expectedMetatags, addMetadataTags(ctx, "unary"))
})
}
}
func verifyHandler(ctx context.Context, req interface{}) (interface{}, error) {
require, ok := req.(*require.Assertions)
if !ok {
return nil, fmt.Errorf("unexpected type conversion failure")
}
metaTags := addMetadataTags(ctx, "unary")
require.Equal(clientName, metaTags.clientName)
tags := grpcmwtags.Extract(ctx)
require.True(tags.Has(CorrelationIDKey))
require.True(tags.Has(ClientNameKey))
values := tags.Values()
require.Equal(correlationID, values[CorrelationIDKey])
require.Equal(clientName, values[ClientNameKey])
return nil, nil
}
func TestGRPCTags(t *testing.T) {
ctx := testhelper.Context(t)
require := require.New(t)
ctx = metadata.NewIncomingContext(
correlation.ContextWithCorrelation(
correlation.ContextWithClientName(
ctx,
clientName,
),
correlationID,
),
metadata.Pairs(),
)
interceptor := grpcmwtags.UnaryServerInterceptor()
_, err := interceptor(ctx, require, nil, verifyHandler)
require.NoError(err)
}
func Test_extractServiceName(t *testing.T) {
tests := []struct {
name string
fullMethodName string
wantService, wantMethod string
}{
{
name: "blank",
fullMethodName: "",
wantService: unknownValue,
wantMethod: unknownValue,
},
{
name: "normal",
fullMethodName: "/gitaly.OperationService/method",
wantService: "gitaly.OperationService",
wantMethod: "method",
},
{
name: "malformed",
fullMethodName: "//method",
wantService: "",
wantMethod: "method",
},
{
name: "malformed",
fullMethodName: "/gitaly.OperationService/",
wantService: "gitaly.OperationService",
wantMethod: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
gotService, gotMethod := extractServiceAndMethodName(tt.fullMethodName)
assert.Equal(t, tt.wantService, gotService)
assert.Equal(t, tt.wantMethod, gotMethod)
})
}
}
|
