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
|
package gitaly
import (
"bytes"
"context"
"io"
"io/fs"
"os/exec"
"strings"
"testing"
"github.com/stretchr/testify/require"
gitalyauth "gitlab.com/gitlab-org/gitaly/v16/auth"
"gitlab.com/gitlab-org/gitaly/v16/internal/git/gittest"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/config"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/service/setup"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/storage"
"gitlab.com/gitlab-org/gitaly/v16/internal/grpc/client"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper/testcfg"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper/testserver"
"gitlab.com/gitlab-org/gitaly/v16/proto/go/gitalypb"
"gitlab.com/gitlab-org/gitaly/v16/streamio"
"google.golang.org/grpc"
)
func TestSetHooksSubcommand(t *testing.T) {
t.Parallel()
ctx := testhelper.Context(t)
umask := testhelper.Umask()
cfg := testcfg.Build(t, testcfg.WithStorages("default", "another-storage"))
testcfg.BuildGitaly(t, cfg)
serverSocketPath := testserver.RunGitalyServer(t, cfg, setup.RegisterAll)
repoCfg := cfg
repoCfg.SocketPath = serverSocketPath
// The generated socket path already has the unix prefix. This needs to be
// removed because the Gitaly config does not expect a scheme to be present.
cfg.SocketPath = strings.TrimPrefix(serverSocketPath, "unix://")
client := newRepositoryClient(t, ctx, cfg, serverSocketPath)
configPath := testcfg.WriteTemporaryGitalyConfigFile(t, cfg)
for _, tc := range []struct {
desc string
setup func() ([]string, *gitalypb.Repository)
hooks io.Reader
expectedErr string
expectedState testhelper.DirectoryState
}{
{
desc: "missing repository flag",
setup: func() ([]string, *gitalypb.Repository) {
repo, _ := gittest.CreateRepository(t, ctx, repoCfg)
return []string{
"--storage=" + repo.StorageName,
"--config=" + configPath,
}, repo
},
hooks: &bytes.Buffer{},
expectedErr: "Required flag \"repository\" not set\n",
},
{
desc: "missing config flag",
setup: func() ([]string, *gitalypb.Repository) {
repo, _ := gittest.CreateRepository(t, ctx, repoCfg)
return []string{
"--storage=" + repo.StorageName,
"--repository=" + repo.RelativePath,
}, repo
},
hooks: &bytes.Buffer{},
expectedErr: "Required flag \"config\" not set\n",
},
{
desc: "missing storage flag and config has multiple storages",
setup: func() ([]string, *gitalypb.Repository) {
repo, _ := gittest.CreateRepository(t, ctx, repoCfg)
return []string{
"--repository=" + repo.RelativePath,
"--config=" + configPath,
}, repo
},
hooks: &bytes.Buffer{},
expectedErr: "multiple storages configured: use --storage to target storage explicitly",
},
{
desc: "storage not found",
setup: func() ([]string, *gitalypb.Repository) {
repo, _ := gittest.CreateRepository(t, ctx, repoCfg)
return []string{
"--storage=non-existent",
"--repository=" + repo.RelativePath,
"--config=" + configPath,
}, repo
},
hooks: testhelper.MustCreateCustomHooksTar(t),
expectedErr: storage.NewStorageNotFoundError("non-existent").Error(),
},
{
desc: "repository not found",
setup: func() ([]string, *gitalypb.Repository) {
repo, _ := gittest.CreateRepository(t, ctx, repoCfg)
return []string{
"--storage=" + repo.StorageName,
"--repository=non-existent",
"--config=" + configPath,
}, repo
},
hooks: testhelper.MustCreateCustomHooksTar(t),
expectedErr: storage.NewRepositoryNotFoundError(cfg.Storages[0].Name, "non-existent").Error(),
},
{
desc: "successfully set with empty hooks",
setup: func() ([]string, *gitalypb.Repository) {
repo, _ := gittest.CreateRepository(t, ctx, repoCfg)
return []string{
"--storage=" + repo.StorageName,
"--repository=" + repo.RelativePath,
"--config=" + configPath,
}, repo
},
hooks: &bytes.Buffer{},
expectedState: testhelper.DirectoryState{
"custom_hooks/": {Mode: umask.Mask(fs.ModePerm)},
},
},
{
desc: "successfully set with hooks",
setup: func() ([]string, *gitalypb.Repository) {
repo, _ := gittest.CreateRepository(t, ctx, repoCfg)
return []string{
"--storage=" + repo.StorageName,
"--repository=" + repo.RelativePath,
"--config=" + configPath,
}, repo
},
hooks: testhelper.MustCreateCustomHooksTar(t),
expectedState: testhelper.DirectoryState{
"custom_hooks/": {Mode: umask.Mask(fs.ModePerm)},
"custom_hooks/pre-commit": {Mode: umask.Mask(fs.ModePerm), Content: []byte("pre-commit content")},
"custom_hooks/pre-push": {Mode: umask.Mask(fs.ModePerm), Content: []byte("pre-push content")},
"custom_hooks/pre-receive": {Mode: umask.Mask(fs.ModePerm), Content: []byte("pre-receive content")},
},
},
{
desc: "successfully set with hooks using default storage",
setup: func() ([]string, *gitalypb.Repository) {
// The default storage can only be determined if there is a single storage in the
// config. This test creates a config with only a single storage to verify a default
// storage value is being used.
singleStorageCfg := cfg
singleStorageCfg.Storages = singleStorageCfg.Storages[:1]
singleStorageCfgPath := testcfg.WriteTemporaryGitalyConfigFile(t, singleStorageCfg)
repo, _ := gittest.CreateRepository(t, ctx, repoCfg)
return []string{
"--repository=" + repo.RelativePath,
"--config=" + singleStorageCfgPath,
}, repo
},
hooks: testhelper.MustCreateCustomHooksTar(t),
expectedState: testhelper.DirectoryState{
"custom_hooks/": {Mode: umask.Mask(fs.ModePerm)},
"custom_hooks/pre-commit": {Mode: umask.Mask(fs.ModePerm), Content: []byte("pre-commit content")},
"custom_hooks/pre-push": {Mode: umask.Mask(fs.ModePerm), Content: []byte("pre-push content")},
"custom_hooks/pre-receive": {Mode: umask.Mask(fs.ModePerm), Content: []byte("pre-receive content")},
},
},
} {
tc := tc
t.Run(tc.desc, func(t *testing.T) {
t.Parallel()
flags, repo := tc.setup()
args := append([]string{"hooks", "set"}, flags...)
cmd := exec.Command(cfg.BinaryPath("gitaly"), args...)
var stderr bytes.Buffer
cmd.Stdin = tc.hooks
cmd.Stderr = &stderr
err := cmd.Run()
if tc.expectedErr != "" {
require.Error(t, err)
require.Contains(t, stderr.String(), tc.expectedErr)
require.False(t, cmd.ProcessState.Success())
} else {
require.Empty(t, stderr.String())
require.NoError(t, err)
require.True(t, cmd.ProcessState.Success())
}
stream, err := client.GetCustomHooks(ctx, &gitalypb.GetCustomHooksRequest{
Repository: &gitalypb.Repository{
StorageName: repo.StorageName,
RelativePath: repo.RelativePath,
},
})
require.NoError(t, err)
hooksReader := streamio.NewReader(func() ([]byte, error) {
response, err := stream.Recv()
return response.GetData(), err
})
testhelper.RequireTarState(t, hooksReader, tc.expectedState)
})
}
}
func newRepositoryClient(tb testing.TB, ctx context.Context, cfg config.Cfg, serverSocketPath string) gitalypb.RepositoryServiceClient {
tb.Helper()
connOpts := []grpc.DialOption{
client.UnaryInterceptor(), client.StreamInterceptor(),
}
if cfg.Auth.Token != "" {
connOpts = append(connOpts, grpc.WithPerRPCCredentials(gitalyauth.RPCCredentialsV2(cfg.Auth.Token)))
}
conn, err := client.Dial(ctx, serverSocketPath, client.WithGrpcOptions(connOpts))
require.NoError(tb, err)
tb.Cleanup(func() { require.NoError(tb, conn.Close()) })
return gitalypb.NewRepositoryServiceClient(conn)
}
|
