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
|
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/v14/internal/gitaly/config"
"gitlab.com/gitlab-org/gitaly/v14/internal/helper/text"
"gitlab.com/gitlab-org/gitaly/v14/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/v14/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, 0o755), "making repo parent dir")
return &gitalypb.Repository{
StorageName: "default",
RelativePath: relativePath,
GlRepository: GlRepository,
GlProjectPath: GlProjectPath,
}
}
// 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)
}
// InitRepoOpts contains options for InitRepo.
type InitRepoOpts struct {
// WithWorktree determines whether the resulting Git repository should have a worktree or
// not.
WithWorktree bool
}
// InitRepo creates a new empty repository in the given storage. You can either pass no or exactly
// one InitRepoOpts.
func InitRepo(t testing.TB, cfg config.Cfg, storage config.Storage, opts ...InitRepoOpts) (*gitalypb.Repository, string) {
require.Less(t, len(opts), 2, "you must either pass no or exactly one option")
opt := InitRepoOpts{}
if len(opts) == 1 {
opt = opts[0]
}
relativePath := NewRepositoryName(t, !opt.WithWorktree)
repoPath := filepath.Join(storage.Path, relativePath)
args := []string{"init"}
if !opt.WithWorktree {
args = append(args, "--bare")
}
Exec(t, cfg, append(args, repoPath)...)
repo := InitRepoDir(t, storage.Path, relativePath)
repo.StorageName = storage.Name
if opt.WithWorktree {
repo.RelativePath = filepath.Join(repo.RelativePath, ".git")
}
t.Cleanup(func() { require.NoError(t, os.RemoveAll(repoPath)) })
return repo, repoPath
}
// CloneRepoOpts is an option for CloneRepo.
type CloneRepoOpts struct {
// RelativePath determines the relative path of newly created Git repository. If unset, the
// relative path is computed via NewRepositoryName.
RelativePath string
// WithWorktree determines whether the resulting Git repository should have a worktree or
// not.
WithWorktree bool
// SourceRepo determines the name of the source repository which shall be cloned. The source
// repository is assumed to be relative to "_build/testrepos". If unset, defaults to
// "gitlab-test.git".
SourceRepo string
}
// CloneRepo clones a new copy of test repository under a subdirectory in the storage root. You can
// either pass no or exactly one CloneRepoOpts.
func CloneRepo(t testing.TB, cfg config.Cfg, storage config.Storage, opts ...CloneRepoOpts) (*gitalypb.Repository, string) {
require.Less(t, len(opts), 2, "you must either pass no or exactly one option")
opt := CloneRepoOpts{}
if len(opts) == 1 {
opt = opts[0]
}
relativePath := opt.RelativePath
if relativePath == "" {
relativePath = NewRepositoryName(t, !opt.WithWorktree)
}
sourceRepo := opt.SourceRepo
if sourceRepo == "" {
sourceRepo = "gitlab-test.git"
}
repo := InitRepoDir(t, storage.Path, relativePath)
repo.StorageName = storage.Name
args := []string{"clone", "--no-hardlinks", "--dissociate"}
if !opt.WithWorktree {
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")
}
absolutePath := filepath.Join(storage.Path, relativePath)
Exec(t, cfg, append(args, testRepositoryPath(t, sourceRepo), absolutePath)...)
t.Cleanup(func() { require.NoError(t, os.RemoveAll(absolutePath)) })
return repo, absolutePath
}
// BundleTestRepo creates a bundle of a local test repo. E.g.
// `gitlab-test.git`. `patterns` define the bundle contents as per
// `git-rev-list-args`. If there are no patterns then `--all` is assumed.
func BundleTestRepo(t testing.TB, cfg config.Cfg, sourceRepo, bundlePath string, patterns ...string) {
if len(patterns) == 0 {
patterns = []string{"--all"}
}
repoPath := testRepositoryPath(t, sourceRepo)
Exec(t, cfg, append([]string{"-C", repoPath, "bundle", "create", bundlePath}, patterns...)...)
}
// 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, repo string) string {
_, currentFile, _, ok := runtime.Caller(0)
if !ok {
require.Fail(t, "could not get caller info")
}
path := filepath.Join(filepath.Dir(currentFile), "..", "..", "..", "_build", "testrepos", repo)
if !isValidRepoPath(path) {
makePath := filepath.Join(filepath.Dir(currentFile), "..", "..", "..")
makeTarget := "prepare-test-repos"
log.Printf("local clone of test repository %q not found in %q, running `make %v`", repo, 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
}
// 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, cfg config.Cfg, repoPath string, worktreeName string) {
Exec(t, cfg, AddWorktreeArgs(repoPath, worktreeName)...)
}
|
