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
|
package main
import (
"context"
"errors"
"fmt"
"io"
"log"
"os"
"strconv"
"strings"
"github.com/sirupsen/logrus"
gitalyauth "gitlab.com/gitlab-org/gitaly/auth"
"gitlab.com/gitlab-org/gitaly/client"
"gitlab.com/gitlab-org/gitaly/internal/git"
"gitlab.com/gitlab-org/gitaly/internal/gitaly/config"
"gitlab.com/gitlab-org/gitaly/internal/gitaly/config/prometheus"
"gitlab.com/gitlab-org/gitaly/internal/gitaly/hook"
"gitlab.com/gitlab-org/gitaly/internal/gitlab"
gitalylog "gitlab.com/gitlab-org/gitaly/internal/log"
"gitlab.com/gitlab-org/gitaly/internal/metadata/featureflag"
"gitlab.com/gitlab-org/gitaly/internal/stream"
"gitlab.com/gitlab-org/gitaly/proto/go/gitalypb"
"gitlab.com/gitlab-org/gitaly/streamio"
"gitlab.com/gitlab-org/labkit/tracing"
"google.golang.org/grpc"
)
type hookCommand struct {
exec func(context.Context, git.HooksPayload, gitalypb.HookServiceClient, []string) (int, error)
hookType git.Hook
}
var (
hooksBySubcommand = map[string]hookCommand{
"update": hookCommand{
exec: updateHook,
hookType: git.UpdateHook,
},
"pre-receive": hookCommand{
exec: preReceiveHook,
hookType: git.PreReceiveHook,
},
"post-receive": hookCommand{
exec: postReceiveHook,
hookType: git.PostReceiveHook,
},
"reference-transaction": hookCommand{
exec: referenceTransactionHook,
hookType: git.ReferenceTransactionHook,
},
"git": hookCommand{
exec: packObjectsHook,
hookType: git.PackObjectsHook,
},
}
logger *gitalylog.HookLogger
)
func main() {
logger = gitalylog.NewHookLogger()
if len(os.Args) < 2 {
logger.Fatalf("requires hook name. args: %v", os.Args)
}
subCmd := os.Args[1]
if subCmd == "check" {
logrus.SetLevel(logrus.ErrorLevel)
if len(os.Args) != 3 {
log.Fatal(errors.New("no configuration file path provided invoke with: gitaly-hooks check <config_path>"))
}
configPath := os.Args[2]
fmt.Print("Checking GitLab API access: ")
info, err := check(configPath)
if err != nil {
fmt.Print("FAIL\n")
log.Fatal(err)
}
fmt.Print("OK\n")
fmt.Printf("GitLab version: %s\n", info.Version)
fmt.Printf("GitLab revision: %s\n", info.Revision)
fmt.Printf("GitLab Api version: %s\n", info.APIVersion)
fmt.Printf("Redis reachable for GitLab: %t\n", info.RedisReachable)
fmt.Println("OK")
os.Exit(0)
}
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
// Since the environment is sanitized at the moment, we're only
// using this to extract the correlation ID. The finished() call
// to clean up the tracing will be a NOP here.
ctx, finished := tracing.ExtractFromEnv(ctx)
defer finished()
payload, err := git.HooksPayloadFromEnv(os.Environ())
if err != nil {
logger.Fatalf("error when getting hooks payload: %v", err)
}
hookCommand, ok := hooksBySubcommand[subCmd]
if !ok {
logger.Fatalf("subcommand name invalid: %q", subCmd)
}
// If the hook wasn't requested, then we simply skip executing any
// logic.
if !payload.IsHookRequested(hookCommand.hookType) {
os.Exit(0)
}
conn, err := dialGitaly(payload)
if err != nil {
logger.Fatalf("error when connecting to gitaly: %v", err)
}
hookClient := gitalypb.NewHookServiceClient(conn)
ctx = featureflag.OutgoingWithRaw(ctx, payload.FeatureFlags)
returnCode, err := hookCommand.exec(ctx, payload, hookClient, os.Args)
if err != nil {
logger.Fatal(err)
}
os.Exit(returnCode)
}
func noopSender(c chan error) {}
func dialGitaly(payload git.HooksPayload) (*grpc.ClientConn, error) {
dialOpts := client.DefaultDialOpts
if payload.InternalSocketToken != "" {
dialOpts = append(dialOpts, grpc.WithPerRPCCredentials(gitalyauth.RPCCredentialsV2(payload.InternalSocketToken)))
}
conn, err := client.Dial("unix://"+payload.InternalSocket, dialOpts)
if err != nil {
return nil, fmt.Errorf("error when dialing: %w", err)
}
return conn, nil
}
func gitPushOptions() []string {
var gitPushOptions []string
gitPushOptionCount, err := strconv.Atoi(os.Getenv("GIT_PUSH_OPTION_COUNT"))
if err != nil {
return gitPushOptions
}
for i := 0; i < gitPushOptionCount; i++ {
gitPushOptions = append(gitPushOptions, os.Getenv(fmt.Sprintf("GIT_PUSH_OPTION_%d", i)))
}
return gitPushOptions
}
func sendFunc(reqWriter io.Writer, stream grpc.ClientStream, stdin io.Reader) func(errC chan error) {
return func(errC chan error) {
_, errSend := io.Copy(reqWriter, stdin)
stream.CloseSend()
errC <- errSend
}
}
func check(configPath string) (*gitlab.CheckInfo, error) {
cfgFile, err := os.Open(configPath)
if err != nil {
return nil, fmt.Errorf("failed to open config file: %w", err)
}
defer cfgFile.Close()
cfg, err := config.Load(cfgFile)
if err != nil {
return nil, err
}
gitlabAPI, err := gitlab.NewHTTPClient(cfg.Gitlab, cfg.TLS, prometheus.Config{})
if err != nil {
return nil, err
}
return hook.NewManager(config.NewLocator(cfg), nil, gitlabAPI, cfg).Check(context.TODO())
}
func updateHook(ctx context.Context, payload git.HooksPayload, hookClient gitalypb.HookServiceClient, args []string) (int, error) {
args = args[2:]
if len(args) != 3 {
return 1, errors.New("update hook expects exactly three arguments")
}
ref, oldValue, newValue := args[0], args[1], args[2]
req := &gitalypb.UpdateHookRequest{
Repository: payload.Repo,
EnvironmentVariables: os.Environ(),
Ref: []byte(ref),
OldValue: oldValue,
NewValue: newValue,
}
updateHookStream, err := hookClient.UpdateHook(ctx, req)
if err != nil {
return 1, fmt.Errorf("error when starting command for update hook: %v", err)
}
var returnCode int32
if returnCode, err = stream.Handler(func() (stream.StdoutStderrResponse, error) {
return updateHookStream.Recv()
}, noopSender, os.Stdout, os.Stderr); err != nil {
return 1, fmt.Errorf("error when receiving data for update hook: %v", err)
}
return int(returnCode), nil
}
func preReceiveHook(ctx context.Context, payload git.HooksPayload, hookClient gitalypb.HookServiceClient, args []string) (int, error) {
preReceiveHookStream, err := hookClient.PreReceiveHook(ctx)
if err != nil {
return 1, fmt.Errorf("error when getting preReceiveHookStream client for: %v", err)
}
if err := preReceiveHookStream.Send(&gitalypb.PreReceiveHookRequest{
Repository: payload.Repo,
EnvironmentVariables: os.Environ(),
GitPushOptions: gitPushOptions(),
}); err != nil {
return 1, fmt.Errorf("error when sending request for pre-receive hook: %v", err)
}
f := sendFunc(streamio.NewWriter(func(p []byte) error {
return preReceiveHookStream.Send(&gitalypb.PreReceiveHookRequest{Stdin: p})
}), preReceiveHookStream, os.Stdin)
var returnCode int32
if returnCode, err = stream.Handler(func() (stream.StdoutStderrResponse, error) {
return preReceiveHookStream.Recv()
}, f, os.Stdout, os.Stderr); err != nil {
return 1, fmt.Errorf("error when receiving data for pre-receive hook: %v", err)
}
return int(returnCode), nil
}
func postReceiveHook(ctx context.Context, payload git.HooksPayload, hookClient gitalypb.HookServiceClient, args []string) (int, error) {
postReceiveHookStream, err := hookClient.PostReceiveHook(ctx)
if err != nil {
return 1, fmt.Errorf("error when getting stream client for post-receive hook: %v", err)
}
if err := postReceiveHookStream.Send(&gitalypb.PostReceiveHookRequest{
Repository: payload.Repo,
EnvironmentVariables: os.Environ(),
GitPushOptions: gitPushOptions(),
}); err != nil {
return 1, fmt.Errorf("error when sending request for post-receive hook: %v", err)
}
f := sendFunc(streamio.NewWriter(func(p []byte) error {
return postReceiveHookStream.Send(&gitalypb.PostReceiveHookRequest{Stdin: p})
}), postReceiveHookStream, os.Stdin)
var returnCode int32
if returnCode, err = stream.Handler(func() (stream.StdoutStderrResponse, error) {
return postReceiveHookStream.Recv()
}, f, os.Stdout, os.Stderr); err != nil {
return 1, fmt.Errorf("error when receiving data for post-receive hook: %v", err)
}
return int(returnCode), nil
}
func referenceTransactionHook(ctx context.Context, payload git.HooksPayload, hookClient gitalypb.HookServiceClient, args []string) (int, error) {
if len(args) != 3 {
return 1, errors.New("reference-transaction hook is missing required arguments")
}
var state gitalypb.ReferenceTransactionHookRequest_State
switch args[2] {
case "prepared":
state = gitalypb.ReferenceTransactionHookRequest_PREPARED
case "committed":
state = gitalypb.ReferenceTransactionHookRequest_COMMITTED
case "aborted":
state = gitalypb.ReferenceTransactionHookRequest_ABORTED
default:
return 1, fmt.Errorf("reference-transaction hook has invalid state: %q", args[2])
}
referenceTransactionHookStream, err := hookClient.ReferenceTransactionHook(ctx)
if err != nil {
return 1, fmt.Errorf("error when getting referenceTransactionHookStream client: %v", err)
}
if err := referenceTransactionHookStream.Send(&gitalypb.ReferenceTransactionHookRequest{
Repository: payload.Repo,
EnvironmentVariables: os.Environ(),
State: state,
}); err != nil {
return 1, fmt.Errorf("error when sending request for reference-transaction hook: %v", err)
}
f := sendFunc(streamio.NewWriter(func(p []byte) error {
return referenceTransactionHookStream.Send(&gitalypb.ReferenceTransactionHookRequest{Stdin: p})
}), referenceTransactionHookStream, os.Stdin)
var returnCode int32
if returnCode, err = stream.Handler(func() (stream.StdoutStderrResponse, error) {
return referenceTransactionHookStream.Recv()
}, f, os.Stdout, os.Stderr); err != nil {
return 1, fmt.Errorf("error when receiving data for reference-transaction hook: %v", err)
}
return int(returnCode), nil
}
func packObjectsHook(ctx context.Context, payload git.HooksPayload, hookClient gitalypb.HookServiceClient, args []string) (int, error) {
var fixedArgs []string
for _, a := range args[2:] {
fixedArgs = append(fixedArgs, fixFilterQuoteBug(a))
}
if err := handlePackObjects(ctx, hookClient, payload.Repo, fixedArgs); err != nil {
logger.Logger().WithFields(logrus.Fields{"args": args}).WithError(err).Error("PackObjectsHook RPC failed")
return 1, nil
}
return 0, nil
}
// This is a workaround for a bug in Git:
// https://gitlab.com/gitlab-org/git/-/issues/82. Once that bug is fixed
// we should no longer need this. The fix function is harmless if the bug
// is not present.
func fixFilterQuoteBug(arg string) string {
const prefix = "--filter='"
if !(strings.HasPrefix(arg, prefix) && strings.HasSuffix(arg, "'")) {
return arg
}
filterSpec := arg[len(prefix) : len(arg)-1]
// Perform the inverse of sq_quote_buf() in quote.c. The surrounding quotes
// are already gone, we now need to undo escaping of ! and '. The escape
// patterns are '\!' and '\'' respectively.
filterSpec = strings.ReplaceAll(filterSpec, `'\!'`, `!`)
filterSpec = strings.ReplaceAll(filterSpec, `'\''`, `'`)
return "--filter=" + filterSpec
}
func handlePackObjects(ctx context.Context, hookClient gitalypb.HookServiceClient, repo *gitalypb.Repository, args []string) error {
packObjectsStream, err := hookClient.PackObjectsHook(ctx)
if err != nil {
return fmt.Errorf("initiate rpc: %w", err)
}
if err := packObjectsStream.Send(&gitalypb.PackObjectsHookRequest{
Repository: repo,
Args: args,
}); err != nil {
return fmt.Errorf("first request: %w", err)
}
stdin := sendFunc(streamio.NewWriter(func(p []byte) error {
return packObjectsStream.Send(&gitalypb.PackObjectsHookRequest{Stdin: p})
}), packObjectsStream, os.Stdin)
if _, err := stream.Handler(func() (stream.StdoutStderrResponse, error) {
resp, err := packObjectsStream.Recv()
return nopExitStatus{resp}, err
}, stdin, os.Stdout, os.Stderr); err != nil {
return fmt.Errorf("handle stream: %w", err)
}
return nil
}
type stdoutStderr interface {
GetStdout() []byte
GetStderr() []byte
}
type nopExitStatus struct {
stdoutStderr
}
func (nopExitStatus) GetExitStatus() *gitalypb.ExitStatus { return nil }
|