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
|
# coding: utf-8
require 'spec_helper'
require 'gitlab_custom_hook'
describe GitlabCustomHook do
let(:original_root_path) { ROOT_PATH }
let(:tmp_repo_path) { File.join(original_root_path, 'tmp', 'repo.git') }
let(:tmp_root_path) { File.join(original_root_path, 'tmp') }
let(:global_custom_hooks_path) { global_hook_path('custom_global_hooks') }
let(:hook_ok) { File.join(original_root_path, 'spec', 'support', 'hook_ok') }
let(:hook_fail) { File.join(original_root_path, 'spec', 'support', 'hook_fail') }
let(:hook_gl_id) { File.join(original_root_path, 'spec', 'support', 'gl_id_test_hook') }
let(:vars) { { "GL_ID" => "key_1" } }
let(:old_value) { "old-value" }
let(:new_value) { "new-value" }
let(:ref_name) { "name/of/ref" }
let(:changes) { "#{old_value} #{new_value} #{ref_name}\n" }
let(:gitlab_custom_hook) { GitlabCustomHook.new(tmp_repo_path, 'key_1') }
def hook_path(path)
File.join(tmp_repo_path, path.split('/'))
end
def global_hook_path(path)
File.join(tmp_root_path, path.split('/'))
end
def create_hook(path, which)
FileUtils.ln_sf(which, hook_path(path))
end
# global hooks multiplexed
def create_global_hooks_d(which, hook_name = 'hook')
create_hook('hooks/pre-receive.d/' + hook_name, which)
create_hook('hooks/update.d/' + hook_name, which)
create_hook('hooks/post-receive.d/' + hook_name, which)
end
# repo hooks
def create_repo_hooks(which)
create_hook('custom_hooks/pre-receive', which)
create_hook('custom_hooks/update', which)
create_hook('custom_hooks/post-receive', which)
end
# repo hooks multiplexed
def create_repo_hooks_d(which, hook_name = 'hook')
create_hook('custom_hooks/pre-receive.d/' + hook_name, which)
create_hook('custom_hooks/update.d/' + hook_name, which)
create_hook('custom_hooks/post-receive.d/' + hook_name, which)
end
def cleanup_hook_setup
FileUtils.rm_rf(File.join(tmp_repo_path))
FileUtils.rm_rf(File.join(global_custom_hooks_path))
FileUtils.rm_rf(File.join(tmp_root_path, 'hooks'))
FileUtils.rm_f(File.join(tmp_root_path, 'config.yml'))
end
def expect_call_receive_hook(path)
expect(gitlab_custom_hook)
.to receive(:call_receive_hook)
.with(hook_path(path), changes)
.and_call_original
end
def expect_call_update_hook(path)
expect(gitlab_custom_hook)
.to receive(:system)
.with(vars, hook_path(path), ref_name, old_value, new_value)
.and_call_original
end
# setup paths
# <repository>.git/hooks/ - symlink to gitlab-shell/hooks global dir
# <repository>.git/hooks/<hook_name> - executed by git itself, this is gitlab-shell/hooks/<hook_name>
# <repository>.git/hooks/<hook_name>.d/* - global hooks: all executable files (minus editor backup files)
# <repository>.git/custom_hooks/<hook_name> - per project hook (this is already existing behavior)
# <repository>.git/custom_hooks/<hook_name>.d/* - per project hooks
#
# custom hooks are invoked in such way that first failure prevents other scripts being ran
# as global scripts are ran first, failing global skips repo hooks
before do
cleanup_hook_setup
FileUtils.mkdir_p(File.join(tmp_repo_path, 'custom_hooks'))
FileUtils.mkdir_p(File.join(tmp_root_path, 'hooks'))
['pre-receive', 'update', 'post-receive'].each do |hook|
FileUtils.mkdir_p(File.join(tmp_repo_path, 'custom_hooks', "#{hook}.d"))
FileUtils.mkdir_p(File.join(tmp_root_path, 'hooks', "#{hook}.d"))
end
FileUtils.symlink(File.join(tmp_root_path, 'hooks'), File.join(tmp_repo_path, 'hooks'))
FileUtils.symlink(File.join(ROOT_PATH, 'config.yml.example'), File.join(tmp_root_path, 'config.yml'))
stub_const('ROOT_PATH', tmp_root_path)
end
after do
cleanup_hook_setup
end
context 'with gl_id_test_hook as repo hook' do
before do
create_repo_hooks(hook_gl_id)
end
context 'pre_receive hook' do
it 'passes GL_ID variable to hook' do
expect(gitlab_custom_hook.pre_receive(changes)).to eq(true)
end
end
context 'post_receive hook' do
it 'passes GL_ID variable to hook' do
expect(gitlab_custom_hook.post_receive(changes)).to eq(true)
end
end
context 'update hook' do
it 'passes GL_ID variable to hook' do
expect(gitlab_custom_hook.update(ref_name, old_value, new_value)).to eq(true)
end
end
end
context 'with gl_id_test_hook as global hook' do
before do
create_global_hooks_d(hook_gl_id)
end
context 'pre_receive hook' do
it 'passes GL_ID variable to hook' do
expect(gitlab_custom_hook.pre_receive(changes)).to eq(true)
end
end
context 'post_receive hook' do
it 'passes GL_ID variable to hook' do
expect(gitlab_custom_hook.post_receive(changes)).to eq(true)
end
end
context 'update hook' do
it 'passes GL_ID variable to hook' do
expect(gitlab_custom_hook.update(ref_name, old_value, new_value)).to eq(true)
end
end
end
context "having no hooks" do
it "returns true" do
expect(gitlab_custom_hook.pre_receive(changes)).to eq(true)
expect(gitlab_custom_hook.update(ref_name, old_value, new_value)).to eq(true)
expect(gitlab_custom_hook.post_receive(changes)).to eq(true)
end
end
context "having only successful repo hooks" do
before do
create_repo_hooks(hook_ok)
end
it "returns true" do
expect(gitlab_custom_hook.pre_receive(changes)).to eq(true)
expect(gitlab_custom_hook.update(ref_name, old_value, new_value)).to eq(true)
expect(gitlab_custom_hook.post_receive(changes)).to eq(true)
end
end
context "having both successful repo and global hooks" do
before do
create_repo_hooks(hook_ok)
create_global_hooks_d(hook_ok)
end
it "returns true" do
expect(gitlab_custom_hook.pre_receive(changes)).to eq(true)
expect(gitlab_custom_hook.update(ref_name, old_value, new_value)).to eq(true)
expect(gitlab_custom_hook.post_receive(changes)).to eq(true)
end
end
context "having failing repo and successful global hooks" do
before do
create_repo_hooks_d(hook_fail)
create_global_hooks_d(hook_ok)
end
it "returns false" do
expect(gitlab_custom_hook.pre_receive(changes)).to eq(false)
expect(gitlab_custom_hook.update(ref_name, old_value, new_value)).to eq(false)
expect(gitlab_custom_hook.post_receive(changes)).to eq(false)
end
it "only executes the global hook" do
expect_call_receive_hook("custom_hooks/pre-receive.d/hook")
expect_call_update_hook("custom_hooks/update.d/hook")
expect_call_receive_hook("custom_hooks/post-receive.d/hook")
gitlab_custom_hook.pre_receive(changes)
gitlab_custom_hook.update(ref_name, old_value, new_value)
gitlab_custom_hook.post_receive(changes)
end
end
context "having successful repo but failing global hooks" do
before do
create_repo_hooks_d(hook_ok)
create_global_hooks_d(hook_fail)
end
it "returns false" do
expect(gitlab_custom_hook.pre_receive(changes)).to eq(false)
expect(gitlab_custom_hook.update(ref_name, old_value, new_value)).to eq(false)
expect(gitlab_custom_hook.post_receive(changes)).to eq(false)
end
it "executes the relevant hooks" do
expect_call_receive_hook("hooks/pre-receive.d/hook")
expect_call_receive_hook("custom_hooks/pre-receive.d/hook")
expect_call_update_hook("hooks/update.d/hook")
expect_call_update_hook("custom_hooks/update.d/hook")
expect_call_receive_hook("hooks/post-receive.d/hook")
expect_call_receive_hook("custom_hooks/post-receive.d/hook")
gitlab_custom_hook.pre_receive(changes)
gitlab_custom_hook.update(ref_name, old_value, new_value)
gitlab_custom_hook.post_receive(changes)
end
end
context "executing hooks in expected order" do
before do
create_repo_hooks_d(hook_ok, '01-test')
create_repo_hooks_d(hook_ok, '02-test')
create_global_hooks_d(hook_ok, '03-test')
create_global_hooks_d(hook_ok, '04-test')
end
it "executes hooks in order" do
expect_call_receive_hook("custom_hooks/pre-receive.d/01-test").ordered
expect_call_receive_hook("custom_hooks/pre-receive.d/02-test").ordered
expect_call_receive_hook("hooks/pre-receive.d/03-test").ordered
expect_call_receive_hook("hooks/pre-receive.d/04-test").ordered
expect_call_update_hook("custom_hooks/update.d/01-test").ordered
expect_call_update_hook("custom_hooks/update.d/02-test").ordered
expect_call_update_hook("hooks/update.d/03-test").ordered
expect_call_update_hook("hooks/update.d/04-test").ordered
expect_call_receive_hook("custom_hooks/post-receive.d/01-test").ordered
expect_call_receive_hook("custom_hooks/post-receive.d/02-test").ordered
expect_call_receive_hook("hooks/post-receive.d/03-test").ordered
expect_call_receive_hook("hooks/post-receive.d/04-test").ordered
gitlab_custom_hook.pre_receive(changes)
gitlab_custom_hook.update(ref_name, old_value, new_value)
gitlab_custom_hook.post_receive(changes)
end
end
context "when the custom_hooks_dir config option is set" do
before do
allow(gitlab_custom_hook.config).to receive(:custom_hooks_dir).and_return(global_custom_hooks_path)
FileUtils.mkdir_p(File.join(global_custom_hooks_path, "pre-receive.d"))
FileUtils.ln_sf(hook_ok, File.join(global_custom_hooks_path, "pre-receive.d", "hook"))
create_global_hooks_d(hook_fail)
end
it "finds hooks in that directory" do
expect(gitlab_custom_hook)
.to receive(:call_receive_hook)
.with(global_hook_path("custom_global_hooks/pre-receive.d/hook"), changes)
.and_call_original
expect(gitlab_custom_hook.pre_receive(changes)).to eq(true)
end
it "does not execute hooks in the default location" do
expect(gitlab_custom_hook)
.not_to receive(:call_receive_hook)
.with("hooks/pre-receive.d/hook", changes)
.and_call_original
gitlab_custom_hook.pre_receive(changes)
end
end
end
|
