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
|
package repository
import (
"context"
"fmt"
"io/fs"
"os"
"path/filepath"
"strings"
"testing"
"time"
"github.com/sirupsen/logrus"
"github.com/sirupsen/logrus/hooks/test"
"github.com/stretchr/testify/require"
"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/localrepo"
"gitlab.com/gitlab-org/gitaly/v16/internal/git/stats"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/storage"
"gitlab.com/gitlab-org/gitaly/v16/internal/helper/perm"
"gitlab.com/gitlab-org/gitaly/v16/internal/helper/text"
"gitlab.com/gitlab-org/gitaly/v16/internal/structerr"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper/testserver"
"gitlab.com/gitlab-org/gitaly/v16/proto/go/gitalypb"
)
func TestOptimizeRepository(t *testing.T) {
t.Parallel()
ctx := testhelper.Context(t)
cfg, client := setupRepositoryService(t)
t.Run("gitconfig credentials get pruned", func(t *testing.T) {
t.Parallel()
repo, repoPath := gittest.CreateRepository(t, ctx, cfg)
gitconfigPath := filepath.Join(repoPath, "config")
readConfig := func() []string {
return strings.Split(text.ChompBytes(gittest.Exec(t, cfg, "config", "--file", gitconfigPath, "--list")), "\n")
}
configWithSecrets := readConfig()
configWithStrippedSecrets := readConfig()
// Set up a gitconfig with all sorts of credentials.
for key, shouldBeStripped := range map[string]bool{
"http.http://localhost:51744/60631c8695bf041a808759a05de53e36a73316aacb502824fabbb0c6055637c1.git.extraHeader": true,
"http.http://localhost:51744/60631c8695bf041a808759a05de53e36a73316aacb502824fabbb0c6055637c2.git.extraHeader": true,
"hTTp.http://localhost:51744/60631c8695bf041a808759a05de53e36a73316aacb502824fabbb0c6055637c5.git.ExtrAheaDeR": true,
"http.http://extraheader/extraheader/extraheader.git.extraHeader": true,
// This line should not get stripped as Git wouldn't even know how to
// interpret it due to the `https` prefix. Git only knows about `http`.
"https.https://localhost:51744/60631c8695bf041a808759a05de53e36a73316aacb502824fabbb0c6055637c5.git.extraHeader": false,
// This one should not get stripped as its prefix is wrong.
"randomStart-http.http://localhost:51744/60631c8695bf041a808759a05de53e36a73316aacb502824fabbb0c6055637c3.git.extraHeader": false,
// Same here, this one should not get stripped because its suffix is wrong.
"http.http://localhost:51744/60631c8695bf041a808759a05de53e36a73316aacb502824fabbb0c6055637c4.git.extraHeader-randomEnd": false,
} {
value := "Authorization: Basic secret-password"
line := fmt.Sprintf("%s=%s", strings.ToLower(key), value)
gittest.Exec(t, cfg, "config", "--file", gitconfigPath, key, value)
configWithSecrets = append(configWithSecrets, line)
if !shouldBeStripped {
configWithStrippedSecrets = append(configWithStrippedSecrets, line)
}
}
require.Equal(t, configWithSecrets, readConfig())
// Calling OptimizeRepository should cause us to strip any of the added creds from
// the gitconfig.
_, err := client.OptimizeRepository(ctx, &gitalypb.OptimizeRepositoryRequest{
Repository: repo,
})
require.NoError(t, err)
// The gitconfig should not contain any of the stripped gitconfig values anymore.
require.Equal(t, configWithStrippedSecrets, readConfig())
})
t.Run("up-to-date packfile does not get repacked", func(t *testing.T) {
t.Parallel()
repo, repoPath := gittest.CreateRepository(t, ctx, cfg)
// Write a commit and force-repack the whole repository. This is to ensure that the
// repository is in a state where it shouldn't need to be repacked.
gittest.WriteCommit(t, cfg, repoPath, gittest.WithBranch("master"))
_, err := client.OptimizeRepository(ctx, &gitalypb.OptimizeRepositoryRequest{
Repository: repo,
Strategy: gitalypb.OptimizeRepositoryRequest_STRATEGY_EAGER,
})
require.NoError(t, err)
// We should have a single packfile now.
packfiles, err := filepath.Glob(filepath.Join(repoPath, "objects", "pack", "pack-*.pack"))
require.NoError(t, err)
require.Len(t, packfiles, 1)
// Now we do a second, lazy optimization of the repository. This time around we
// should see that the repository was in a well-defined state already, so we should
// not perform any optimization.
_, err = client.OptimizeRepository(ctx, &gitalypb.OptimizeRepositoryRequest{
Repository: repo,
})
require.NoError(t, err)
// The packfile should not have changed.
updatedPackfiles, err := filepath.Glob(filepath.Join(repoPath, "objects", "pack", "pack-*.pack"))
require.NoError(t, err)
require.Equal(t, packfiles, updatedPackfiles)
})
t.Run("missing bitmap causes full repack", func(t *testing.T) {
t.Parallel()
repo, repoPath := gittest.CreateRepository(t, ctx, cfg)
gittest.WriteCommit(t, cfg, repoPath, gittest.WithBranch("master"))
bitmaps, err := filepath.Glob(filepath.Join(repoPath, "objects", "pack", "*.bitmap"))
require.NoError(t, err)
require.Empty(t, bitmaps)
// Even though the repository doesn't have a lot of objects and we're not performing
// an eager optimization, we should still see that the optimization decides to write
// out a new bitmap via a full repack. This is so that all repositories will have a
// bitmap available.
_, err = client.OptimizeRepository(ctx, &gitalypb.OptimizeRepositoryRequest{
Repository: repo,
})
require.NoError(t, err)
bitmaps, err = filepath.Glob(filepath.Join(repoPath, "objects", "pack", "*.bitmap"))
require.NoError(t, err)
require.NotEmpty(t, bitmaps)
})
t.Run("optimizing repository without commit-graph bloom filters and generation data", func(t *testing.T) {
t.Parallel()
repo, repoPath := gittest.CreateRepository(t, ctx, cfg)
gittest.WriteCommit(t, cfg, repoPath, gittest.WithBranch("master"))
// Prepare the repository so that it has a commit-graph, but that commit-graph is
// missing bloom filters.
gittest.Exec(t, cfg, "-C", repoPath,
"-c", "commitGraph.generationVersion=1",
"commit-graph", "write", "--split", "--reachable",
)
commitGraphInfo, err := stats.CommitGraphInfoForRepository(repoPath)
require.NoError(t, err)
require.Equal(t, stats.CommitGraphInfo{
Exists: true,
HasBloomFilters: false,
HasGenerationData: false,
CommitGraphChainLength: 1,
}, commitGraphInfo)
// As a result, OptimizeRepository should rewrite the commit-graph.
_, err = client.OptimizeRepository(ctx, &gitalypb.OptimizeRepositoryRequest{
Repository: repo,
})
require.NoError(t, err)
// Which means that we now should see that bloom filters exist.
commitGraphInfo, err = stats.CommitGraphInfoForRepository(repoPath)
require.NoError(t, err)
require.Equal(t, stats.CommitGraphInfo{
Exists: true,
HasBloomFilters: true,
HasGenerationData: true,
CommitGraphChainLength: 1,
}, commitGraphInfo)
})
t.Run("optimizing repository without commit-graph bloom filters with generation data", func(t *testing.T) {
t.Parallel()
repo, repoPath := gittest.CreateRepository(t, ctx, cfg)
gittest.WriteCommit(t, cfg, repoPath, gittest.WithBranch("master"))
// Prepare the repository so that it has a commit-graph, but that commit-graph is
// missing bloom filters.
gittest.Exec(t, cfg, "-C", repoPath,
"-c", "commitGraph.generationVersion=2",
"commit-graph", "write", "--split", "--reachable",
)
commitGraphInfo, err := stats.CommitGraphInfoForRepository(repoPath)
require.NoError(t, err)
require.Equal(t, stats.CommitGraphInfo{
Exists: true,
HasBloomFilters: false,
HasGenerationData: true,
CommitGraphChainLength: 1,
}, commitGraphInfo)
// As a result, OptimizeRepository should rewrite the commit-graph.
_, err = client.OptimizeRepository(ctx, &gitalypb.OptimizeRepositoryRequest{
Repository: repo,
})
require.NoError(t, err)
// Which means that we now should see that bloom filters exist.
commitGraphInfo, err = stats.CommitGraphInfoForRepository(repoPath)
require.NoError(t, err)
require.Equal(t, stats.CommitGraphInfo{
Exists: true,
HasBloomFilters: true,
HasGenerationData: true,
CommitGraphChainLength: 1,
}, commitGraphInfo)
})
t.Run("empty ref directories get pruned after grace period", func(t *testing.T) {
t.Parallel()
repo, repoPath := gittest.CreateRepository(t, ctx, cfg)
// Git will leave behind empty refs directories at times. In order to not slow down
// enumerating refs we want to make sure that they get cleaned up properly.
emptyRefsDir := filepath.Join(repoPath, "refs", "merge-requests", "1")
require.NoError(t, os.MkdirAll(emptyRefsDir, perm.SharedDir))
// But we don't expect the first call to OptimizeRepository to do anything. This is
// because we have a grace period so that we don't delete empty ref directories that
// have just been created by a concurrently running Git process.
_, err := client.OptimizeRepository(ctx, &gitalypb.OptimizeRepositoryRequest{
Repository: repo,
})
require.NoError(t, err)
require.DirExists(t, emptyRefsDir)
// Change the modification time of the complete repository to be older than a day.
require.NoError(t, filepath.WalkDir(repoPath, func(path string, _ fs.DirEntry, err error) error {
require.NoError(t, err)
oneDayAgo := time.Now().Add(-24 * time.Hour)
require.NoError(t, os.Chtimes(path, oneDayAgo, oneDayAgo))
return nil
}))
// Now the second call to OptimizeRepository should indeed clean up the empty refs
// directories.
_, err = client.OptimizeRepository(ctx, &gitalypb.OptimizeRepositoryRequest{
Repository: repo,
})
require.NoError(t, err)
// We shouldn't have removed the top-level "refs" directory.
require.DirExists(t, filepath.Join(repoPath, "refs"))
// But the other two directories should be gone.
require.NoDirExists(t, filepath.Join(repoPath, "refs", "merge-requests"))
require.NoDirExists(t, filepath.Join(repoPath, "refs", "merge-requests", "1"))
})
}
type mockHousekeepingManager struct {
housekeeping.Manager
strategyCh chan housekeeping.OptimizationStrategy
}
func (m mockHousekeepingManager) OptimizeRepository(_ context.Context, _ logrus.FieldLogger, _ *localrepo.Repo, opts ...housekeeping.OptimizeRepositoryOption) error {
var cfg housekeeping.OptimizeRepositoryConfig
for _, opt := range opts {
opt(&cfg)
}
m.strategyCh <- cfg.StrategyConstructor(stats.RepositoryInfo{})
return nil
}
func TestOptimizeRepository_strategy(t *testing.T) {
t.Parallel()
housekeepingManager := mockHousekeepingManager{
strategyCh: make(chan housekeeping.OptimizationStrategy, 1),
}
ctx := testhelper.Context(t)
cfg, client := setupRepositoryService(t, testserver.WithHousekeepingManager(housekeepingManager))
repoProto, _ := gittest.CreateRepository(t, ctx, cfg)
for _, tc := range []struct {
desc string
request *gitalypb.OptimizeRepositoryRequest
expectedType housekeeping.OptimizationStrategy
}{
{
desc: "no strategy",
request: &gitalypb.OptimizeRepositoryRequest{
Repository: repoProto,
},
expectedType: housekeeping.HeuristicalOptimizationStrategy{},
},
{
desc: "heuristical strategy",
request: &gitalypb.OptimizeRepositoryRequest{
Repository: repoProto,
Strategy: gitalypb.OptimizeRepositoryRequest_STRATEGY_HEURISTICAL,
},
expectedType: housekeeping.HeuristicalOptimizationStrategy{},
},
{
desc: "eager strategy",
request: &gitalypb.OptimizeRepositoryRequest{
Repository: repoProto,
Strategy: gitalypb.OptimizeRepositoryRequest_STRATEGY_EAGER,
},
expectedType: housekeeping.EagerOptimizationStrategy{},
},
} {
t.Run(tc.desc, func(t *testing.T) {
response, err := client.OptimizeRepository(ctx, tc.request)
require.NoError(t, err)
testhelper.ProtoEqual(t, &gitalypb.OptimizeRepositoryResponse{}, response)
require.IsType(t, tc.expectedType, <-housekeepingManager.strategyCh)
})
}
}
func TestOptimizeRepository_validation(t *testing.T) {
t.Parallel()
ctx := testhelper.Context(t)
cfg, client := setupRepositoryService(t)
repo, _ := gittest.CreateRepository(t, ctx, cfg)
for _, tc := range []struct {
desc string
request *gitalypb.OptimizeRepositoryRequest
expectedErr error
}{
{
desc: "empty repository",
request: &gitalypb.OptimizeRepositoryRequest{},
expectedErr: structerr.NewInvalidArgument("%w", storage.ErrRepositoryNotSet),
},
{
desc: "invalid repository storage",
request: &gitalypb.OptimizeRepositoryRequest{
Repository: &gitalypb.Repository{
StorageName: "non-existent",
RelativePath: repo.GetRelativePath(),
},
},
expectedErr: testhelper.ToInterceptedMetadata(structerr.NewInvalidArgument(
"%w", storage.NewStorageNotFoundError("non-existent"),
)),
},
{
desc: "invalid repository path",
request: &gitalypb.OptimizeRepositoryRequest{
Repository: &gitalypb.Repository{
StorageName: repo.GetStorageName(),
RelativePath: "path/not/exist",
},
},
expectedErr: testhelper.ToInterceptedMetadata(
structerr.New("%w", storage.NewRepositoryNotFoundError(cfg.Storages[0].Name, "path/not/exist")),
),
},
{
desc: "invalid optimization strategy",
request: &gitalypb.OptimizeRepositoryRequest{
Repository: repo,
Strategy: 12,
},
expectedErr: structerr.NewInvalidArgument("unsupported optimization strategy 12"),
},
} {
t.Run(tc.desc, func(t *testing.T) {
_, err := client.OptimizeRepository(ctx, tc.request)
testhelper.RequireGrpcError(t, tc.expectedErr, err)
})
}
}
func TestOptimizeRepository_logStatistics(t *testing.T) {
t.Parallel()
ctx := testhelper.Context(t)
logger, hook := test.NewNullLogger()
cfg, client := setupRepositoryService(t, testserver.WithLogger(logger))
repoProto, _ := gittest.CreateRepository(t, ctx, cfg)
_, err := client.OptimizeRepository(ctx, &gitalypb.OptimizeRepositoryRequest{
Repository: repoProto,
})
require.NoError(t, err)
requireRepositoryInfoLog(t, hook.AllEntries()...)
}
|