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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
|
package testhelper
import (
"bytes"
"context"
"encoding/base64"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net"
"os"
"os/exec"
"path"
"path/filepath"
"runtime"
"strconv"
"strings"
"syscall"
"testing"
"time"
grpc_middleware "github.com/grpc-ecosystem/go-grpc-middleware"
grpc_logrus "github.com/grpc-ecosystem/go-grpc-middleware/logging/logrus"
grpc_ctxtags "github.com/grpc-ecosystem/go-grpc-middleware/tags"
log "github.com/sirupsen/logrus"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/internal/command"
"gitlab.com/gitlab-org/gitaly/internal/config"
"gitlab.com/gitlab-org/gitaly/internal/helper/fieldextractors"
"gitlab.com/gitlab-org/gitaly/internal/helper/text"
gitalylog "gitlab.com/gitlab-org/gitaly/internal/log"
"gitlab.com/gitlab-org/gitaly/internal/storage"
"gitlab.com/gitlab-org/gitaly/proto/go/gitalypb"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
)
// TestRelativePath is the path inside its storage of the gitlab-test repo
const (
TestRelativePath = "gitlab-test.git"
RepositoryAuthToken = "the-secret-token"
DefaultStorageName = "default"
testGitEnv = "testdata/git-env"
)
func init() {
if err := configure(); err != nil {
log.Fatal(err)
}
}
func configure() error {
config.Config.Storages = []config.Storage{
{Name: "default", Path: GitlabTestStoragePath()},
}
config.Config.SocketPath = "/bogus"
config.Config.GitlabShell.Dir = "/"
dir, err := ioutil.TempDir("", "internal_socket")
if err != nil {
return err
}
config.Config.InternalSocketDir = dir
for _, f := range []func() error{
ConfigureRuby,
config.Validate,
} {
if err := f(); err != nil {
return err
}
}
gitalylog.Configure("", "info")
return nil
}
// MustReadFile returns the content of a file or fails at once.
func MustReadFile(t *testing.T, filename string) []byte {
content, err := ioutil.ReadFile(filename)
if err != nil {
t.Fatal(err)
}
return content
}
// GitlabTestStoragePath returns the storage path to the gitlab-test repo.
func GitlabTestStoragePath() string {
// If TEST_REPO_STORAGE_PATH has been set (by the Makefile) then use that
testRepoPath := os.Getenv("TEST_REPO_STORAGE_PATH")
if testRepoPath != "" {
testRepoPathAbs, err := filepath.Abs(testRepoPath)
if err != nil {
log.Fatal(err)
}
return testRepoPathAbs
}
_, currentFile, _, ok := runtime.Caller(0)
if !ok {
log.Fatal("Could not get caller info")
}
return path.Join(path.Dir(currentFile), "testdata/data")
}
// GitalyServersMetadata returns a metadata pair for gitaly-servers to be used in
// inter-gitaly operations.
func GitalyServersMetadata(t *testing.T, serverSocketPath string) metadata.MD {
gitalyServers := storage.GitalyServers{
"default": {
"address": serverSocketPath,
"token": RepositoryAuthToken,
},
}
gitalyServersJSON, err := json.Marshal(gitalyServers)
if err != nil {
t.Fatal(err)
}
return metadata.Pairs("gitaly-servers", base64.StdEncoding.EncodeToString(gitalyServersJSON))
}
func testRepoValid(repo *gitalypb.Repository) bool {
storagePath, _ := config.Config.StoragePath(repo.GetStorageName())
if _, err := os.Stat(path.Join(storagePath, repo.RelativePath, "objects")); err != nil {
return false
}
return true
}
// TestRepository returns the `Repository` object for the gitlab-test repo.
// Tests should be calling this function instead of cloning the repo themselves.
// Tests that involve modifications to the repo should copy/clone the repo
// via the `Repository` returned from this function.
func TestRepository() *gitalypb.Repository {
repo := &gitalypb.Repository{
StorageName: "default",
RelativePath: TestRelativePath,
GlRepository: "project-1",
}
if !testRepoValid(repo) {
panic("Test repo not found, did you run `make prepare-tests`?")
}
return repo
}
// RequireGrpcError asserts the passed err is of the same code as expectedCode.
func RequireGrpcError(t *testing.T, err error, expectedCode codes.Code) {
if err == nil {
t.Fatal("Expected an error, got nil")
}
// Check that the code matches
status, _ := status.FromError(err)
if code := status.Code(); code != expectedCode {
t.Fatalf("Expected an error with code %v, got %v. The error was %q", expectedCode, code, err.Error())
}
}
// MustRunCommand runs a command with an optional standard input and returns the standard output, or fails.
func MustRunCommand(t testing.TB, stdin io.Reader, name string, args ...string) []byte {
cmd := exec.Command(name, args...)
if name == "git" {
cmd.Env = os.Environ()
cmd.Env = append(command.GitEnv, cmd.Env...)
cmd.Env = append(cmd.Env,
"GIT_AUTHOR_DATE=1572776879 +0100",
"GIT_COMMITTER_DATE=1572776879 +0100",
)
}
if stdin != nil {
cmd.Stdin = stdin
}
output, err := cmd.Output()
if err != nil {
stderr := err.(*exec.ExitError).Stderr
if t == nil {
log.Print(name, args)
log.Printf("%s", stderr)
log.Fatal(err)
} else {
t.Log(name, args)
t.Logf("%s", stderr)
t.Fatal(err)
}
}
return output
}
// authorSortofEqual tests if two `CommitAuthor`s have the same name and email.
// useful when creating commits in the tests.
func authorSortofEqual(a, b *gitalypb.CommitAuthor) bool {
if (a == nil) != (b == nil) {
return false
}
return bytes.Equal(a.GetName(), b.GetName()) &&
bytes.Equal(a.GetEmail(), b.GetEmail())
}
// AuthorsEqual tests if two `CommitAuthor`s are equal
func AuthorsEqual(a *gitalypb.CommitAuthor, b *gitalypb.CommitAuthor) bool {
return authorSortofEqual(a, b) &&
a.GetDate().Seconds == b.GetDate().Seconds
}
// GitCommitEqual tests if two `GitCommit`s are equal
func GitCommitEqual(a, b *gitalypb.GitCommit) error {
if !authorSortofEqual(a.GetAuthor(), b.GetAuthor()) {
return fmt.Errorf("author does not match: %v != %v", a.GetAuthor(), b.GetAuthor())
}
if !authorSortofEqual(a.GetCommitter(), b.GetCommitter()) {
return fmt.Errorf("commiter does not match: %v != %v", a.GetCommitter(), b.GetCommitter())
}
if !bytes.Equal(a.GetBody(), b.GetBody()) {
return fmt.Errorf("body differs: %q != %q", a.GetBody(), b.GetBody())
}
if !bytes.Equal(a.GetSubject(), b.GetSubject()) {
return fmt.Errorf("subject differs: %q != %q", a.GetSubject(), b.GetSubject())
}
if strings.Compare(a.GetId(), b.GetId()) != 0 {
return fmt.Errorf("id does not match: %q != %q", a.GetId(), b.GetId())
}
if len(a.GetParentIds()) != len(b.GetParentIds()) {
return fmt.Errorf("ParentId does not match: %v != %v", a.GetParentIds(), b.GetParentIds())
}
for i, pid := range a.GetParentIds() {
pid2 := b.GetParentIds()[i]
if strings.Compare(pid, pid2) != 0 {
return fmt.Errorf("parent id mismatch: %v != %v", pid, pid2)
}
}
return nil
}
// FindLocalBranchCommitAuthorsEqual tests if two `FindLocalBranchCommitAuthor`s are equal
func FindLocalBranchCommitAuthorsEqual(a *gitalypb.FindLocalBranchCommitAuthor, b *gitalypb.FindLocalBranchCommitAuthor) bool {
return bytes.Equal(a.Name, b.Name) &&
bytes.Equal(a.Email, b.Email) &&
a.Date.Seconds == b.Date.Seconds
}
// FindLocalBranchResponsesEqual tests if two `FindLocalBranchResponse`s are equal
func FindLocalBranchResponsesEqual(a *gitalypb.FindLocalBranchResponse, b *gitalypb.FindLocalBranchResponse) bool {
return a.CommitId == b.CommitId &&
bytes.Equal(a.CommitSubject, b.CommitSubject) &&
FindLocalBranchCommitAuthorsEqual(a.CommitAuthor, b.CommitAuthor) &&
FindLocalBranchCommitAuthorsEqual(a.CommitCommitter, b.CommitCommitter)
}
// GetTemporaryGitalySocketFileName will return a unique, useable socket file name
func GetTemporaryGitalySocketFileName() string {
tmpfile, err := ioutil.TempFile("", "gitaly.socket.")
if err != nil {
// No point in handling this error, panic
panic(err)
}
name := tmpfile.Name()
tmpfile.Close()
os.Remove(name)
return name
}
// GetLocalhostListener listens on the next available TCP port and returns
// the listener and the localhost address (host:port) string.
func GetLocalhostListener(t testing.TB) (net.Listener, string) {
l, err := net.Listen("tcp", "localhost:0")
require.NoError(t, err)
addr := fmt.Sprintf("localhost:%d", l.Addr().(*net.TCPAddr).Port)
return l, addr
}
// ConfigureRuby configures Ruby settings for test purposes at run time.
func ConfigureRuby() error {
if dir := os.Getenv("GITALY_TEST_RUBY_DIR"); len(dir) > 0 {
// Sometimes runtime.Caller is unreliable. This environment variable provides a bypass.
config.Config.Ruby.Dir = dir
} else {
_, currentFile, _, ok := runtime.Caller(0)
if !ok {
return fmt.Errorf("could not get caller info")
}
config.Config.Ruby.Dir = filepath.Join(filepath.Dir(currentFile), "../../ruby")
}
if err := config.ConfigureRuby(); err != nil {
log.Fatalf("validate ruby config: %v", err)
}
return nil
}
// GetGitEnvData reads and returns the content of testGitEnv
func GetGitEnvData() (string, error) {
gitEnvBytes, err := ioutil.ReadFile(testGitEnv)
if err != nil {
return "", err
}
return string(gitEnvBytes), nil
}
// NewTestGrpcServer creates a GRPC Server for testing purposes
func NewTestGrpcServer(tb testing.TB, streamInterceptors []grpc.StreamServerInterceptor, unaryInterceptors []grpc.UnaryServerInterceptor) *grpc.Server {
logger := NewTestLogger(tb)
logrusEntry := log.NewEntry(logger).WithField("test", tb.Name())
ctxTagger := grpc_ctxtags.WithFieldExtractorForInitialReq(fieldextractors.FieldExtractor)
ctxStreamTagger := grpc_ctxtags.StreamServerInterceptor(ctxTagger)
ctxUnaryTagger := grpc_ctxtags.UnaryServerInterceptor(ctxTagger)
streamInterceptors = append([]grpc.StreamServerInterceptor{ctxStreamTagger, grpc_logrus.StreamServerInterceptor(logrusEntry)}, streamInterceptors...)
unaryInterceptors = append([]grpc.UnaryServerInterceptor{ctxUnaryTagger, grpc_logrus.UnaryServerInterceptor(logrusEntry)}, unaryInterceptors...)
return grpc.NewServer(
grpc.StreamInterceptor(grpc_middleware.ChainStreamServer(streamInterceptors...)),
grpc.UnaryInterceptor(grpc_middleware.ChainUnaryServer(unaryInterceptors...)),
)
}
// MustHaveNoChildProcess panics if it finds a running or finished child
// process. It waits for 2 seconds for processes to be cleaned up by other
// goroutines.
func MustHaveNoChildProcess() {
waitDone := make(chan struct{})
go func() {
command.WaitAllDone()
close(waitDone)
}()
select {
case <-waitDone:
case <-time.After(2 * time.Second):
}
mustFindNoFinishedChildProcess()
mustFindNoRunningChildProcess()
}
func mustFindNoFinishedChildProcess() {
// Wait4(pid int, wstatus *WaitStatus, options int, rusage *Rusage) (wpid int, err error)
//
// We use pid -1 to wait for any child. We don't care about wstatus or
// rusage. Use WNOHANG to return immediately if there is no child waiting
// to be reaped.
wpid, err := syscall.Wait4(-1, nil, syscall.WNOHANG, nil)
if err == nil && wpid > 0 {
panic(fmt.Errorf("wait4 found child process %d", wpid))
}
}
func mustFindNoRunningChildProcess() {
pgrep := exec.Command("pgrep", "-P", fmt.Sprintf("%d", os.Getpid()))
desc := fmt.Sprintf("%q", strings.Join(pgrep.Args, " "))
out, err := pgrep.Output()
if err == nil {
pidsComma := strings.Replace(text.ChompBytes(out), "\n", ",", -1)
psOut, _ := exec.Command("ps", "-o", "pid,args", "-p", pidsComma).Output()
panic(fmt.Errorf("found running child processes %s:\n%s", pidsComma, psOut))
}
if status, ok := command.ExitStatus(err); ok && status == 1 {
// Exit status 1 means no processes were found
return
}
panic(fmt.Errorf("%s: %v", desc, err))
}
// Context returns a cancellable context.
func Context() (context.Context, func()) {
return context.WithCancel(context.Background())
}
// CreateRepo creates a temporary directory for a repo, without initializing it
func CreateRepo(t testing.TB, storagePath string) (repo *gitalypb.Repository, repoPath, relativePath string) {
normalizedPrefix := strings.Replace(t.Name(), "/", "-", -1) //TempDir doesn't like a prefix containing slashes
repoPath, err := ioutil.TempDir(storagePath, normalizedPrefix)
require.NoError(t, err)
relativePath, err = filepath.Rel(storagePath, repoPath)
require.NoError(t, err)
repo = &gitalypb.Repository{StorageName: "default", RelativePath: relativePath, GlRepository: "project-1"}
return repo, repoPath, relativePath
}
// InitBareRepo creates a new bare repository
func InitBareRepo(t *testing.T) (*gitalypb.Repository, string, func()) {
return initRepo(t, true)
}
// InitRepoWithWorktree creates a new repository with a worktree
func InitRepoWithWorktree(t *testing.T) (*gitalypb.Repository, string, func()) {
return initRepo(t, false)
}
func initRepo(t *testing.T, bare bool) (*gitalypb.Repository, string, func()) {
repo, repoPath, _ := CreateRepo(t, GitlabTestStoragePath())
args := []string{"init"}
if bare {
args = append(args, "--bare")
}
MustRunCommand(t, nil, "git", append(args, repoPath)...)
if !bare {
repo.RelativePath = path.Join(repo.RelativePath, ".git")
}
return repo, repoPath, func() { os.RemoveAll(repoPath) }
}
// NewTestRepo creates a bare copy of the test repository.
func NewTestRepo(t testing.TB) (repo *gitalypb.Repository, repoPath string, cleanup func()) {
return cloneTestRepo(t, true)
}
// NewTestRepoWithWorktree creates a copy of the test repository with a
// worktree. This is allows you to run normal 'non-bare' Git commands.
func NewTestRepoWithWorktree(t *testing.T) (repo *gitalypb.Repository, repoPath string, cleanup func()) {
return cloneTestRepo(t, false)
}
func cloneTestRepo(t testing.TB, bare bool) (repo *gitalypb.Repository, repoPath string, cleanup func()) {
storagePath := GitlabTestStoragePath()
repo, repoPath, relativePath := CreateRepo(t, storagePath)
testRepo := TestRepository()
testRepoPath := path.Join(storagePath, testRepo.RelativePath)
args := []string{"clone", "--no-hardlinks", "--dissociate"}
if bare {
args = append(args, "--bare")
} else {
// For non-bare repos the relative path is the .git folder inside the path
repo.RelativePath = path.Join(relativePath, ".git")
}
MustRunCommand(t, nil, "git", append(args, testRepoPath, repoPath)...)
return repo, repoPath, func() { os.RemoveAll(repoPath) }
}
// AddWorktreeArgs returns git command arguments for adding a worktree at the
// specified repo
func AddWorktreeArgs(repoPath, worktreeName string) []string {
return []string{"-C", repoPath, "worktree", "add", "--detach", worktreeName}
}
// AddWorktree creates a worktree in the repository path for tests
func AddWorktree(t *testing.T, repoPath string, worktreeName string) {
MustRunCommand(t, nil, "git", AddWorktreeArgs(repoPath, worktreeName)...)
}
// ConfigureGitalySSH configures the gitaly-ssh command for tests
func ConfigureGitalySSH() {
var err error
config.Config.BinDir, err = filepath.Abs("testdata/gitaly-libexec")
if err != nil {
log.Fatal(err)
}
goBuildArgs := []string{
"build",
"-o",
path.Join(config.Config.BinDir, "gitaly-ssh"),
"gitlab.com/gitlab-org/gitaly/cmd/gitaly-ssh",
}
MustRunCommand(nil, nil, "go", goBuildArgs...)
}
// GetRepositoryRefs gives a list of each repository ref as a string
func GetRepositoryRefs(t *testing.T, repoPath string) string {
refs := MustRunCommand(t, nil, "git", "-C", repoPath, "for-each-ref")
return string(refs)
}
// AssertPathNotExists asserts true if the path doesn't exist, false otherwise
func AssertPathNotExists(t *testing.T, path string) {
_, err := os.Stat(path)
assert.True(t, os.IsNotExist(err), "file should not exist: %s", path)
}
// NewTestObjectPoolName returns a random pool repository name.
func NewTestObjectPoolName(t *testing.T) string {
b, err := text.RandomHex(5)
require.NoError(t, err)
return fmt.Sprintf("pool-%s.git", b)
}
// CreateLooseRef creates a ref that points to master
func CreateLooseRef(t *testing.T, repoPath, refName string) {
relRefPath := fmt.Sprintf("refs/heads/%s", refName)
MustRunCommand(t, nil, "git", "-C", repoPath, "update-ref", relRefPath, "master")
require.FileExists(t, filepath.Join(repoPath, relRefPath), "ref must be in loose file")
}
// TempDir is a wrapper around ioutil.TempDir that provides a cleanup function.
// The returned temp directory will be created in the directory specified by
// environment variable TEST_TEMP_DIR_PATH. If that variable is unset, the
// relative folder "./testdata/tmp" to this source file will be used.
func TempDir(t *testing.T, prefix string) (string, func() error) {
_, currentFile, _, ok := runtime.Caller(0)
if !ok {
log.Fatal("Could not get caller info")
}
rootTmpDir := path.Join(path.Dir(currentFile), "testdata/tmp")
dirPath, err := ioutil.TempDir(rootTmpDir, prefix)
require.NoError(t, err)
return dirPath, func() error {
return os.RemoveAll(dirPath)
}
}
// GitObjectMustExist is a test assertion that fails unless the git repo in repoPath contains sha
func GitObjectMustExist(t testing.TB, repoPath, sha string) {
gitObjectExists(t, repoPath, sha, true)
}
// GitObjectMustNotExist is a test assertion that fails unless the git repo in repoPath contains sha
func GitObjectMustNotExist(t testing.TB, repoPath, sha string) {
gitObjectExists(t, repoPath, sha, false)
}
func gitObjectExists(t testing.TB, repoPath, sha string, exists bool) {
cmd := exec.Command("git", "-C", repoPath, "cat-file", "-e", sha)
if exists {
require.NoError(t, cmd.Run(), "checking for object should succeed")
return
}
require.Error(t, cmd.Run(), "checking for object should fail")
}
// Cleanup functions should be called in a defer statement
// immediately after they are returned from a test helper
type Cleanup func()
// GetGitObjectDirSize gets the number of 1k blocks of a git object directory
func GetGitObjectDirSize(t *testing.T, repoPath string) int64 {
cmd := exec.Command("du", "-s", "-k", filepath.Join(repoPath, "objects"))
output, err := cmd.Output()
require.NoError(t, err)
if len(output) < 2 {
t.Error("invalid output of du -s -k")
}
outputSplit := strings.SplitN(string(output), "\t", 2)
blocks, err := strconv.ParseInt(outputSplit[0], 10, 64)
require.NoError(t, err)
return blocks
}
|