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
|
package hook
import (
"context"
"io"
"gitlab.com/gitlab-org/gitaly/v14/internal/gitaly/config"
"gitlab.com/gitlab-org/gitaly/v14/internal/gitaly/transaction"
"gitlab.com/gitlab-org/gitaly/v14/internal/gitlab"
"gitlab.com/gitlab-org/gitaly/v14/internal/storage"
"gitlab.com/gitlab-org/gitaly/v14/proto/go/gitalypb"
)
// ReferenceTransactionState is the state of the Git reference transaction. It reflects the first
// parameter of the reference-transaction hook. See githooks(1) for more information.
type ReferenceTransactionState int
const (
// ReferenceTransactionPrepared indicates all reference updates have been queued to the
// transaction and were locked on disk.
ReferenceTransactionPrepared = ReferenceTransactionState(iota)
// ReferenceTransactionCommitted indicates the reference transaction was committed and all
// references now have their respective new value.
ReferenceTransactionCommitted
// ReferenceTransactionAborted indicates the transaction was aborted, no changes were
// performed and the reference locks have been released.
ReferenceTransactionAborted
)
// Manager is an interface providing the ability to execute Git hooks.
type Manager interface {
// PreReceiveHook executes the pre-receive Git hook and any installed custom hooks. stdin
// must contain all references to be updated and match the format specified in githooks(5).
PreReceiveHook(ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error
// PostReceiveHook executes the post-receive Git hook and any installed custom hooks. stdin
// must contain all references to be updated and match the format specified in githooks(5).
PostReceiveHook(ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error
// UpdateHook executes the update Git hook and any installed custom hooks for the reference
// `ref` getting updated from `oldValue` to `newValue`.
UpdateHook(ctx context.Context, repo *gitalypb.Repository, ref, oldValue, newValue string, env []string, stdout, stderr io.Writer) error
// ReferenceTransactionHook executes the reference-transaction Git hook. stdin must contain
// all references to be updated and match the format specified in githooks(5).
ReferenceTransactionHook(ctx context.Context, state ReferenceTransactionState, env []string, stdin io.Reader) error
}
// GitLabHookManager is a hook manager containing Git hook business logic. It
// uses the GitLab API to authenticate and track ongoing hook calls.
type GitLabHookManager struct {
locator storage.Locator
gitlabClient gitlab.Client
hooksConfig config.Hooks
txManager transaction.Manager
}
// NewManager returns a new hook manager
func NewManager(locator storage.Locator, txManager transaction.Manager, gitlabClient gitlab.Client, cfg config.Cfg) *GitLabHookManager {
return &GitLabHookManager{
locator: locator,
gitlabClient: gitlabClient,
hooksConfig: cfg.Hooks,
txManager: txManager,
}
}
|
