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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
|
package testserver
import (
"context"
"net"
"os"
"testing"
"github.com/sirupsen/logrus"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
gitalyauth "gitlab.com/gitlab-org/gitaly/v16/auth"
"gitlab.com/gitlab-org/gitaly/v16/client"
"gitlab.com/gitlab-org/gitaly/v16/internal/cache"
"gitlab.com/gitlab-org/gitaly/v16/internal/git"
"gitlab.com/gitlab-org/gitaly/v16/internal/git/catfile"
"gitlab.com/gitlab-org/gitaly/v16/internal/git/gittest"
"gitlab.com/gitlab-org/gitaly/v16/internal/git/housekeeping"
"gitlab.com/gitlab-org/gitaly/v16/internal/git/updateref"
"gitlab.com/gitlab-org/gitaly/v16/internal/git2go"
internalclient "gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/client"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/config"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/config/auth"
gitalylog "gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/config/log"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/hook"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/server"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/service"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/storage"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/transaction"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitlab"
"gitlab.com/gitlab-org/gitaly/v16/internal/grpc/backchannel"
"gitlab.com/gitlab-org/gitaly/v16/internal/grpc/middleware/limithandler"
"gitlab.com/gitlab-org/gitaly/v16/internal/helper/perm"
praefectconfig "gitlab.com/gitlab-org/gitaly/v16/internal/praefect/config"
"gitlab.com/gitlab-org/gitaly/v16/internal/streamcache"
"gitlab.com/gitlab-org/gitaly/v16/internal/structerr"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper/testdb"
"google.golang.org/grpc"
"google.golang.org/grpc/health"
healthpb "google.golang.org/grpc/health/grpc_health_v1"
)
// RunGitalyServer starts gitaly server based on the provided cfg and returns a connection address.
// It accepts addition Registrar to register all required service instead of
// calling service.RegisterAll explicitly because it creates a circular dependency
// when the function is used in on of internal/gitaly/service/... packages.
func RunGitalyServer(tb testing.TB, cfg config.Cfg, registrar func(srv *grpc.Server, deps *service.Dependencies), opts ...GitalyServerOpt) string {
return StartGitalyServer(tb, cfg, registrar, opts...).Address()
}
// StartGitalyServer creates and runs gitaly (and praefect as a proxy) server.
func StartGitalyServer(tb testing.TB, cfg config.Cfg, registrar func(srv *grpc.Server, deps *service.Dependencies), opts ...GitalyServerOpt) GitalyServer {
gitalySrv, gitalyAddr, disablePraefect := runGitaly(tb, cfg, registrar, opts...)
if !testhelper.IsPraefectEnabled() || disablePraefect {
return GitalyServer{
Server: gitalySrv,
shutdown: gitalySrv.Stop,
address: gitalyAddr,
}
}
praefectServer := runPraefectProxy(tb, cfg, gitalyAddr)
return GitalyServer{
Server: gitalySrv,
shutdown: func() {
praefectServer.Shutdown()
gitalySrv.Stop()
},
address: praefectServer.Address(),
}
}
func runPraefectProxy(tb testing.TB, gitalyCfg config.Cfg, gitalyAddr string) PraefectServer {
var virtualStorages []*praefectconfig.VirtualStorage
for _, storage := range gitalyCfg.Storages {
virtualStorages = append(virtualStorages, &praefectconfig.VirtualStorage{
Name: storage.Name,
Nodes: []*praefectconfig.Node{
{
Storage: storage.Name,
Address: gitalyAddr,
Token: gitalyCfg.Auth.Token,
},
},
})
}
return StartPraefect(tb, praefectconfig.Config{
SocketPath: testhelper.GetTemporaryGitalySocketFileName(tb),
Auth: auth.Config{
Token: gitalyCfg.Auth.Token,
},
DB: testdb.GetConfig(tb, testdb.New(tb).Name),
Failover: praefectconfig.Failover{
Enabled: true,
ElectionStrategy: praefectconfig.ElectionStrategyLocal,
},
BackgroundVerification: praefectconfig.BackgroundVerification{
// Some tests cases purposefully create bad metadata by deleting a repository off
// the disk. If the background verifier is running, it could find these repositories
// and remove the invalid metadata related to them. This can cause the test assertions
// to fail. As the background verifier runs asynchronously and possibly changes state
// during a test and issues unexpected RPCs, it's disabled generally for all tests.
VerificationInterval: -1,
},
Replication: praefectconfig.DefaultReplicationConfig(),
Logging: gitalylog.Config{
Format: "json",
Level: "info",
},
VirtualStorages: virtualStorages,
})
}
// GitalyServer is a helper that carries additional info and
// functionality about gitaly (+praefect) server.
type GitalyServer struct {
Server *grpc.Server
shutdown func()
address string
}
// Shutdown terminates running gitaly (+praefect) server.
func (gs GitalyServer) Shutdown() {
gs.shutdown()
}
// Address returns address of the running gitaly (or praefect) service.
func (gs GitalyServer) Address() string {
return gs.address
}
// waitHealthy waits until the server hosted at address becomes healthy.
func waitHealthy(tb testing.TB, ctx context.Context, addr string, authToken string) {
grpcOpts := []grpc.DialOption{
grpc.WithBlock(),
internalclient.UnaryInterceptor(),
internalclient.StreamInterceptor(),
}
if authToken != "" {
grpcOpts = append(grpcOpts, grpc.WithPerRPCCredentials(gitalyauth.RPCCredentialsV2(authToken)))
}
conn, err := client.DialContext(ctx, addr, grpcOpts)
require.NoError(tb, err)
defer testhelper.MustClose(tb, conn)
healthClient := healthpb.NewHealthClient(conn)
resp, err := healthClient.Check(ctx, &healthpb.HealthCheckRequest{}, grpc.WaitForReady(true))
require.NoError(tb, err)
require.Equal(tb, healthpb.HealthCheckResponse_SERVING, resp.Status, "server not yet ready to serve")
}
func runGitaly(tb testing.TB, cfg config.Cfg, registrar func(srv *grpc.Server, deps *service.Dependencies), opts ...GitalyServerOpt) (*grpc.Server, string, bool) {
tb.Helper()
var gsd gitalyServerDeps
for _, opt := range opts {
gsd = opt(gsd)
}
// We set up the structerr interceptors so that any error metadata that gets set via
// `structerr.WithMetadata()` is not only logged, but also present in the error details.
serverOpts := []server.Option{
server.WithUnaryInterceptor(structerr.UnaryInterceptor),
server.WithStreamInterceptor(structerr.StreamInterceptor),
}
deps := gsd.createDependencies(tb, cfg)
tb.Cleanup(func() { gsd.conns.Close() })
serverFactory := server.NewGitalyServerFactory(
cfg,
gsd.logger.WithField("test", tb.Name()),
deps.GetBackchannelRegistry(),
deps.GetDiskCache(),
[]*limithandler.LimiterMiddleware{deps.GetLimitHandler()},
)
if cfg.RuntimeDir != "" {
internalServer, err := serverFactory.CreateInternal(serverOpts...)
require.NoError(tb, err)
tb.Cleanup(internalServer.Stop)
registrar(internalServer, deps)
registerHealthServerIfNotRegistered(internalServer)
require.NoError(tb, os.MkdirAll(cfg.InternalSocketDir(), perm.PrivateDir))
tb.Cleanup(func() { require.NoError(tb, os.RemoveAll(cfg.InternalSocketDir())) })
internalListener, err := net.Listen("unix", cfg.InternalSocketPath())
require.NoError(tb, err)
go func() {
assert.NoError(tb, internalServer.Serve(internalListener), "failure to serve internal gRPC")
}()
ctx := testhelper.Context(tb)
waitHealthy(tb, ctx, "unix://"+internalListener.Addr().String(), cfg.Auth.Token)
}
secure := cfg.TLS.CertPath != "" && cfg.TLS.KeyPath != ""
externalServer, err := serverFactory.CreateExternal(secure, serverOpts...)
require.NoError(tb, err)
tb.Cleanup(externalServer.Stop)
registrar(externalServer, deps)
registerHealthServerIfNotRegistered(externalServer)
var listener net.Listener
var addr string
switch {
case cfg.TLSListenAddr != "":
listener, err = net.Listen("tcp", cfg.TLSListenAddr)
require.NoError(tb, err)
_, port, err := net.SplitHostPort(listener.Addr().String())
require.NoError(tb, err)
addr = "tls://localhost:" + port
case cfg.ListenAddr != "":
listener, err = net.Listen("tcp", cfg.ListenAddr)
require.NoError(tb, err)
addr = "tcp://" + listener.Addr().String()
default:
serverSocketPath := testhelper.GetTemporaryGitalySocketFileName(tb)
listener, err = net.Listen("unix", serverSocketPath)
require.NoError(tb, err)
addr = "unix://" + serverSocketPath
}
go func() {
assert.NoError(tb, externalServer.Serve(listener), "failure to serve external gRPC")
}()
ctx := testhelper.Context(tb)
waitHealthy(tb, ctx, addr, cfg.Auth.Token)
return externalServer, addr, gsd.disablePraefect
}
func registerHealthServerIfNotRegistered(srv *grpc.Server) {
if _, found := srv.GetServiceInfo()["grpc.health.v1.Health"]; !found {
// we should register health service as it is used for the health checks
// praefect service executes periodically (and on the bootstrap step)
healthpb.RegisterHealthServer(srv, health.NewServer())
}
}
type gitalyServerDeps struct {
disablePraefect bool
logger *logrus.Logger
conns *client.Pool
locator storage.Locator
txMgr transaction.Manager
hookMgr hook.Manager
gitlabClient gitlab.Client
gitCmdFactory git.CommandFactory
backchannelReg *backchannel.Registry
catfileCache catfile.Cache
diskCache cache.Cache
packObjectsCache streamcache.Cache
packObjectsConcurrencyTracker *hook.ConcurrencyTracker
packObjectsLimiter limithandler.Limiter
limitHandler *limithandler.LimiterMiddleware
git2goExecutor *git2go.Executor
updaterWithHooks *updateref.UpdaterWithHooks
housekeepingManager housekeeping.Manager
}
func (gsd *gitalyServerDeps) createDependencies(tb testing.TB, cfg config.Cfg) *service.Dependencies {
if gsd.logger == nil {
gsd.logger = testhelper.NewGitalyServerLogger(tb)
}
if gsd.conns == nil {
gsd.conns = client.NewPool(internalclient.UnaryInterceptor(), internalclient.StreamInterceptor())
}
if gsd.locator == nil {
gsd.locator = config.NewLocator(cfg)
}
if gsd.gitlabClient == nil {
gsd.gitlabClient = gitlab.NewMockClient(
tb, gitlab.MockAllowed, gitlab.MockPreReceive, gitlab.MockPostReceive,
)
}
if gsd.backchannelReg == nil {
gsd.backchannelReg = backchannel.NewRegistry()
}
if gsd.txMgr == nil {
gsd.txMgr = transaction.NewManager(cfg, gsd.backchannelReg)
}
if gsd.gitCmdFactory == nil {
gsd.gitCmdFactory = gittest.NewCommandFactory(tb, cfg)
}
if gsd.hookMgr == nil {
gsd.hookMgr = hook.NewManager(cfg, gsd.locator, gsd.gitCmdFactory, gsd.txMgr, gsd.gitlabClient)
}
if gsd.catfileCache == nil {
cache := catfile.NewCache(cfg)
gsd.catfileCache = cache
tb.Cleanup(cache.Stop)
}
if gsd.diskCache == nil {
gsd.diskCache = cache.New(cfg, gsd.locator)
}
if gsd.packObjectsCache == nil {
gsd.packObjectsCache = streamcache.New(cfg.PackObjectsCache, gsd.logger)
tb.Cleanup(gsd.packObjectsCache.Stop)
}
if gsd.packObjectsConcurrencyTracker == nil {
gsd.packObjectsConcurrencyTracker = hook.NewConcurrencyTracker()
}
if gsd.packObjectsLimiter == nil {
gsd.packObjectsLimiter = limithandler.NewConcurrencyLimiter(
0,
0,
nil,
limithandler.NewNoopConcurrencyMonitor(),
)
}
if gsd.limitHandler == nil {
gsd.limitHandler = limithandler.New(cfg, limithandler.LimitConcurrencyByRepo, limithandler.WithConcurrencyLimiters)
}
if gsd.git2goExecutor == nil {
gsd.git2goExecutor = git2go.NewExecutor(cfg, gsd.gitCmdFactory, gsd.locator)
}
if gsd.updaterWithHooks == nil {
gsd.updaterWithHooks = updateref.NewUpdaterWithHooks(cfg, gsd.locator, gsd.hookMgr, gsd.gitCmdFactory, gsd.catfileCache)
}
if gsd.housekeepingManager == nil {
gsd.housekeepingManager = housekeeping.NewManager(cfg.Prometheus, gsd.txMgr)
}
return &service.Dependencies{
Cfg: cfg,
ClientPool: gsd.conns,
StorageLocator: gsd.locator,
TransactionManager: gsd.txMgr,
GitalyHookManager: gsd.hookMgr,
GitCmdFactory: gsd.gitCmdFactory,
BackchannelRegistry: gsd.backchannelReg,
GitlabClient: gsd.gitlabClient,
CatfileCache: gsd.catfileCache,
DiskCache: gsd.diskCache,
PackObjectsCache: gsd.packObjectsCache,
PackObjectsLimiter: gsd.packObjectsLimiter,
PackObjectsConcurrencyTracker: gsd.packObjectsConcurrencyTracker,
LimitHandler: gsd.limitHandler,
Git2goExecutor: gsd.git2goExecutor,
UpdaterWithHooks: gsd.updaterWithHooks,
HousekeepingManager: gsd.housekeepingManager,
}
}
// GitalyServerOpt is a helper type to shorten declarations.
type GitalyServerOpt func(gitalyServerDeps) gitalyServerDeps
// WithLogger sets a logrus.Logger instance that will be used for gitaly services initialisation.
func WithLogger(logger *logrus.Logger) GitalyServerOpt {
return func(deps gitalyServerDeps) gitalyServerDeps {
deps.logger = logger
return deps
}
}
// WithLocator sets a storage.Locator instance that will be used for gitaly services initialisation.
func WithLocator(locator storage.Locator) GitalyServerOpt {
return func(deps gitalyServerDeps) gitalyServerDeps {
deps.locator = locator
return deps
}
}
// WithGitCommandFactory sets a git.CommandFactory instance that will be used for gitaly services
// initialisation.
func WithGitCommandFactory(gitCmdFactory git.CommandFactory) GitalyServerOpt {
return func(deps gitalyServerDeps) gitalyServerDeps {
deps.gitCmdFactory = gitCmdFactory
return deps
}
}
// WithGitLabClient sets gitlab.Client instance that will be used for gitaly services initialisation.
func WithGitLabClient(gitlabClient gitlab.Client) GitalyServerOpt {
return func(deps gitalyServerDeps) gitalyServerDeps {
deps.gitlabClient = gitlabClient
return deps
}
}
// WithHookManager sets hook.Manager instance that will be used for gitaly services initialisation.
func WithHookManager(hookMgr hook.Manager) GitalyServerOpt {
return func(deps gitalyServerDeps) gitalyServerDeps {
deps.hookMgr = hookMgr
return deps
}
}
// WithTransactionManager sets transaction.Manager instance that will be used for gitaly services initialisation.
func WithTransactionManager(txMgr transaction.Manager) GitalyServerOpt {
return func(deps gitalyServerDeps) gitalyServerDeps {
deps.txMgr = txMgr
return deps
}
}
// WithDisablePraefect disables setup and usage of the praefect as a proxy before the gitaly service.
func WithDisablePraefect() GitalyServerOpt {
return func(deps gitalyServerDeps) gitalyServerDeps {
deps.disablePraefect = true
return deps
}
}
// WithBackchannelRegistry sets backchannel.Registry instance that will be used for gitaly services initialisation.
func WithBackchannelRegistry(backchannelReg *backchannel.Registry) GitalyServerOpt {
return func(deps gitalyServerDeps) gitalyServerDeps {
deps.backchannelReg = backchannelReg
return deps
}
}
// WithDiskCache sets the cache.Cache instance that will be used for gitaly services initialisation.
func WithDiskCache(diskCache cache.Cache) GitalyServerOpt {
return func(deps gitalyServerDeps) gitalyServerDeps {
deps.diskCache = diskCache
return deps
}
}
// WithConcurrencyTracker sets the PackObjectsConcurrencyTracker that will be
// used for gitaly services initialization.
func WithConcurrencyTracker(tracker *hook.ConcurrencyTracker) GitalyServerOpt {
return func(deps gitalyServerDeps) gitalyServerDeps {
deps.packObjectsConcurrencyTracker = tracker
return deps
}
}
// WithPackObjectsLimiter sets the PackObjectsLimiter that will be
// used for gitaly services initialization.
func WithPackObjectsLimiter(limiter *limithandler.ConcurrencyLimiter) GitalyServerOpt {
return func(deps gitalyServerDeps) gitalyServerDeps {
deps.packObjectsLimiter = limiter
return deps
}
}
// WithHousekeepingManager sets the housekeeping.Manager that will be used for Gitaly services
// initialization.
func WithHousekeepingManager(manager housekeeping.Manager) GitalyServerOpt {
return func(deps gitalyServerDeps) gitalyServerDeps {
deps.housekeepingManager = manager
return deps
}
}
|