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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::GitalyClient::RefService do
let_it_be(:project) { create(:project, :repository, create_tag: 'test') }
let(:storage_name) { project.repository_storage }
let(:relative_path) { project.disk_path + '.git' }
let(:repository) { project.repository }
let(:client) { described_class.new(repository) }
describe '#branches' do
it 'sends a find_all_branches message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_all_branches)
.with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash))
.and_return([])
client.branches
end
end
describe '#remote_branches' do
let(:remote_name) { 'my_remote' }
subject { client.remote_branches(remote_name) }
it 'sends a find_all_remote_branches message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_all_remote_branches)
.with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash))
.and_return([])
subject
end
it 'concatenates and returns the response branches as Gitlab::Git::Branch objects' do
target_commits = create_list(:gitaly_commit, 4)
response_branches = target_commits.each_with_index.map do |gitaly_commit, i|
Gitaly::Branch.new(name: "#{remote_name}/#{i}", target_commit: gitaly_commit)
end
response = [
Gitaly::FindAllRemoteBranchesResponse.new(branches: response_branches[0, 2]),
Gitaly::FindAllRemoteBranchesResponse.new(branches: response_branches[2, 2])
]
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_all_remote_branches).and_return(response)
expect(subject.length).to be(response_branches.length)
response_branches.each_with_index do |gitaly_branch, i|
branch = subject[i]
commit = Gitlab::Git::Commit.new(repository, gitaly_branch.target_commit)
expect(branch.name).to eq(i.to_s) # It removes the `remote/` prefix
expect(branch.dereferenced_target).to eq(commit)
end
end
end
describe '#merged_branches' do
it 'sends a find_all_branches message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_all_branches)
.with(gitaly_request_with_params(merged_only: true, merged_branches: ['test']), kind_of(Hash))
.and_return([])
client.merged_branches(%w(test))
end
end
describe '#branch_names' do
it 'sends a find_all_branch_names message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_all_branch_names)
.with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash))
.and_return([])
client.branch_names
end
end
describe '#tag_names' do
it 'sends a find_all_tag_names message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_all_tag_names)
.with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash))
.and_return([])
client.tag_names
end
end
describe '#find_branch' do
it 'sends a find_branch message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_branch)
.with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash))
.and_return(double(branch: Gitaly::Branch.new(name: 'name', target_commit: build(:gitaly_commit))))
client.find_branch('name')
end
context 'when Gitaly returns a ambiguios reference error' do
it 'raises an UnknownRef error' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_branch)
.and_raise(GRPC::BadStatus.new(2, 'reference is ambiguous'))
expect { client.find_branch('name') }.to raise_error(Gitlab::Git::AmbiguousRef, 'branch is ambiguous: name')
end
end
end
describe '#find_tag' do
it 'sends a find_tag message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_tag)
.with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash))
.and_return(double(tag: Gitaly::Tag.new))
client.find_tag('name')
end
context 'when tag is empty' do
it 'does not send a fing_tag message' do
expect_any_instance_of(Gitaly::RefService::Stub).not_to receive(:find_tag)
expect(client.find_tag('')).to be_nil
end
end
context 'when Gitaly returns an Internal error' do
it 'raises an Internal error' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_tag)
.and_raise(GRPC::Internal.new('something went wrong'))
expect { client.find_tag('v1.0.0') }.to raise_error(GRPC::Internal)
end
end
context 'when Gitaly returns a tag_not_found error' do
it 'raises an UnknownRef error' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_tag)
.and_raise(new_detailed_error(GRPC::Core::StatusCodes::NOT_FOUND,
"tag was not found",
Gitaly::FindTagError.new(tag_not_found: Gitaly::ReferenceNotFoundError.new)))
expect { client.find_tag('v1.0.0') }.to raise_error(Gitlab::Git::UnknownRef, 'tag does not exist: v1.0.0')
end
end
end
describe '#default_branch_name' do
it 'sends a find_default_branch_name message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_default_branch_name)
.with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash))
.and_return(double(name: 'foo'))
client.default_branch_name
end
end
describe '#local_branches' do
let(:remote_name) { 'my_remote' }
shared_examples 'common examples' do
it 'sends a find_local_branches message' do
target_commits = create_list(:gitaly_commit, 4)
branches = target_commits.each_with_index.map do |gitaly_commit, i|
Gitaly::FindLocalBranchResponse.new(
name: "#{remote_name}/#{i}",
commit: gitaly_commit,
commit_author: Gitaly::FindLocalBranchCommitAuthor.new(
name: gitaly_commit.author.name,
email: gitaly_commit.author.email,
date: gitaly_commit.author.date,
timezone: gitaly_commit.author.timezone
),
commit_committer: Gitaly::FindLocalBranchCommitAuthor.new(
name: gitaly_commit.committer.name,
email: gitaly_commit.committer.email,
date: gitaly_commit.committer.date,
timezone: gitaly_commit.committer.timezone
)
)
end
local_branches = target_commits.each_with_index.map do |gitaly_commit, i|
Gitaly::Branch.new(name: "#{remote_name}/#{i}", target_commit: gitaly_commit)
end
response = if set_local_branches
[
Gitaly::FindLocalBranchesResponse.new(local_branches: local_branches[0, 2]),
Gitaly::FindLocalBranchesResponse.new(local_branches: local_branches[2, 2])
]
else
[
Gitaly::FindLocalBranchesResponse.new(branches: branches[0, 2]),
Gitaly::FindLocalBranchesResponse.new(branches: branches[2, 2])
]
end
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_local_branches)
.with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash))
.and_return(response)
subject = client.local_branches
expect(subject.length).to be(target_commits.length)
end
it 'parses and sends the sort parameter' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_local_branches)
.with(gitaly_request_with_params(sort_by: :UPDATED_DESC), kind_of(Hash))
.and_return([])
client.local_branches(sort_by: 'updated_desc')
end
it 'translates known mismatches on sort param values' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_local_branches)
.with(gitaly_request_with_params(sort_by: :NAME), kind_of(Hash))
.and_return([])
client.local_branches(sort_by: 'name_asc')
end
it 'raises an argument error if an invalid sort_by parameter is passed' do
expect { client.local_branches(sort_by: 'invalid_sort') }.to raise_error(ArgumentError)
end
end
context 'when local_branches variable is not set' do
let(:set_local_branches) { false }
it_behaves_like 'common examples'
end
context 'when local_branches variable is set' do
let(:set_local_branches) { true }
it_behaves_like 'common examples'
end
end
describe '#tags' do
it 'sends a find_all_tags message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_all_tags)
.and_return([])
client.tags
end
context 'with sorting option' do
it 'sends a correct find_all_tags message' do
expected_sort_by = Gitaly::FindAllTagsRequest::SortBy.new(
key: :REFNAME,
direction: :ASCENDING
)
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_all_tags)
.with(gitaly_request_with_params(sort_by: expected_sort_by), kind_of(Hash))
.and_return([])
client.tags(sort_by: 'name_asc')
end
context 'with semantic version sorting' do
it 'sends a correct find_all_tags message' do
expected_sort_by = Gitaly::FindAllTagsRequest::SortBy.new(
key: :VERSION_REFNAME,
direction: :ASCENDING
)
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_all_tags)
.with(gitaly_request_with_params(sort_by: expected_sort_by), kind_of(Hash))
.and_return([])
client.tags(sort_by: 'version_asc')
end
end
end
context 'with pagination option' do
it 'sends a correct find_all_tags message' do
expected_pagination = Gitaly::PaginationParameter.new(
limit: 5,
page_token: 'refs/tags/v1.0.0'
)
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_all_tags)
.with(gitaly_request_with_params(pagination_params: expected_pagination), kind_of(Hash))
.and_return([])
client.tags(pagination_params: { limit: 5, page_token: 'refs/tags/v1.0.0' })
end
end
end
describe '#branch_names_contains_sha' do
it 'sends a list_branch_names_containing_commit message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:list_branch_names_containing_commit)
.with(gitaly_request_with_params(commit_id: '123', limit: 0), kind_of(Hash))
.and_return([])
client.branch_names_contains_sha('123')
end
end
describe '#get_tag_messages' do
it 'sends a get_tag_messages message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:get_tag_messages)
.with(gitaly_request_with_params(tag_ids: ['some_tag_id']), kind_of(Hash))
.and_return([])
client.get_tag_messages(['some_tag_id'])
end
end
describe '#get_tag_signatures' do
it 'sends a get_tag_signatures message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:get_tag_signatures)
.with(gitaly_request_with_params(tag_revisions: ['some_tag_id']), kind_of(Hash))
.and_return([])
client.get_tag_signatures(['some_tag_id'])
end
end
describe '#ref_exists?' do
let(:ref) { 'refs/heads/master' }
it 'sends a ref_exists message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:ref_exists)
.with(gitaly_request_with_params(ref: ref), kind_of(Hash))
.and_return(double('ref_exists_response', value: true))
expect(client.ref_exists?(ref)).to be true
end
end
describe '#delete_refs' do
let(:prefixes) { %w(refs/heads refs/keep-around) }
subject(:delete_refs) { client.delete_refs(except_with_prefixes: prefixes) }
it 'sends a delete_refs message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:delete_refs)
.with(gitaly_request_with_params(except_with_prefix: prefixes), kind_of(Hash))
.and_return(double('delete_refs_response', git_error: ""))
delete_refs
end
context 'with a references locked error' do
let(:references_locked_error) do
new_detailed_error(
GRPC::Core::StatusCodes::FAILED_PRECONDITION,
"error message",
Gitaly::DeleteRefsError.new(references_locked: Gitaly::ReferencesLockedError.new))
end
it 'raises ReferencesLockedError' do
expect_any_instance_of(Gitaly::RefService::Stub).to receive(:delete_refs)
.with(gitaly_request_with_params(except_with_prefix: prefixes), kind_of(Hash))
.and_raise(references_locked_error)
expect { delete_refs }.to raise_error(Gitlab::Git::ReferencesLockedError)
end
end
context 'with a invalid format error' do
let(:invalid_refs) { ['\invali.\d/1', '\.invali/d/2'] }
let(:invalid_reference_format_error) do
new_detailed_error(
GRPC::Core::StatusCodes::INVALID_ARGUMENT,
"error message",
Gitaly::DeleteRefsError.new(invalid_format: Gitaly::InvalidRefFormatError.new(refs: invalid_refs)))
end
it 'raises InvalidRefFormatError' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:delete_refs)
.with(gitaly_request_with_params(except_with_prefix: prefixes), kind_of(Hash))
.and_raise(invalid_reference_format_error)
expect { delete_refs }.to raise_error do |error|
expect(error).to be_a(Gitlab::Git::InvalidRefFormatError)
expect(error.message).to eq("references have an invalid format: #{invalid_refs.join(",")}")
end
end
end
end
describe '#list_refs' do
it 'sends a list_refs message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:list_refs)
.with(gitaly_request_with_params(patterns: ['refs/heads/']), kind_of(Hash))
.and_call_original
client.list_refs
end
it 'accepts a patterns argument' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:list_refs)
.with(gitaly_request_with_params(patterns: ['refs/tags/']), kind_of(Hash))
.and_call_original
client.list_refs([Gitlab::Git::TAG_REF_PREFIX])
end
end
describe '#pack_refs' do
it 'sends a pack_refs message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:pack_refs)
.with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash))
.and_return(double(:pack_refs_response))
client.pack_refs
end
end
describe '#find_refs_by_oid' do
let(:oid) { project.repository.commit.id }
it 'sends a find_refs_by_oid message' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_refs_by_oid)
.with(gitaly_request_with_params(sort_field: 'refname',
oid: oid,
limit: 1), kind_of(Hash))
.and_call_original
refs = client.find_refs_by_oid(oid: oid, limit: 1)
expect(refs.to_a).to eq([Gitlab::Git::BRANCH_REF_PREFIX + project.repository.root_ref])
end
it 'filters by ref_patterns' do
expect_any_instance_of(Gitaly::RefService::Stub)
.to receive(:find_refs_by_oid)
.with(gitaly_request_with_params(sort_field: 'refname',
oid: oid,
limit: 1,
ref_patterns: [Gitlab::Git::TAG_REF_PREFIX]), kind_of(Hash))
.and_call_original
refs = client.find_refs_by_oid(oid: oid, limit: 1, ref_patterns: [Gitlab::Git::TAG_REF_PREFIX])
expect(refs.to_a).to eq([Gitlab::Git::TAG_REF_PREFIX + 'test'])
end
end
end
|