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
|
package operations
import (
"context"
"errors"
"fmt"
"io"
"io/ioutil"
"strings"
"testing"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/internal/git"
"gitlab.com/gitlab-org/gitaly/internal/git/localrepo"
"gitlab.com/gitlab-org/gitaly/internal/gitaly/hook"
"gitlab.com/gitlab-org/gitaly/internal/gitaly/service"
hookservice "gitlab.com/gitlab-org/gitaly/internal/gitaly/service/hook"
"gitlab.com/gitlab-org/gitaly/internal/metadata/featureflag"
"gitlab.com/gitlab-org/gitaly/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/internal/testhelper/testcfg"
"gitlab.com/gitlab-org/gitaly/internal/testhelper/testserver"
"gitlab.com/gitlab-org/gitaly/proto/go/gitalypb"
"google.golang.org/grpc"
)
type mockHookManager struct {
t *testing.T
preReceive func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error
postReceive func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error
update func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, ref, oldValue, newValue string, env []string, stdout, stderr io.Writer) error
referenceTransaction func(t *testing.T, ctx context.Context, state hook.ReferenceTransactionState, env []string, stdin io.Reader) error
}
func (m *mockHookManager) PreReceiveHook(ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error {
return m.preReceive(m.t, ctx, repo, pushOptions, env, stdin, stdout, stderr)
}
func (m *mockHookManager) PostReceiveHook(ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error {
return m.postReceive(m.t, ctx, repo, pushOptions, env, stdin, stdout, stderr)
}
func (m *mockHookManager) UpdateHook(ctx context.Context, repo *gitalypb.Repository, ref, oldValue, newValue string, env []string, stdout, stderr io.Writer) error {
return m.update(m.t, ctx, repo, ref, oldValue, newValue, env, stdout, stderr)
}
func (m *mockHookManager) ReferenceTransactionHook(ctx context.Context, state hook.ReferenceTransactionState, env []string, stdin io.Reader) error {
return m.referenceTransaction(m.t, ctx, state, env, stdin)
}
func TestUpdateReferenceWithHooks_invalidParameters(t *testing.T) {
ctx, cancel := testhelper.Context()
defer cancel()
cfg, repo, _ := testcfg.BuildWithRepo(t)
user := &gitalypb.User{
GlId: "1234",
GlUsername: "Username",
Name: []byte("Name"),
Email: []byte("mail@example.com"),
}
revA, revB := git.ObjectID(strings.Repeat("a", 40)), git.ObjectID(strings.Repeat("b", 40))
server := NewServer(cfg, nil, &mockHookManager{}, nil, nil, nil, nil)
testCases := []struct {
desc string
ref git.ReferenceName
newRev, oldRev git.ObjectID
expectedErr string
}{
{
desc: "missing reference",
oldRev: revA,
newRev: revB,
expectedErr: "got no reference",
},
{
desc: "missing old rev",
ref: "refs/heads/master",
newRev: revB,
expectedErr: "got invalid old value",
},
{
desc: "missing new rev",
ref: "refs/heads/master",
oldRev: revB,
expectedErr: "got invalid new value",
},
{
desc: "invalid old rev",
ref: "refs/heads/master",
newRev: revA,
oldRev: "foobar",
expectedErr: "got invalid old value",
},
{
desc: "invalid new rev",
ref: "refs/heads/master",
newRev: "foobar",
oldRev: revB,
expectedErr: "got invalid new value",
},
}
for _, tc := range testCases {
t.Run(tc.desc, func(t *testing.T) {
err := server.updateReferenceWithHooks(ctx, repo, user, tc.ref, tc.newRev, tc.oldRev)
require.Contains(t, err.Error(), tc.expectedErr)
})
}
}
func TestUpdateReferenceWithHooks(t *testing.T) {
ctx, cancel := testhelper.Context()
defer cancel()
cfg, repo, repoPath := testcfg.BuildWithRepo(t)
// We need to set up a separate "real" hook service here, as it will be used in
// git-update-ref(1) spawned by `updateRefWithHooks()`
testserver.RunGitalyServer(t, cfg, nil, func(srv *grpc.Server, deps *service.Dependencies) {
gitalypb.RegisterHookServiceServer(srv, hookservice.NewServer(deps.GetCfg(), deps.GetHookManager(), deps.GetGitCmdFactory()))
})
user := &gitalypb.User{
GlId: "1234",
GlUsername: "Username",
Name: []byte("Name"),
Email: []byte("mail@example.com"),
}
oldRev := "1e292f8fedd741b75372e19097c76d327140c312"
payload, err := git.NewHooksPayload(cfg, repo, nil, nil, &git.ReceiveHooksPayload{
UserID: "1234",
Username: "Username",
Protocol: "web",
}, git.ReceivePackHooks, featureflag.RawFromContext(ctx)).Env()
require.NoError(t, err)
expectedEnv := []string{
payload,
}
testCases := []struct {
desc string
preReceive func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error
postReceive func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error
update func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, ref, oldValue, newValue string, env []string, stdout, stderr io.Writer) error
referenceTransaction func(t *testing.T, ctx context.Context, state hook.ReferenceTransactionState, env []string, stdin io.Reader) error
expectedErr string
expectedRefDeletion bool
}{
{
desc: "successful update",
preReceive: func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error {
changes, err := ioutil.ReadAll(stdin)
require.NoError(t, err)
require.Equal(t, fmt.Sprintf("%s %s refs/heads/master\n", oldRev, git.ZeroOID.String()), string(changes))
require.Empty(t, pushOptions)
require.Equal(t, env, expectedEnv)
return nil
},
update: func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, ref, oldValue, newValue string, env []string, stdout, stderr io.Writer) error {
require.Equal(t, "refs/heads/master", ref)
require.Equal(t, oldRev, oldValue)
require.Equal(t, newValue, git.ZeroOID.String())
require.Equal(t, env, expectedEnv)
return nil
},
postReceive: func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error {
changes, err := ioutil.ReadAll(stdin)
require.NoError(t, err)
require.Equal(t, fmt.Sprintf("%s %s refs/heads/master\n", oldRev, git.ZeroOID.String()), string(changes))
require.Equal(t, env, expectedEnv)
require.Empty(t, pushOptions)
return nil
},
referenceTransaction: func(t *testing.T, ctx context.Context, state hook.ReferenceTransactionState, env []string, stdin io.Reader) error {
changes, err := ioutil.ReadAll(stdin)
require.NoError(t, err)
require.Equal(t, fmt.Sprintf("%s %s refs/heads/master\n", oldRev, git.ZeroOID.String()), string(changes))
require.Equal(t, state, hook.ReferenceTransactionPrepared)
require.Equal(t, env, expectedEnv)
return nil
},
expectedRefDeletion: true,
},
{
desc: "prereceive error",
preReceive: func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error {
_, err := io.Copy(stderr, strings.NewReader("prereceive failure"))
require.NoError(t, err)
return errors.New("ignored")
},
expectedErr: "prereceive failure",
},
{
desc: "prereceive error from GitLab API response",
preReceive: func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error {
return hook.NotAllowedError{Message: "GitLab: file is locked"}
},
expectedErr: "GitLab: file is locked",
},
{
desc: "update error",
preReceive: func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error {
return nil
},
update: func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, ref, oldValue, newValue string, env []string, stdout, stderr io.Writer) error {
_, err := io.Copy(stderr, strings.NewReader("update failure"))
require.NoError(t, err)
return errors.New("ignored")
},
expectedErr: "update failure",
},
{
desc: "reference-transaction error",
preReceive: func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error {
return nil
},
update: func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, ref, oldValue, newValue string, env []string, stdout, stderr io.Writer) error {
return nil
},
referenceTransaction: func(t *testing.T, ctx context.Context, state hook.ReferenceTransactionState, env []string, stdin io.Reader) error {
// The reference-transaction hook doesn't execute any custom hooks,
// which is why it currently doesn't have any stdout/stderr.
// Instead, errors are directly returned.
return errors.New("reference-transaction failure")
},
expectedErr: "reference-transaction failure",
},
{
desc: "post-receive error",
preReceive: func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error {
return nil
},
update: func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, ref, oldValue, newValue string, env []string, stdout, stderr io.Writer) error {
return nil
},
referenceTransaction: func(t *testing.T, ctx context.Context, state hook.ReferenceTransactionState, env []string, stdin io.Reader) error {
return nil
},
postReceive: func(t *testing.T, ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error {
_, err := io.Copy(stderr, strings.NewReader("post-receive failure"))
require.NoError(t, err)
return errors.New("ignored")
},
expectedErr: "post-receive failure",
expectedRefDeletion: true,
},
}
for _, tc := range testCases {
t.Run(tc.desc, func(t *testing.T) {
hookManager := &mockHookManager{
t: t,
preReceive: tc.preReceive,
postReceive: tc.postReceive,
update: tc.update,
referenceTransaction: tc.referenceTransaction,
}
gitCmdFactory := git.NewExecCommandFactory(cfg)
hookServer := NewServer(cfg, nil, hookManager, nil, nil, gitCmdFactory, nil)
err := hookServer.updateReferenceWithHooks(ctx, repo, user, git.ReferenceName("refs/heads/master"), git.ZeroOID, git.ObjectID(oldRev))
if tc.expectedErr == "" {
require.NoError(t, err)
} else {
require.Contains(t, err.Error(), tc.expectedErr)
}
if tc.expectedRefDeletion {
contained, err := localrepo.NewTestRepo(t, cfg, repo).HasRevision(ctx, git.Revision("refs/heads/master"))
require.NoError(t, err)
require.False(t, contained, "branch should have been deleted")
testhelper.MustRunCommand(t, nil, "git", "-C", repoPath, "branch", "master", oldRev)
} else {
ref, err := localrepo.NewTestRepo(t, cfg, repo).GetReference(ctx, "refs/heads/master")
require.NoError(t, err)
require.Equal(t, ref.Target, oldRev)
}
})
}
}
|
