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
|
package gittest
import (
"crypto/sha256"
"os"
"path/filepath"
"runtime"
"testing"
log "github.com/sirupsen/logrus"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/internal/gitaly/config"
"gitlab.com/gitlab-org/gitaly/internal/helper/text"
"gitlab.com/gitlab-org/gitaly/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/proto/go/gitalypb"
)
const (
// GlRepository is the default repository name for newly created test
// repos.
GlRepository = "project-1"
// GlProjectPath is the default project path for newly created test
// repos.
GlProjectPath = "gitlab-org/gitlab-test"
)
// InitRepoDir creates a temporary directory for a repo, without initializing it
func InitRepoDir(t testing.TB, storagePath, relativePath string) *gitalypb.Repository {
repoPath := filepath.Join(storagePath, relativePath, "..")
require.NoError(t, os.MkdirAll(repoPath, 0755), "making repo parent dir")
return &gitalypb.Repository{
StorageName: "default",
RelativePath: relativePath,
GlRepository: GlRepository,
GlProjectPath: GlProjectPath,
}
}
// InitBareRepo creates a new bare repository
func InitBareRepo(t testing.TB) (*gitalypb.Repository, string, func()) {
return initRepo(t, true)
}
// InitRepoWithWorktree creates a new repository with a worktree
func InitRepoWithWorktree(t testing.TB) (*gitalypb.Repository, string, func()) {
return initRepo(t, false)
}
// NewObjectPoolName returns a random pool repository name in format
// '@pools/[0-9a-z]{2}/[0-9a-z]{2}/[0-9a-z]{64}.git'.
func NewObjectPoolName(t testing.TB) string {
return filepath.Join("@pools", newDiskHash(t)+".git")
}
// NewRepositoryName returns a random repository hash
// in format '@hashed/[0-9a-f]{2}/[0-9a-f]{2}/[0-9a-f]{64}(.git)?'.
func NewRepositoryName(t testing.TB, bare bool) string {
suffix := ""
if bare {
suffix = ".git"
}
return filepath.Join("@hashed", newDiskHash(t)+suffix)
}
// newDiskHash generates a random directory path following the Rails app's
// approach in the hashed storage module, formatted as '[0-9a-f]{2}/[0-9a-f]{2}/[0-9a-f]{64}'.
// https://gitlab.com/gitlab-org/gitlab/-/blob/f5c7d8eb1dd4eee5106123e04dec26d277ff6a83/app/models/storage/hashed.rb#L38-43
func newDiskHash(t testing.TB) string {
// rails app calculates a sha256 and uses its hex representation
// as the directory path
b, err := text.RandomHex(sha256.Size)
require.NoError(t, err)
return filepath.Join(b[0:2], b[2:4], b)
}
func initRepo(t testing.TB, bare bool) (*gitalypb.Repository, string, func()) {
storagePath := testhelper.GitlabTestStoragePath()
relativePath := NewRepositoryName(t, bare)
repoPath := filepath.Join(storagePath, relativePath)
args := []string{"init"}
if bare {
args = append(args, "--bare")
}
testhelper.MustRunCommand(t, nil, "git", append(args, repoPath)...)
repo := InitRepoDir(t, storagePath, relativePath)
if !bare {
repo.RelativePath = filepath.Join(repo.RelativePath, ".git")
}
return repo, repoPath, func() { require.NoError(t, os.RemoveAll(repoPath)) }
}
// CloneRepoAtStorageRoot clones a new copy of test repository under a subdirectory in the storage root.
func CloneRepoAtStorageRoot(t testing.TB, storageRoot, relativePath string) *gitalypb.Repository {
repo, _, _ := cloneRepo(t, storageRoot, relativePath, true)
return repo
}
// CloneRepoAtStorage clones a new copy of test repository under a subdirectory in the storage root.
func CloneRepoAtStorage(t testing.TB, storage config.Storage, relativePath string) *gitalypb.Repository {
repo, _, _ := cloneRepo(t, storage.Path, relativePath, true)
repo.StorageName = storage.Name
return repo
}
// CloneRepo creates a bare copy of the test repository.
func CloneRepo(t testing.TB) (repo *gitalypb.Repository, repoPath string, cleanup func()) {
return cloneRepo(t, testhelper.GitlabTestStoragePath(), NewRepositoryName(t, true), true)
}
// CloneRepoWithWorktree creates a copy of the test repository with a worktree. This is allows you
// to run normal 'non-bare' Git commands.
func CloneRepoWithWorktree(t testing.TB) (repo *gitalypb.Repository, repoPath string, cleanup func()) {
return cloneRepo(t, testhelper.GitlabTestStoragePath(), NewRepositoryName(t, false), false)
}
// CloneRepoWithWorktree creates a copy of the test repository with a worktree. This is allows you
// to run normal 'non-bare' Git commands.
func CloneRepoWithWorktreeAtStorage(t testing.TB, storage config.Storage) (*gitalypb.Repository, string, testhelper.Cleanup) {
repo, repoPath, cleanup := cloneRepo(t, storage.Path, NewRepositoryName(t, false), false)
repo.StorageName = storage.Name
return repo, repoPath, cleanup
}
// testRepositoryPath returns the absolute path of local 'gitlab-org/gitlab-test.git' clone.
// It is cloned under the path by the test preparing step of make.
func testRepositoryPath(t testing.TB) string {
_, currentFile, _, ok := runtime.Caller(0)
if !ok {
require.Fail(t, "could not get caller info")
}
path := filepath.Join(filepath.Dir(currentFile), "..", "..", "..", "_build", "testrepos", "gitlab-test.git")
if !isValidRepoPath(path) {
makePath := filepath.Join(filepath.Dir(currentFile), "..", "..", "..")
makeTarget := "prepare-test-repos"
log.Printf("local clone of 'gitlab-org/gitlab-test.git' not found in %q, running `make %v`", path, makeTarget)
testhelper.MustRunCommand(t, nil, "make", "-C", makePath, makeTarget)
}
return path
}
// isValidRepoPath checks whether a valid git repository exists at the given path.
func isValidRepoPath(absolutePath string) bool {
if _, err := os.Stat(filepath.Join(absolutePath, "objects")); err != nil {
return false
}
return true
}
func cloneRepo(t testing.TB, storageRoot, relativePath string, bare bool) (repo *gitalypb.Repository, repoPath string, cleanup func()) {
repoPath = filepath.Join(storageRoot, relativePath)
repo = InitRepoDir(t, storageRoot, 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 = filepath.Join(relativePath, ".git")
}
testhelper.MustRunCommand(t, nil, "git", append(args, testRepositoryPath(t), repoPath)...)
return repo, repoPath, func() { require.NoError(t, 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.TB, repoPath string, worktreeName string) {
testhelper.MustRunCommand(t, nil, "git", AddWorktreeArgs(repoPath, worktreeName)...)
}
|
