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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Ci::Config::External::Mapper::Verifier, feature_category: :pipeline_composition do
include RepoHelpers
include StubRequests
let_it_be(:project) { create(:project, :repository) }
let_it_be(:user) { project.owner }
let(:context) do
Gitlab::Ci::Config::External::Context.new(project: project, user: user, sha: project.commit.id)
end
let(:remote_url) { 'https://gitlab.com/gitlab-org/gitlab-foss/blob/1234/.gitlab-ci-1.yml' }
let(:project_files) do
{
'myfolder/file1.yml' => <<~YAML,
my_build:
script: echo Hello World
YAML
'myfolder/file2.yml' => <<~YAML,
my_test:
script: echo Hello World
YAML
'myfolder/file3.yml' => <<~YAML,
my_deploy:
script: echo Hello World
YAML
'nested_configs.yml' => <<~YAML
include:
- local: myfolder/file1.yml
- local: myfolder/file2.yml
- remote: #{remote_url}
YAML
}
end
around(:all) do |example|
create_and_delete_files(project, project_files) do
example.run
end
end
before do
stub_full_request(remote_url).to_return(
body: <<~YAML
remote_test:
script: echo Hello World
YAML
)
end
subject(:verifier) { described_class.new(context) }
describe '#process' do
subject(:process) { verifier.process(files) }
context 'when files are local' do
let(:files) do
[
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file1.yml' }, context),
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file2.yml' }, context),
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file3.yml' }, context)
]
end
it 'returns an array of file objects' do
expect(process.map(&:location)).to contain_exactly(
'myfolder/file1.yml', 'myfolder/file2.yml', 'myfolder/file3.yml'
)
end
it 'adds files to the expandset' do
expect { process }.to change { context.expandset.count }.by(3)
end
it 'calls Gitaly only once for all files', :request_store do
# 1 for project.commit.id, 1 for the files
expect { process }.to change { Gitlab::GitalyClient.get_request_count }.by(2)
end
end
context 'when files are project files' do
let_it_be(:included_project1) { create(:project, :repository, namespace: project.namespace, creator: user) }
let_it_be(:included_project2) { create(:project, :repository, namespace: project.namespace, creator: user) }
let(:files) do
[
Gitlab::Ci::Config::External::File::Project.new(
{ file: 'myfolder/file1.yml', project: included_project1.full_path }, context
),
Gitlab::Ci::Config::External::File::Project.new(
{ file: 'myfolder/file2.yml', project: included_project1.full_path }, context
),
Gitlab::Ci::Config::External::File::Project.new(
{ file: 'myfolder/file3.yml', project: included_project1.full_path, ref: 'master' }, context
),
Gitlab::Ci::Config::External::File::Project.new(
{ file: 'myfolder/file1.yml', project: included_project2.full_path }, context
),
Gitlab::Ci::Config::External::File::Project.new(
{ file: 'myfolder/file2.yml', project: included_project2.full_path }, context
)
]
end
around(:all) do |example|
create_and_delete_files(included_project1, project_files) do
create_and_delete_files(included_project2, project_files) do
example.run
end
end
end
it 'returns an array of file objects' do
expect(process.map(&:location)).to contain_exactly(
'myfolder/file1.yml', 'myfolder/file2.yml', 'myfolder/file3.yml', 'myfolder/file1.yml', 'myfolder/file2.yml'
)
end
it 'adds files to the expandset' do
expect { process }.to change { context.expandset.count }.by(5)
end
it 'calls Gitaly only once for all files', :request_store do
files # calling this to load project creations and the `project.commit.id` call
# 3 for the sha check, 2 for the files in batch
expect { process }.to change { Gitlab::GitalyClient.get_request_count }.by(5)
end
it 'queries with batch', :use_sql_query_cache do
files # calling this to load project creations and the `project.commit.id` call
queries = ActiveRecord::QueryRecorder.new(skip_cached: false) { process }
projects_queries = queries.occurrences_starting_with('SELECT "projects"')
access_check_queries = queries.occurrences_starting_with('SELECT MAX("project_authorizations"."access_level")')
expect(projects_queries.values.sum).to eq(1)
expect(access_check_queries.values.sum).to eq(2)
end
context 'when the FF ci_batch_project_includes_context is disabled' do
before do
stub_feature_flags(ci_batch_project_includes_context: false)
end
it 'returns an array of file objects' do
expect(process.map(&:location)).to contain_exactly(
'myfolder/file1.yml', 'myfolder/file2.yml', 'myfolder/file3.yml',
'myfolder/file1.yml', 'myfolder/file2.yml'
)
end
it 'adds files to the expandset' do
expect { process }.to change { context.expandset.count }.by(5)
end
it 'calls Gitaly for all files', :request_store do
files # calling this to load project creations and the `project.commit.id` call
# 5 for the sha check, 2 for the files in batch
expect { process }.to change { Gitlab::GitalyClient.get_request_count }.by(7)
end
it 'queries without batch', :use_sql_query_cache do
files # calling this to load project creations and the `project.commit.id` call
queries = ActiveRecord::QueryRecorder.new(skip_cached: false) { process }
projects_queries = queries.occurrences_starting_with('SELECT "projects"')
access_check_queries = queries.occurrences_starting_with(
'SELECT MAX("project_authorizations"."access_level")'
)
expect(projects_queries.values.sum).to eq(5)
expect(access_check_queries.values.sum).to eq(5)
end
end
end
context 'when a file includes other files' do
let(:files) do
[
Gitlab::Ci::Config::External::File::Local.new({ local: 'nested_configs.yml' }, context)
]
end
it 'returns an array of file objects with combined hash' do
expect(process.map(&:to_hash)).to contain_exactly(
{ my_build: { script: 'echo Hello World' },
my_test: { script: 'echo Hello World' },
remote_test: { script: 'echo Hello World' } }
)
end
end
context 'when there is an invalid file' do
let(:files) do
[
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/invalid.yml' }, context)
]
end
it 'adds an error to the file' do
expect(process.first.errors).to include("Local file `myfolder/invalid.yml` does not exist!")
end
end
describe 'max includes detection' do
shared_examples 'verifies max includes' do
context 'when total file count is equal to max_includes' do
before do
allow(context).to receive(:max_includes).and_return(expected_total_file_count)
end
it 'adds the expected number of files to expandset' do
expect { process }.not_to raise_error
expect(context.expandset.count).to eq(expected_total_file_count)
end
end
context 'when total file count exceeds max_includes' do
before do
allow(context).to receive(:max_includes).and_return(expected_total_file_count - 1)
end
it 'raises error' do
expect { process }.to raise_error(expected_error_class)
end
end
end
context 'when files are nested' do
let(:files) do
[
Gitlab::Ci::Config::External::File::Local.new({ local: 'nested_configs.yml' }, context)
]
end
let(:expected_total_file_count) { 4 } # Includes nested_configs.yml + 3 nested files
let(:expected_error_class) { Gitlab::Ci::Config::External::Processor::IncludeError }
it_behaves_like 'verifies max includes'
context 'when duplicate files are included' do
let(:expected_total_file_count) { 8 } # 2 x (Includes nested_configs.yml + 3 nested files)
let(:files) do
[
Gitlab::Ci::Config::External::File::Local.new({ local: 'nested_configs.yml' }, context),
Gitlab::Ci::Config::External::File::Local.new({ local: 'nested_configs.yml' }, context)
]
end
it_behaves_like 'verifies max includes'
end
end
context 'when files are not nested' do
let(:files) do
[
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file1.yml' }, context),
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file2.yml' }, context)
]
end
let(:expected_total_file_count) { files.count }
let(:expected_error_class) { Gitlab::Ci::Config::External::Mapper::TooManyIncludesError }
it_behaves_like 'verifies max includes'
context 'when duplicate files are included' do
let(:files) do
[
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file1.yml' }, context),
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file2.yml' }, context),
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file2.yml' }, context)
]
end
let(:expected_total_file_count) { files.count }
it_behaves_like 'verifies max includes'
end
end
context 'when there is a circular include' do
let(:project_files) do
{
'myfolder/file1.yml' => <<~YAML
include: myfolder/file1.yml
YAML
}
end
let(:files) do
[
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file1.yml' }, context)
]
end
before do
allow(context).to receive(:max_includes).and_return(10)
end
it 'raises error' do
expect { process }.to raise_error(Gitlab::Ci::Config::External::Processor::IncludeError)
end
end
context 'when a file is an internal include' do
let(:project_files) do
{
'myfolder/file1.yml' => <<~YAML,
my_build:
script: echo Hello World
YAML
'.internal-include.yml' => <<~YAML
include:
- local: myfolder/file1.yml
YAML
}
end
let(:files) do
[
Gitlab::Ci::Config::External::File::Local.new({ local: '.internal-include.yml' }, context)
]
end
let(:total_file_count) { 2 } # Includes .internal-include.yml + myfolder/file1.yml
let(:pipeline_config) { instance_double(Gitlab::Ci::ProjectConfig) }
let(:context) do
Gitlab::Ci::Config::External::Context.new(
project: project,
user: user,
sha: project.commit.id,
pipeline_config: pipeline_config
)
end
before do
allow(pipeline_config).to receive(:internal_include_prepended?).and_return(true)
allow(context).to receive(:max_includes).and_return(1)
end
context 'when total file count excluding internal include is equal to max_includes' do
it 'does not add the internal include to expandset' do
expect { process }.not_to raise_error
expect(context.expandset.count).to eq(total_file_count - 1)
expect(context.expandset.first.location).to eq('myfolder/file1.yml')
end
end
context 'when total file count excluding internal include exceeds max_includes' do
let(:project_files) do
{
'myfolder/file1.yml' => <<~YAML,
my_build:
script: echo Hello World
YAML
'.internal-include.yml' => <<~YAML
include:
- local: myfolder/file1.yml
- local: myfolder/file1.yml
YAML
}
end
it 'raises error' do
expect { process }.to raise_error(Gitlab::Ci::Config::External::Processor::IncludeError)
end
end
end
end
context 'when FF ci_fix_max_includes is disabled' do
before do
stub_feature_flags(ci_fix_max_includes: false)
end
context 'when total file count exceeds max_includes' do
context 'when files are nested' do
let(:files) do
[
Gitlab::Ci::Config::External::File::Local.new({ local: 'nested_configs.yml' }, context)
]
end
it 'raises Processor::IncludeError' do
allow(context).to receive(:max_includes).and_return(1)
expect { process }.to raise_error(Gitlab::Ci::Config::External::Processor::IncludeError)
end
end
context 'when files are not nested' do
let(:files) do
[
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file1.yml' }, context),
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file2.yml' }, context)
]
end
it 'raises Mapper::TooManyIncludesError' do
allow(context).to receive(:max_includes).and_return(1)
expect { process }.to raise_error(Gitlab::Ci::Config::External::Mapper::TooManyIncludesError)
end
end
context 'when files are duplicates' do
let(:files) do
[
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file1.yml' }, context),
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file1.yml' }, context),
Gitlab::Ci::Config::External::File::Local.new({ local: 'myfolder/file1.yml' }, context)
]
end
it 'raises error' do
allow(context).to receive(:max_includes).and_return(2)
expect { process }.to raise_error(Gitlab::Ci::Config::External::Mapper::TooManyIncludesError)
end
end
end
end
end
end
|