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
|
package featureflag
import (
"context"
"gitlab.com/gitlab-org/gitaly/v15/structerr"
"net"
"testing"
grpcmw "github.com/grpc-ecosystem/go-grpc-middleware"
grpcmwlogrus "github.com/grpc-ecosystem/go-grpc-middleware/logging/logrus"
"github.com/sirupsen/logrus"
"github.com/sirupsen/logrus/hooks/test"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/v15/internal/log"
"gitlab.com/gitlab-org/gitaly/v15/internal/metadata/featureflag"
"gitlab.com/gitlab-org/gitaly/v15/internal/testhelper"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/test/grpc_testing"
)
type mockService struct {
grpc_testing.UnimplementedTestServiceServer
err error
}
func (m *mockService) UnaryCall(
context.Context, *grpc_testing.SimpleRequest,
) (*grpc_testing.SimpleResponse, error) {
return &grpc_testing.SimpleResponse{}, m.err
}
// This test doesn't use testhelper.NewFeatureSets intentionally.
func TestFeatureFlagLogs(t *testing.T) {
logger, loggerHook := test.NewNullLogger()
logger.SetLevel(logrus.InfoLevel)
listener, err := net.Listen("tcp", "localhost:0")
require.NoError(t, err)
service := &mockService{}
server := grpc.NewServer(
grpcmw.WithUnaryServerChain(
grpcmwlogrus.UnaryServerInterceptor(
logrus.NewEntry(logger),
grpcmwlogrus.WithMessageProducer(
log.MessageProducer(
grpcmwlogrus.DefaultMessageProducer,
FieldsProducer,
),
),
),
),
)
grpc_testing.RegisterTestServiceServer(server, service)
go testhelper.MustServe(t, server, listener)
defer server.Stop()
conn, err := grpc.Dial(listener.Addr().String(),
grpc.WithTransportCredentials(insecure.NewCredentials()),
)
require.NoError(t, err)
defer testhelper.MustClose(t, conn)
client := grpc_testing.NewTestServiceClient(conn)
featureA := featureflag.FeatureFlag{Name: "feature_a"}
featureB := featureflag.FeatureFlag{Name: "feature_b"}
featureC := featureflag.FeatureFlag{Name: "feature_c"}
testCases := []struct {
desc string
featureFlags map[featureflag.FeatureFlag]bool
returnedErr error
expectedFields string
}{
{
desc: "some feature flags are enabled in successful RPC",
featureFlags: map[featureflag.FeatureFlag]bool{
featureC: true,
featureA: true,
featureB: false,
},
expectedFields: "feature_a feature_c",
},
{
desc: "no feature flags are enabled in successful RPC",
featureFlags: map[featureflag.FeatureFlag]bool{
featureC: false,
featureA: false,
featureB: false,
},
expectedFields: "",
},
{
desc: "some feature flags are enabled in failed RPC",
featureFlags: map[featureflag.FeatureFlag]bool{
featureC: true,
featureA: true,
featureB: false,
},
returnedErr: structerr.NewInternal("something goes wrong"),
expectedFields: "feature_a feature_c",
},
{
desc: "no feature flags are enabled in failed RPC",
featureFlags: map[featureflag.FeatureFlag]bool{
featureC: false,
featureA: false,
featureB: false,
},
returnedErr: structerr.NewInternal("something goes wrong"),
expectedFields: "",
},
}
for _, tc := range testCases {
t.Run(tc.desc, func(t *testing.T) {
loggerHook.Reset()
service.err = tc.returnedErr
//nolint:forbidigo // This test tests feature flags. We want context to be in a clean state
ctx := context.Background()
for flag, value := range tc.featureFlags {
ctx = featureflag.OutgoingCtxWithFeatureFlag(ctx, flag, value)
}
_, err := client.UnaryCall(ctx, &grpc_testing.SimpleRequest{})
testhelper.RequireGrpcError(t, tc.returnedErr, err)
for _, logEntry := range loggerHook.AllEntries() {
if tc.expectedFields == "" {
require.NotContains(t, logEntry.Data, "feature_flags")
} else {
require.Equal(t, tc.expectedFields, logEntry.Data["feature_flags"])
}
}
})
}
}
|
