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
|
package ssh
import (
"context"
"fmt"
"io"
"os"
"os/exec"
"path"
"strings"
"testing"
"time"
"github.com/golang/protobuf/jsonpb"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/internal/git"
"gitlab.com/gitlab-org/gitaly/internal/helper/text"
"gitlab.com/gitlab-org/gitaly/internal/metadata/featureflag"
"gitlab.com/gitlab-org/gitaly/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/proto/go/gitalypb"
"google.golang.org/grpc/codes"
)
type cloneCommand struct {
command *exec.Cmd
repository *gitalypb.Repository
server string
featureFlags []string
gitConfig string
gitProtocol string
}
func (cmd cloneCommand) execute(t *testing.T) error {
req := &gitalypb.SSHUploadPackRequest{
Repository: cmd.repository,
GitProtocol: cmd.gitProtocol,
}
if cmd.gitConfig != "" {
req.GitConfigOptions = strings.Split(cmd.gitConfig, " ")
}
pbMarshaler := &jsonpb.Marshaler{}
payload, err := pbMarshaler.MarshalToString(req)
require.NoError(t, err)
cmd.command.Env = []string{
fmt.Sprintf("GITALY_ADDRESS=%s", cmd.server),
fmt.Sprintf("GITALY_PAYLOAD=%s", payload),
fmt.Sprintf("GITALY_FEATUREFLAGS=%s", strings.Join(cmd.featureFlags, ",")),
fmt.Sprintf("PATH=.:%s", os.Getenv("PATH")),
fmt.Sprintf(`GIT_SSH_COMMAND=%s upload-pack`, gitalySSHPath),
}
out, err := cmd.command.CombinedOutput()
if err != nil {
return fmt.Errorf("%v: %q", err, out)
}
if !cmd.command.ProcessState.Success() {
return fmt.Errorf("Failed to run `git clone`: %q", out)
}
return nil
}
func (cmd cloneCommand) test(t *testing.T, localRepoPath string) (string, string, string, string) {
defer os.RemoveAll(localRepoPath)
err := cmd.execute(t)
require.NoError(t, err)
storagePath := testhelper.GitlabTestStoragePath()
testRepoPath := path.Join(storagePath, testRepo.GetRelativePath())
remoteHead := text.ChompBytes(testhelper.MustRunCommand(t, nil, "git", "-C", testRepoPath, "rev-parse", "master"))
localHead := text.ChompBytes(testhelper.MustRunCommand(t, nil, "git", "-C", localRepoPath, "rev-parse", "master"))
remoteTags := text.ChompBytes(testhelper.MustRunCommand(t, nil, "git", "-C", testRepoPath, "tag"))
localTags := text.ChompBytes(testhelper.MustRunCommand(t, nil, "git", "-C", localRepoPath, "tag"))
return localHead, remoteHead, localTags, remoteTags
}
func TestFailedUploadPackRequestDueToTimeout(t *testing.T) {
server, serverSocketPath := runSSHServer(t, WithUploadPackRequestTimeout(10*time.Microsecond))
defer server.Stop()
client, conn := newSSHClient(t, serverSocketPath)
defer conn.Close()
ctx, cancel := testhelper.Context()
defer cancel()
stream, err := client.SSHUploadPack(ctx)
require.NoError(t, err)
// The first request is not limited by timeout, but also not under attacker control
require.NoError(t, stream.Send(&gitalypb.SSHUploadPackRequest{Repository: testRepo}))
// Because the client says nothing, the server would block. Because of
// the timeout, it won't block forever, and return with a non-zero exit
// code instead.
requireFailedSSHStream(t, func() (int32, error) {
resp, err := stream.Recv()
if err != nil {
return 0, err
}
var code int32
if status := resp.GetExitStatus(); status != nil {
code = status.Value
}
return code, nil
})
}
func requireFailedSSHStream(t *testing.T, recv func() (int32, error)) {
done := make(chan struct{})
var code int32
var err error
go func() {
for err == nil {
code, err = recv()
}
close(done)
}()
select {
case <-done:
require.Equal(t, io.EOF, err)
require.NotEqual(t, 0, code, "exit status")
case <-time.After(10 * time.Second):
t.Fatal("timeout waiting for SSH stream")
}
}
func TestFailedUploadPackRequestDueToValidationError(t *testing.T) {
server, serverSocketPath := runSSHServer(t)
defer server.Stop()
client, conn := newSSHClient(t, serverSocketPath)
defer conn.Close()
tests := []struct {
Desc string
Req *gitalypb.SSHUploadPackRequest
Code codes.Code
}{
{
Desc: "Repository.RelativePath is empty",
Req: &gitalypb.SSHUploadPackRequest{Repository: &gitalypb.Repository{StorageName: "default", RelativePath: ""}},
Code: codes.InvalidArgument,
},
{
Desc: "Repository is nil",
Req: &gitalypb.SSHUploadPackRequest{Repository: nil},
Code: codes.InvalidArgument,
},
{
Desc: "Data exists on first request",
Req: &gitalypb.SSHUploadPackRequest{Repository: &gitalypb.Repository{StorageName: "default", RelativePath: "path/to/repo"}, Stdin: []byte("Fail")},
Code: codes.InvalidArgument,
},
}
for _, test := range tests {
t.Run(test.Desc, func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
stream, err := client.SSHUploadPack(ctx)
if err != nil {
t.Fatal(err)
}
if err = stream.Send(test.Req); err != nil {
t.Fatal(err)
}
stream.CloseSend()
err = testPostUploadPackFailedResponse(t, stream)
testhelper.RequireGrpcError(t, err, test.Code)
})
}
}
func TestUploadPackCloneSuccess(t *testing.T) {
server, serverSocketPath := runSSHServer(t)
defer server.Stop()
localRepoPath := path.Join(testRepoRoot, "gitlab-test-upload-pack-local")
tests := []struct {
cmd *exec.Cmd
desc string
}{
{
cmd: exec.Command("git", "clone", "git@localhost:test/test.git", localRepoPath),
desc: "full clone",
},
{
cmd: exec.Command("git", "clone", "--depth", "1", "git@localhost:test/test.git", localRepoPath),
desc: "shallow clone",
},
}
for _, tc := range tests {
t.Run(tc.desc, func(t *testing.T) {
cmd := cloneCommand{
repository: testRepo,
command: tc.cmd,
server: serverSocketPath,
}
lHead, rHead, _, _ := cmd.test(t, localRepoPath)
require.Equal(t, lHead, rHead, "local and remote head not equal")
})
}
}
func TestUploadPackCloneWithPartialCloneFilter(t *testing.T) {
server, serverSocketPath := runSSHServer(t)
defer server.Stop()
// Ruby file which is ~1kB in size and not present in HEAD
blobLessThanLimit := "6ee41e85cc9bf33c10b690df09ca735b22f3790f"
// Image which is ~100kB in size and not present in HEAD
blobGreaterThanLimit := "18079e308ff9b3a5e304941020747e5c39b46c88"
tests := []struct {
desc string
flags []string
repoTest func(t *testing.T, repoPath string)
}{
{
desc: "full_clone",
repoTest: func(t *testing.T, repoPath string) {
testhelper.GitObjectMustExist(t, repoPath, blobGreaterThanLimit)
},
},
{
desc: "partial_clone",
flags: []string{featureflag.UploadPackFilter},
repoTest: func(t *testing.T, repoPath string) {
testhelper.GitObjectMustNotExist(t, repoPath, blobGreaterThanLimit)
},
},
}
for _, tc := range tests {
t.Run(tc.desc, func(t *testing.T) {
// Run the clone with filtering enabled in both runs. The only
// difference is that in the first run, we have the
// UploadPackFilter flag disabled.
localPath := path.Join(testRepoRoot, fmt.Sprintf("gitlab-test-upload-pack-local-%s", tc.desc))
cmd := cloneCommand{
repository: testRepo,
command: exec.Command("git", "clone", "--filter=blob:limit=2048", "git@localhost:test/test.git", localPath),
server: serverSocketPath,
featureFlags: tc.flags,
}
err := cmd.execute(t)
defer os.RemoveAll(localPath)
require.NoError(t, err, "clone failed")
testhelper.GitObjectMustExist(t, localPath, blobLessThanLimit)
tc.repoTest(t, localPath)
})
}
}
func TestUploadPackCloneSuccessWithGitProtocol(t *testing.T) {
restore := testhelper.EnableGitProtocolV2Support()
defer restore()
server, serverSocketPath := runSSHServer(t)
defer server.Stop()
localRepoPath := path.Join(testRepoRoot, "gitlab-test-upload-pack-local")
tests := []struct {
cmd *exec.Cmd
desc string
}{
{
cmd: exec.Command("git", "clone", "git@localhost:test/test.git", localRepoPath),
desc: "full clone",
},
{
cmd: exec.Command("git", "clone", "--depth", "1", "git@localhost:test/test.git", localRepoPath),
desc: "shallow clone",
},
}
for _, tc := range tests {
t.Run(tc.desc, func(t *testing.T) {
cmd := cloneCommand{
repository: testRepo,
command: tc.cmd,
server: serverSocketPath,
gitProtocol: git.ProtocolV2,
}
lHead, rHead, _, _ := cmd.test(t, localRepoPath)
require.Equal(t, lHead, rHead, "local and remote head not equal")
envData, err := testhelper.GetGitEnvData()
require.NoError(t, err)
require.Equal(t, fmt.Sprintf("GIT_PROTOCOL=%s\n", git.ProtocolV2), envData)
})
}
}
func TestUploadPackCloneHideTags(t *testing.T) {
server, serverSocketPath := runSSHServer(t)
defer server.Stop()
localRepoPath := path.Join(testRepoRoot, "gitlab-test-upload-pack-local-hide-tags")
cmd := cloneCommand{
repository: testRepo,
command: exec.Command("git", "clone", "--mirror", "git@localhost:test/test.git", localRepoPath),
server: serverSocketPath,
gitConfig: "transfer.hideRefs=refs/tags",
}
_, _, lTags, rTags := cmd.test(t, localRepoPath)
if lTags == rTags {
t.Fatalf("local and remote tags are equal. clone failed: %q != %q", lTags, rTags)
}
if tag := "v1.0.0"; !strings.Contains(rTags, tag) {
t.Fatalf("sanity check failed, tag %q not found in %q", tag, rTags)
}
}
func TestUploadPackCloneFailure(t *testing.T) {
server, serverSocketPath := runSSHServer(t)
defer server.Stop()
localRepoPath := path.Join(testRepoRoot, "gitlab-test-upload-pack-local-failure")
cmd := cloneCommand{
repository: &gitalypb.Repository{
StorageName: "foobar",
RelativePath: testRepo.GetRelativePath(),
},
command: exec.Command("git", "clone", "git@localhost:test/test.git", localRepoPath),
server: serverSocketPath,
}
err := cmd.execute(t)
require.Error(t, err, "clone didn't fail")
}
func testPostUploadPackFailedResponse(t *testing.T, stream gitalypb.SSHService_SSHUploadPackClient) error {
var err error
var res *gitalypb.SSHUploadPackResponse
for err == nil {
res, err = stream.Recv()
require.Nil(t, res.GetStdout())
}
return err
}
|