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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe ContainerRegistry::GitlabApiClient, feature_category: :container_registry do
using RSpec::Parameterized::TableSyntax
include_context 'container registry client'
include_context 'container registry client stubs'
let(:path) { 'namespace/path/to/repository' }
let(:import_token) { 'import_token' }
let(:options) { { token: token, import_token: import_token } }
describe '#supports_gitlab_api?' do
subject { client.supports_gitlab_api? }
where(:registry_gitlab_api_enabled, :is_on_dot_com, :container_registry_features, :expect_registry_to_be_pinged, :expected_result) do
false | true | [described_class::REGISTRY_GITLAB_V1_API_FEATURE] | false | true
true | false | [described_class::REGISTRY_GITLAB_V1_API_FEATURE] | true | true
true | true | [] | true | true
true | false | [] | true | true
false | true | [described_class::REGISTRY_GITLAB_V1_API_FEATURE] | false | true
false | false | [described_class::REGISTRY_GITLAB_V1_API_FEATURE] | true | false
false | true | [] | true | false
false | false | [] | true | false
end
with_them do
before do
allow(::Gitlab).to receive(:com_except_jh?).and_return(is_on_dot_com)
stub_registry_gitlab_api_support(registry_gitlab_api_enabled)
stub_application_setting(container_registry_features: container_registry_features)
end
it 'returns the expected result' do
if expect_registry_to_be_pinged
expect(Faraday::Connection).to receive(:new).and_call_original
else
expect(Faraday::Connection).not_to receive(:new)
end
expect(subject).to be expected_result
end
end
context 'with 401 response' do
before do
allow(::Gitlab).to receive(:com_except_jh?).and_return(false)
stub_application_setting(container_registry_features: [])
stub_request(:get, "#{registry_api_url}/gitlab/v1/")
.to_return(status: 401, body: '')
end
it { is_expected.to be_truthy }
end
end
describe '#pre_import_repository' do
subject { client.pre_import_repository(path) }
where(:status_code, :expected_result) do
200 | :already_imported
202 | :ok
400 | :bad_request
401 | :unauthorized
404 | :not_found
409 | :already_being_imported
418 | :error
424 | :pre_import_failed
425 | :already_being_imported
429 | :too_many_imports
end
with_them do
before do
stub_pre_import(path, status_code, pre: true)
end
it { is_expected.to eq(expected_result) }
end
end
describe '#import_repository' do
subject { client.import_repository(path) }
where(:status_code, :expected_result) do
200 | :already_imported
202 | :ok
400 | :bad_request
401 | :unauthorized
404 | :not_found
409 | :already_being_imported
418 | :error
424 | :pre_import_failed
425 | :already_being_imported
429 | :too_many_imports
end
with_them do
before do
stub_pre_import(path, status_code, pre: false)
end
it { is_expected.to eq(expected_result) }
end
end
describe '#cancel_repository_import' do
let(:force) { false }
subject { client.cancel_repository_import(path, force: force) }
where(:status_code, :expected_result) do
200 | :already_imported
202 | :ok
400 | :bad_request
401 | :unauthorized
404 | :not_found
409 | :already_being_imported
418 | :error
424 | :pre_import_failed
425 | :already_being_imported
429 | :too_many_imports
end
with_them do
before do
stub_import_cancel(path, status_code, force: force)
end
it { is_expected.to eq({ status: expected_result, migration_state: nil }) }
end
context 'bad request' do
let(:status) { 'this_is_a_test' }
before do
stub_import_cancel(path, 400, status: status, force: force)
end
it { is_expected.to eq({ status: :bad_request, migration_state: status }) }
end
context 'force cancel' do
let(:force) { true }
before do
stub_import_cancel(path, 202, force: force)
end
it { is_expected.to eq({ status: :ok, migration_state: nil }) }
end
end
describe '#import_status' do
subject { client.import_status(path) }
context 'with successful response' do
before do
stub_import_status(path, status)
end
context 'with a status' do
let(:status) { 'this_is_a_test' }
it { is_expected.to eq(status) }
end
context 'with no status' do
let(:status) { nil }
it { is_expected.to eq('error') }
end
end
context 'with non successful response' do
before do
stub_import_status(path, nil, status_code: 404)
end
it { is_expected.to eq('pre_import_failed') }
end
end
describe '#repository_details' do
let(:path) { 'namespace/path/to/repository' }
let(:response) { { foo: :bar, this: :is_a_test } }
subject { client.repository_details(path, sizing: sizing) }
[:self, :self_with_descendants, nil].each do |size_type|
context "with sizing #{size_type}" do
let(:sizing) { size_type }
before do
stub_repository_details(path, sizing: sizing, respond_with: response)
end
it { is_expected.to eq(response.stringify_keys.deep_transform_values(&:to_s)) }
end
end
context 'with non successful response' do
let(:sizing) { nil }
before do
stub_repository_details(path, sizing: sizing, status_code: 404)
end
it { is_expected.to eq({}) }
end
end
describe '#tags' do
let(:path) { 'namespace/path/to/repository' }
let(:page_size) { 100 }
let(:response) do
[
{
name: '0.1.0',
digest: 'sha256:1234567890',
media_type: 'application/vnd.oci.image.manifest.v1+json',
size_bytes: 1234567890,
created_at: 5.minutes.ago
},
{
name: 'latest',
digest: 'sha256:1234567892',
media_type: 'application/vnd.oci.image.manifest.v1+json',
size_bytes: 1234567892,
created_at: 10.minutes.ago
}
]
end
let(:previous_page_url) { 'http://sandbox.org/test?before=b' }
let(:next_page_url) { 'http://sandbox.org/test?last=b' }
subject { client.tags(path, page_size: page_size) }
context 'with valid parameters' do
let(:expected) do
{
pagination: {},
response_body: ::Gitlab::Json.parse(response.to_json)
}
end
before do
stub_tags(path, page_size: page_size, respond_with: response)
end
it { is_expected.to eq(expected) }
end
context 'with a response with a link header containing next page' do
let(:expected) do
{
pagination: { next: { uri: URI(next_page_url) } },
response_body: ::Gitlab::Json.parse(response.to_json)
}
end
before do
stub_tags(path, page_size: page_size, next_page_url: next_page_url, respond_with: response)
end
it { is_expected.to eq(expected) }
end
context 'with a response with a link header containing previous page' do
let(:expected) do
{
pagination: { previous: { uri: URI(previous_page_url) } },
response_body: ::Gitlab::Json.parse(response.to_json)
}
end
before do
stub_tags(path, page_size: page_size, previous_page_url: previous_page_url, respond_with: response)
end
it { is_expected.to eq(expected) }
end
context 'with a response with a link header containing previous and next pages' do
let(:expected) do
{
pagination: { previous: { uri: URI(previous_page_url) }, next: { uri: URI(next_page_url) } },
response_body: ::Gitlab::Json.parse(response.to_json)
}
end
before do
stub_tags(path, page_size: page_size, previous_page_url: previous_page_url, next_page_url: next_page_url, respond_with: response)
end
it { is_expected.to eq(expected) }
end
context 'with a large page size set' do
let(:page_size) { described_class::MAX_TAGS_PAGE_SIZE + 1000 }
let(:expected) do
{
pagination: {},
response_body: ::Gitlab::Json.parse(response.to_json)
}
end
before do
stub_tags(path, page_size: described_class::MAX_TAGS_PAGE_SIZE, respond_with: response)
end
it { is_expected.to eq(expected) }
end
context 'with pagination parameters set' do
subject do
client.tags(path, page_size: page_size, last: last, before: before, name: name, sort: sort)
end
where(:last, :before, :name, :sort, :input) do
'test' | nil | nil | nil | { last: 'test' }
nil | 'test' | nil | nil | { before: 'test' }
nil | nil | 'test' | nil | { name: 'test' }
nil | nil | nil | 'asc' | { sort: 'asc' }
'a' | 'b' | 'test' | 'desc' | { last: 'a', before: 'b', name: 'test', sort: 'desc' }
end
with_them do
let(:expected) do
{
pagination: {},
response_body: ::Gitlab::Json.parse(response.to_json)
}
end
before do
stub_tags(path, page_size: page_size, input: input, respond_with: response)
end
it { is_expected.to eq(expected) }
end
end
context 'with non successful response' do
before do
stub_tags(path, page_size: page_size, status_code: 404)
end
it 'logs an error and returns an empty hash' do
expect(Gitlab::ErrorTracking)
.to receive(:log_exception).with(
instance_of(described_class::UnsuccessfulResponseError),
class: described_class.name,
url: "/gitlab/v1/repositories/#{path}/tags/list/",
status_code: 404
)
expect(subject).to eq({})
end
end
end
describe '#sub_repositories_with_tag' do
let(:path) { 'namespace/path/to/repository' }
let(:page_size) { 100 }
let(:last) { nil }
let(:response) do
[
{
"name": "docker-alpine",
"path": "gitlab-org/build/cng/docker-alpine",
"created_at": "2022-06-07T12:11:13.633+00:00",
"updated_at": "2022-06-07T14:37:49.251+00:00"
},
{
"name": "git-base",
"path": "gitlab-org/build/cng/git-base",
"created_at": "2022-06-07T12:11:13.633+00:00",
"updated_at": "2022-06-07T14:37:49.251+00:00"
}
]
end
let(:result_with_no_pagination) do
{
pagination: {},
response_body: ::Gitlab::Json.parse(response.to_json)
}
end
subject { client.sub_repositories_with_tag(path, page_size: page_size, last: last) }
context 'with valid parameters' do
before do
stub_sub_repositories_with_tag(path, page_size: page_size, respond_with: response)
end
it { is_expected.to eq(result_with_no_pagination) }
end
context 'with a response with a link header' do
let(:next_page_url) { 'http://sandbox.org/test?last=c' }
let(:expected) do
{
pagination: { next: { uri: URI(next_page_url) } },
response_body: ::Gitlab::Json.parse(response.to_json)
}
end
before do
stub_sub_repositories_with_tag(path, page_size: page_size, next_page_url: next_page_url, respond_with: response)
end
it { is_expected.to eq(expected) }
end
context 'with a large page size set' do
let(:page_size) { described_class::MAX_TAGS_PAGE_SIZE + 1000 }
before do
stub_sub_repositories_with_tag(path, page_size: described_class::MAX_TAGS_PAGE_SIZE, respond_with: response)
end
it { is_expected.to eq(result_with_no_pagination) }
end
context 'with a last parameter set' do
let(:last) { 'test' }
before do
stub_sub_repositories_with_tag(path, page_size: page_size, last: last, respond_with: response)
end
it { is_expected.to eq(result_with_no_pagination) }
end
context 'with non successful response' do
before do
stub_sub_repositories_with_tag(path, page_size: page_size, status_code: 404)
end
it 'logs an error and returns an empty hash' do
expect(Gitlab::ErrorTracking)
.to receive(:log_exception).with(
instance_of(described_class::UnsuccessfulResponseError),
class: described_class.name,
url: "/gitlab/v1/repository-paths/#{path}/repositories/list/",
status_code: 404
)
expect(subject).to eq({})
end
end
end
describe '#rename_base_repository_path' do
let(:path) { 'path/repository' }
let(:name) { 'newname' }
let(:dry_run) { 'false' }
let(:status_code) { 204 }
subject { client.rename_base_repository_path(path, name: name, dry_run: dry_run) }
before do
stub_rename_base_repository(path, name: name, dry_run: dry_run, status_code: status_code)
end
where(:dry_run, :status_code, :expected_result) do
true | 202 | :accepted
true | 400 | :bad_request
true | 401 | :unauthorized
true | 404 | :not_found
true | 409 | :name_taken
true | 422 | :too_many_subrepositories
false | 204 | :ok
false | 400 | :bad_request
false | 401 | :unauthorized
false | 404 | :not_found
false | 409 | :name_taken
false | 422 | :too_many_subrepositories
end
with_them do
it { is_expected.to eq(expected_result) }
end
context 'with a non-successful response' do
before do
stub_rename_base_repository(path, name: name, dry_run: false, status_code: 404)
end
it 'logs an error' do
expect(Gitlab::ErrorTracking)
.to receive(:log_exception).with(
instance_of(described_class::UnsuccessfulResponseError),
class: described_class.name,
url: "/gitlab/v1/repositories/#{path}/",
status_code: 404
)
subject
end
end
end
describe '.supports_gitlab_api?' do
subject { described_class.supports_gitlab_api? }
where(:registry_gitlab_api_enabled, :is_on_dot_com, :container_registry_features, :expect_registry_to_be_pinged, :expected_result) do
true | true | [described_class::REGISTRY_GITLAB_V1_API_FEATURE] | false | true
true | false | [described_class::REGISTRY_GITLAB_V1_API_FEATURE] | true | true
false | true | [described_class::REGISTRY_GITLAB_V1_API_FEATURE] | false | true
false | false | [described_class::REGISTRY_GITLAB_V1_API_FEATURE] | true | false
true | true | [] | true | true
true | false | [] | true | true
false | true | [] | true | false
false | false | [] | true | false
end
with_them do
before do
allow(::Gitlab).to receive(:com_except_jh?).and_return(is_on_dot_com)
stub_container_registry_config(enabled: true, api_url: registry_api_url, key: 'spec/fixtures/x509_certificate_pk.key')
stub_registry_gitlab_api_support(registry_gitlab_api_enabled)
stub_application_setting(container_registry_features: container_registry_features)
end
it 'returns the expected result' do
if expect_registry_to_be_pinged
expect(Faraday::Connection).to receive(:new).and_call_original
else
expect(Faraday::Connection).not_to receive(:new)
end
expect(subject).to be expected_result
end
end
context 'with the registry disabled' do
before do
stub_container_registry_config(enabled: false, api_url: 'http://sandbox.local', key: 'spec/fixtures/x509_certificate_pk.key')
end
it 'returns false' do
expect(Faraday::Connection).not_to receive(:new)
expect(subject).to be_falsey
end
end
context 'with a blank registry url' do
before do
stub_container_registry_config(enabled: true, api_url: '', key: 'spec/fixtures/x509_certificate_pk.key')
end
it 'returns false' do
expect(Faraday::Connection).not_to receive(:new)
expect(subject).to be_falsey
end
end
end
describe '.deduplicated_size' do
let(:path) { 'foo/bar' }
let(:response) { { 'size_bytes': 555 } }
let(:registry_enabled) { true }
subject { described_class.deduplicated_size(path) }
before do
stub_container_registry_config(enabled: registry_enabled, api_url: registry_api_url, key: 'spec/fixtures/x509_certificate_pk.key')
end
context 'with successful response' do
before do
expect(Auth::ContainerRegistryAuthenticationService).to receive(:pull_nested_repositories_access_token).with(path).and_return(token)
stub_repository_details(path, sizing: :self_with_descendants, status_code: 200, respond_with: response)
end
it { is_expected.to eq(555) }
end
context 'with unsuccessful response' do
before do
expect(Auth::ContainerRegistryAuthenticationService).to receive(:pull_nested_repositories_access_token).with(path).and_return(token)
stub_repository_details(path, sizing: :self_with_descendants, status_code: 404, respond_with: response)
end
it { is_expected.to eq(nil) }
end
context 'with the registry disabled' do
let(:registry_enabled) { false }
it { is_expected.to eq(nil) }
end
context 'with a nil path' do
let(:path) { nil }
let(:token) { nil }
before do
expect(Auth::ContainerRegistryAuthenticationService).not_to receive(:pull_nested_repositories_access_token)
stub_repository_details(path, sizing: :self_with_descendants, status_code: 401, respond_with: response)
end
it { is_expected.to eq(nil) }
end
context 'with uppercase path' do
let(:path) { 'foo/Bar' }
before do
expect(Auth::ContainerRegistryAuthenticationService).to receive(:pull_nested_repositories_access_token).with(path.downcase).and_return(token)
expect_next_instance_of(described_class) do |client|
expect(client).to receive(:repository_details).with(path.downcase, sizing: :self_with_descendants).and_return(response.with_indifferent_access).once
end
end
it { is_expected.to eq(555) }
end
end
describe '.one_project_with_container_registry_tag' do
let(:path) { 'build/cng/docker-alpine' }
let(:response_body) do
[
{
"name" => "docker-alpine",
"path" => path,
"created_at" => "2022-06-07T12:11:13.633+00:00",
"updated_at" => "2022-06-07T14:37:49.251+00:00"
}
]
end
let(:response) do
{
pagination: { next: { uri: URI('http://sandbox.org/test?last=x') } },
response_body: ::Gitlab::Json.parse(response_body.to_json)
}
end
let_it_be(:group) { create(:group, path: 'build') }
let_it_be(:project) { create(:project, path: 'cng', namespace: group) }
let_it_be(:container_repository) { create(:container_repository, project: project, name: "docker-alpine") }
shared_examples 'fetching the project from container repository and path' do
it 'fetches the project from the given path details' do
expect(ContainerRegistry::Path).to receive(:new).with(path).and_call_original
expect(ContainerRepository).to receive(:find_by_path).and_call_original
expect(subject).to eq(project)
end
it 'returns nil when path is invalid' do
registry_path = ContainerRegistry::Path.new('invalid')
expect(ContainerRegistry::Path).to receive(:new).with(path).and_return(registry_path)
expect(registry_path.valid?).to eq(false)
expect(subject).to eq(nil)
end
it 'returns nil when there is no container_repository matching the path' do
expect(ContainerRegistry::Path).to receive(:new).with(path).and_call_original
expect(ContainerRepository).to receive(:find_by_path).and_return(nil)
expect(subject).to eq(nil)
end
end
subject { described_class.one_project_with_container_registry_tag(path) }
before do
expect(Auth::ContainerRegistryAuthenticationService).to receive(:pull_nested_repositories_access_token).with(path.downcase).and_return(token)
stub_container_registry_config(enabled: true, api_url: registry_api_url, key: 'spec/fixtures/x509_certificate_pk.key')
end
context 'with successful response' do
before do
stub_sub_repositories_with_tag(path, page_size: 1, respond_with: response_body)
end
it_behaves_like 'fetching the project from container repository and path'
end
context 'with unsuccessful response' do
before do
stub_sub_repositories_with_tag(path, page_size: 1, status_code: 404, respond_with: {})
end
it { is_expected.to eq(nil) }
end
context 'with uppercase path' do
let(:path) { 'BuilD/CNG/docker-alpine' }
before do
expect_next_instance_of(described_class) do |client|
expect(client).to receive(:sub_repositories_with_tag).with(path.downcase, page_size: 1).and_return(response.with_indifferent_access).once
end
end
it_behaves_like 'fetching the project from container repository and path'
end
end
describe '.rename_base_repository_path' do
let(:name) { 'newname' }
let(:expected_dry_run) { true }
before do
stub_container_registry_config(enabled: true, api_url: registry_api_url, key: 'spec/fixtures/x509_certificate_pk.key')
expect_next_instance_of(described_class) do |client|
expect(client).to receive(:rename_base_repository_path).with(path.downcase, name: name.downcase, dry_run: expected_dry_run).and_return(:ok)
end
end
it 'passes on the parameters to #rename_base_repository_path' do
described_class.rename_base_repository_path(path, name: name, dry_run: true)
end
context 'when path and/or name have non-downcased letters' do
let(:path) { 'pAtH/to/PROject' }
let(:name) { 'nEwNamE' }
it 'passes the path and name downcased to #rename_base_repository_path' do
described_class.rename_base_repository_path(path, name: name, dry_run: true)
end
end
context 'when dry_run parameter is not given' do
let(:expected_dry_run) { false }
it 'defaults to false' do
described_class.rename_base_repository_path(path, name: 'newname')
end
end
end
describe '#each_sub_repositories_with_tag_page' do
let(:page_size) { 100 }
let(:project_path) { 'repo/project' }
shared_examples 'iterating through a page' do |expected_tags: true|
it 'iterates through one page' do
expect_next_instance_of(described_class) do |client|
expect(client).to receive(:sub_repositories_with_tag).with(project_path, page_size: page_size, last: nil).and_return(client_response)
end
expect { |b| described_class.each_sub_repositories_with_tag_page(path: project_path, page_size: page_size, &b) }
.to yield_with_args(expected_tags ? client_response_repositories : [])
end
end
context 'when no block is given' do
it 'raises an Argument error' do
expect do
described_class.each_sub_repositories_with_tag_page(path: project_path, page_size: page_size)
end.to raise_error(ArgumentError, 'block not given')
end
end
context 'when a block is given' do
before do
expect(Auth::ContainerRegistryAuthenticationService).to receive(:pull_nested_repositories_access_token).with(project_path).and_return(token)
stub_container_registry_config(enabled: true, api_url: registry_api_url, key: 'spec/fixtures/x509_certificate_pk.key')
end
context 'with an empty page' do
let(:client_response) { { pagination: {}, response_body: [] } }
it_behaves_like 'iterating through a page', expected_tags: false
end
context 'with one page' do
let(:client_response) { { pagination: {}, response_body: client_response_repositories } }
let(:client_response_repositories) do
[
{
"name": "docker-alpine",
"path": "gitlab-org/build/cng/docker-alpine",
"created_at": "2022-06-07T12:11:13.633+00:00",
"updated_at": "2022-06-07T14:37:49.251+00:00"
},
{
"name": "git-base",
"path": "gitlab-org/build/cng/git-base",
"created_at": "2022-06-07T12:11:13.633+00:00",
"updated_at": "2022-06-07T14:37:49.251+00:00"
}
]
end
it_behaves_like 'iterating through a page'
end
context 'with two pages' do
let(:client_response1) { { pagination: { next: { uri: URI('http://localhost/next?last=latest') } }, response_body: client_response_repositories1 } }
let(:client_response_repositories1) do
[
{
"name": "docker-alpine",
"path": "gitlab-org/build/cng/docker-alpine",
"created_at": "2022-06-07T12:11:13.633+00:00",
"updated_at": "2022-06-07T14:37:49.251+00:00"
},
{
"name": "git-base",
"path": "gitlab-org/build/cng/git-base",
"created_at": "2022-06-07T12:11:13.633+00:00",
"updated_at": "2022-06-07T14:37:49.251+00:00"
}
]
end
let(:client_response2) { { pagination: {}, response_body: client_response_repositories2 } }
let(:client_response_repositories2) do
[
{
"name": "docker-alpine1",
"path": "gitlab-org/build/cng/docker-alpine",
"created_at": "2022-06-07T12:11:13.633+00:00",
"updated_at": "2022-06-07T14:37:49.251+00:00"
},
{
"name": "git-base1",
"path": "gitlab-org/build/cng/git-base",
"created_at": "2022-06-07T12:11:13.633+00:00",
"updated_at": "2022-06-07T14:37:49.251+00:00"
}
]
end
it 'iterates through two pages' do
expect_next_instance_of(described_class) do |client|
expect(client).to receive(:sub_repositories_with_tag).with(project_path, page_size: page_size, last: nil).and_return(client_response1)
expect(client).to receive(:sub_repositories_with_tag).with(project_path, page_size: page_size, last: 'latest').and_return(client_response2)
end
expect { |b| described_class.each_sub_repositories_with_tag_page(path: project_path, page_size: page_size, &b) }
.to yield_successive_args(client_response_repositories1, client_response_repositories2)
end
end
context 'when max pages is reached' do
let(:client_response) { { pagination: {}, response_body: [] } }
before do
stub_const('ContainerRegistry::GitlabApiClient::MAX_REPOSITORIES_PAGE_SIZE', 0)
expect_next_instance_of(described_class) do |client|
expect(client).to receive(:sub_repositories_with_tag).with(project_path, page_size: page_size, last: nil).and_return(client_response)
end
end
it 'raises an error' do
expect { described_class.each_sub_repositories_with_tag_page(path: project_path, page_size: page_size) {} } # rubocop:disable Lint/EmptyBlock
.to raise_error(StandardError, 'too many pages requested')
end
end
context 'without a page size set' do
let(:client_response) { { pagination: {}, response_body: [] } }
it 'uses a default size' do
expect_next_instance_of(described_class) do |client|
expect(client).to receive(:sub_repositories_with_tag).with(project_path, page_size: page_size, last: nil).and_return(client_response)
end
expect { |b| described_class.each_sub_repositories_with_tag_page(path: project_path, &b) }.to yield_with_args([])
end
end
context 'with an empty client response' do
let(:client_response) { {} }
it 'breaks the loop' do
expect_next_instance_of(described_class) do |client|
expect(client).to receive(:sub_repositories_with_tag).with(project_path, page_size: page_size, last: nil).and_return(client_response)
end
expect { |b| described_class.each_sub_repositories_with_tag_page(path: project_path, page_size: page_size, &b) }.not_to yield_control
end
end
context 'with a nil page' do
let(:client_response) { { pagination: {}, response_body: nil } }
it_behaves_like 'iterating through a page', expected_tags: false
end
end
end
def stub_pre_import(path, status_code, pre:)
import_type = pre ? 'pre' : 'final'
stub_request(:put, "#{registry_api_url}/gitlab/v1/import/#{path}/?import_type=#{import_type}")
.with(headers: { 'Accept' => described_class::JSON_TYPE, 'Authorization' => "bearer #{import_token}" })
.to_return(status: status_code, body: '')
end
def stub_registry_gitlab_api_support(supported = true)
status_code = supported ? 200 : 404
stub_request(:get, "#{registry_api_url}/gitlab/v1/")
.with(headers: { 'Accept' => described_class::JSON_TYPE })
.to_return(status: status_code, body: '')
end
def stub_import_status(path, status, status_code: 200)
stub_request(:get, "#{registry_api_url}/gitlab/v1/import/#{path}/")
.with(headers: { 'Accept' => described_class::JSON_TYPE, 'Authorization' => "bearer #{import_token}" })
.to_return(
status: status_code,
body: { status: status }.to_json,
headers: { content_type: 'application/json' }
)
end
def stub_import_cancel(path, http_status, status: nil, force: false)
body = {}
if http_status == 400
body = { status: status }
end
headers = {
'Accept' => described_class::JSON_TYPE,
'Authorization' => "bearer #{import_token}",
'User-Agent' => "GitLab/#{Gitlab::VERSION}",
'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'
}
params = force ? '?force=true' : ''
stub_request(:delete, "#{registry_api_url}/gitlab/v1/import/#{path}/#{params}")
.with(headers: headers)
.to_return(
status: http_status,
body: body.to_json,
headers: { content_type: 'application/json' }
)
end
def stub_repository_details(path, sizing: nil, status_code: 200, respond_with: {})
url = "#{registry_api_url}/gitlab/v1/repositories/#{path}/"
url += "?size=#{sizing}" if sizing
stub_request(:get, url)
.with(headers: request_headers)
.to_return(status: status_code, body: respond_with.to_json, headers: headers_with_json_content_type)
end
def stub_tags(path, page_size: nil, input: {}, previous_page_url: nil, next_page_url: nil, status_code: 200, respond_with: {})
params = {
n: page_size,
last: input[:last],
name: input[:name],
sort: input[:sort],
before: input[:before]
}.compact
url = "#{registry_api_url}/gitlab/v1/repositories/#{path}/tags/list/"
if params.present?
url += "?#{params.map { |param, val| "#{param}=#{val}" }.join('&')}"
end
response_headers =
add_link_to_headers_from_urls(
headers_with_json_content_type,
previous_page_url,
next_page_url
)
stub_request(:get, url)
.with(headers: request_headers)
.to_return(
status: status_code,
body: respond_with.to_json,
headers: response_headers
)
end
def stub_sub_repositories_with_tag(path, page_size: nil, last: nil, next_page_url: nil, status_code: 200, respond_with: {})
params = { n: page_size, last: last }.compact
url = "#{registry_api_url}/gitlab/v1/repository-paths/#{path}/repositories/list/"
if params.present?
url += "?#{params.map { |param, val| "#{param}=#{val}" }.join('&')}"
end
response_headers =
add_link_to_headers_from_urls(headers_with_json_content_type, nil, next_page_url)
stub_request(:get, url)
.with(headers: request_headers)
.to_return(
status: status_code,
body: respond_with.to_json,
headers: response_headers
)
end
def stub_rename_base_repository(path, name:, dry_run: false, status_code: 204)
url = "#{registry_api_url}/gitlab/v1/repositories/#{path}/?dry_run=#{dry_run}"
stub_request(:patch, url)
.with(headers: request_headers, body: { name: name }.to_json)
.to_return(status: status_code, headers: headers_with_json_content_type)
end
def request_headers
headers = { 'Accept' => described_class::JSON_TYPE }
headers['Authorization'] = "bearer #{token}" if token
headers
end
def headers_with_json_content_type
{ 'Content-Type' => described_class::JSON_TYPE }
end
def add_link_to_headers_from_urls(headers, previous_page_url, next_page_url)
return headers unless previous_page_url || next_page_url
previous_page_url = %(<#{previous_page_url}>; rel="previous") if previous_page_url
next_page_url = %(<#{next_page_url}>; rel="next") if next_page_url
headers['Link'] = [previous_page_url, next_page_url].compact.join(" ,")
headers
end
end
|