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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe API::BulkImports, feature_category: :importers do
let_it_be(:user) { create(:user) }
let_it_be(:import_1) { create(:bulk_import, user: user) }
let_it_be(:import_2) { create(:bulk_import, user: user) }
let_it_be(:entity_1) { create(:bulk_import_entity, bulk_import: import_1) }
let_it_be(:entity_2) { create(:bulk_import_entity, bulk_import: import_1) }
let_it_be(:entity_3) { create(:bulk_import_entity, bulk_import: import_2) }
let_it_be(:failure_3) { create(:bulk_import_failure, entity: entity_3) }
before do
stub_application_setting(bulk_import_enabled: true)
allow(::Gitlab::ApplicationRateLimiter).to receive(:throttled?).and_return(false)
end
shared_examples 'disabled feature' do
before do
stub_application_setting(bulk_import_enabled: false)
stub_feature_flags(override_bulk_import_disabled: false)
end
it_behaves_like '404 response' do
let(:message) { '404 Not Found' }
end
it 'enables the feature when override flag is enabled for the user' do
stub_feature_flags(override_bulk_import_disabled: user)
request
expect(response).not_to have_gitlab_http_status(:not_found)
end
it 'does not enable the feature when override flag is enabled for another user' do
other_user = create(:user)
stub_feature_flags(override_bulk_import_disabled: other_user)
request
expect(response).to have_gitlab_http_status(:not_found)
end
end
describe 'GET /bulk_imports' do
let(:request) { get api('/bulk_imports', user), params: params }
let(:params) { {} }
it 'returns a list of bulk imports authored by the user' do
request
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.pluck('id')).to contain_exactly(import_1.id, import_2.id)
end
context 'sort parameter' do
it 'sorts by created_at descending by default' do
request
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.pluck('id')).to eq([import_2.id, import_1.id])
end
context 'when explicitly specified' do
context 'when descending' do
let(:params) { { sort: 'desc' } }
it 'sorts by created_at descending' do
request
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.pluck('id')).to match_array([import_2.id, import_1.id])
end
end
context 'when ascending' do
let(:params) { { sort: 'asc' } }
it 'sorts by created_at ascending when explicitly specified' do
request
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.pluck('id')).to match_array([import_1.id, import_2.id])
end
end
end
end
it_behaves_like 'disabled feature'
end
describe 'POST /bulk_imports' do
let_it_be(:destination_namespace) { create(:group) }
let(:request) { post api('/bulk_imports', user), params: params }
let(:destination_param) { { destination_slug: 'destination_slug' } }
let(:params) do
{
configuration: {
url: 'http://gitlab.example',
access_token: 'access_token'
},
entities: [
{
source_type: 'group_entity',
source_full_path: 'full_path',
destination_namespace: destination_namespace.path
}.merge(destination_param)
]
}
end
let(:source_entity_type) { BulkImports::CreateService::ENTITY_TYPES_MAPPING.fetch(params[:entities][0][:source_type]) }
let(:source_entity_identifier) { ERB::Util.url_encode(params[:entities][0][:source_full_path]) }
before do
allow_next_instance_of(BulkImports::Clients::HTTP) do |instance|
allow(instance)
.to receive(:instance_version)
.and_return(
Gitlab::VersionInfo.new(::BulkImport::MIN_MAJOR_VERSION, ::BulkImport::MIN_MINOR_VERSION_FOR_PROJECT))
allow(instance)
.to receive(:instance_enterprise)
.and_return(false)
end
stub_request(:get, "http://gitlab.example/api/v4/#{source_entity_type}/#{source_entity_identifier}/export_relations/status?page=1&per_page=30&private_token=access_token")
.to_return(status: 200, body: "", headers: {})
destination_namespace.add_owner(user)
end
shared_examples 'starting a new migration' do
it 'starts a new migration' do
request
expect(response).to have_gitlab_http_status(:created)
expect(json_response['status']).to eq('created')
end
describe 'migrate projects flag' do
context 'when true' do
it 'sets true' do
params[:entities][0][:migrate_projects] = true
request
expect(user.bulk_imports.last.entities.pluck(:migrate_projects)).to contain_exactly(true)
end
end
context 'when false' do
it 'sets false' do
params[:entities][0][:migrate_projects] = false
request
expect(user.bulk_imports.last.entities.pluck(:migrate_projects)).to contain_exactly(false)
end
end
context 'when unspecified' do
it 'sets true' do
request
expect(user.bulk_imports.last.entities.pluck(:migrate_projects)).to contain_exactly(true)
end
end
end
end
include_examples 'starting a new migration' do
let(:destination_param) { { destination_slug: 'destination_slug' } }
end
include_examples 'starting a new migration' do
let(:destination_param) { { destination_name: 'destination_name' } }
end
context 'when both destination_name & destination_slug are provided' do
let(:params) do
{
configuration: {
url: 'http://gitlab.example',
access_token: 'access_token'
},
entities: [
{
source_type: 'group_entity',
source_full_path: 'full_path',
destination_name: 'destination_name',
destination_slug: 'destination_slug',
destination_namespace: 'destination_namespace'
}
]
}
end
it 'returns a mutually exclusive error' do
request
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['error']).to eq('entities[0][destination_slug], entities[0][destination_name] are mutually exclusive')
end
end
context 'when neither destination_name nor destination_slug is provided' do
let(:params) do
{
configuration: {
url: 'http://gitlab.example',
access_token: 'access_token'
},
entities: [
{
source_type: 'group_entity',
source_full_path: 'full_path',
destination_namespace: destination_namespace.path
}
]
}
end
it 'returns at_least_one_of error' do
request
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['error']).to eq('entities[0][destination_slug], entities[0][destination_name] are missing, at least one parameter must be provided')
end
end
context 'when the source_full_path is invalid' do
it 'returns invalid error' do
params[:entities][0][:source_full_path] = 'http://example.com/full_path'
request
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['error']).to eq("entities[0][source_full_path] must be a relative path and not include protocol, sub-domain, " \
"or domain information. For example, 'source/full/path' not 'https://example.com/source/full/path'")
end
end
context 'when the destination_namespace does not exist' do
it 'returns invalid error' do
params[:entities][0][:destination_namespace] = "invalid-destination-namespace"
request
expect(response).to have_gitlab_http_status(:unprocessable_entity)
expect(json_response['message']).to eq("Import failed. Destination 'invalid-destination-namespace' is invalid, or you don't have permission.")
end
end
context 'when the destination_namespace is an empty string' do
it 'accepts the param and starts a new migration' do
params[:entities][0][:destination_namespace] = ''
request
expect(response).to have_gitlab_http_status(:created)
expect(json_response['status']).to eq('created')
end
end
context 'when the destination_namespace is invalid' do
it 'returns invalid error' do
params[:entities][0][:destination_namespace] = 'dest?nation-namespace'
request
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['error']).to include('entities[0][destination_namespace] must be a relative path ' \
'and not include protocol, sub-domain, or domain information. ' \
"For example, 'destination/full/path' not " \
"'https://example.com/destination/full/path'")
end
end
context 'when the destination_slug is invalid' do
it 'returns invalid error' do
params[:entities][0][:destination_slug] = 'des?tin?atoi-slugg'
request
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['error']).to include("entities[0][destination_slug] must not start or " \
"end with a special character and must not contain " \
"consecutive special characters. It can only contain " \
"alphanumeric characters, periods, underscores, and " \
"dashes. For example, 'destination_namespace' not 'destination/namespace'")
end
end
context 'when provided url is blocked' do
let(:params) do
{
configuration: {
url: 'url',
access_token: 'access_token'
},
entities: [
source_type: 'group_entity',
source_full_path: 'full_path',
destination_slug: 'destination_slug',
destination_namespace: 'destination_namespace'
]
}
end
it 'returns blocked url message in the error', :aggregate_failures do
request
expect(response).to have_gitlab_http_status(:unprocessable_entity)
expect(json_response['message']).to eq("URL is blocked: Only allowed schemes are http, https")
end
end
context 'when source instance setting is disabled' do
let(:params) do
{
configuration: {
url: 'http://gitlab.example',
access_token: 'access_token'
},
entities: [
source_type: 'group_entity',
source_full_path: 'full_path',
destination_slug: 'destination_slug',
destination_namespace: 'destination_namespace'
]
}
end
it 'returns blocked url error', :aggregate_failures do
stub_request(:get, "http://gitlab.example/api/v4/#{source_entity_type}/#{source_entity_identifier}/export_relations/status?page=1&per_page=30&private_token=access_token")
.to_return(status: 404, body: "{'error':'404 Not Found'}")
request
expect(response).to have_gitlab_http_status(:unprocessable_entity)
expect(json_response['message']).to eq(
"Unsuccessful response 404 from /api/v4/groups/full_path/export_relations/status. Body: {'error':'404 Not Found'}"
)
end
end
it_behaves_like 'disabled feature'
context 'when request exceeds rate limits' do
it 'prevents user from starting a new migration' do
allow(::Gitlab::ApplicationRateLimiter).to receive(:throttled?).and_return(true)
request
expect(response).to have_gitlab_http_status(:too_many_requests)
expect(json_response['message']['error']).to eq('This endpoint has been requested too many times. Try again later.')
end
end
end
describe 'GET /bulk_imports/entities' do
let(:request) { get api('/bulk_imports/entities', user) }
it 'returns a list of all import entities authored by the user' do
request
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.pluck('id')).to contain_exactly(entity_1.id, entity_2.id, entity_3.id)
end
it_behaves_like 'disabled feature'
end
describe 'GET /bulk_imports/:id' do
let(:request) { get api("/bulk_imports/#{import_1.id}", user) }
it 'returns specified bulk import' do
request
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['id']).to eq(import_1.id)
end
it_behaves_like 'disabled feature'
end
describe 'GET /bulk_imports/:id/entities' do
let(:request) { get api("/bulk_imports/#{import_2.id}/entities", user) }
it 'returns specified bulk import entities with failures' do
request
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.pluck('id')).to contain_exactly(entity_3.id)
expect(json_response.first['failures'].first['exception_message']).to eq(failure_3.exception_message)
end
it_behaves_like 'disabled feature'
end
describe 'GET /bulk_imports/:id/entities/:entity_id' do
let(:request) { get api("/bulk_imports/#{import_1.id}/entities/#{entity_2.id}", user) }
it 'returns specified bulk import entity' do
request
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['id']).to eq(entity_2.id)
end
it_behaves_like 'disabled feature'
end
context 'when user is unauthenticated' do
it 'returns 401' do
get api('/bulk_imports', nil)
expect(response).to have_gitlab_http_status(:unauthorized)
end
end
describe 'GET /bulk_imports/:id/entities/:entity_id/failures' do
let(:request) { get api("/bulk_imports/#{import_2.id}/entities/#{entity_3.id}/failures", user) }
it 'returns specified entity failures' do
request
expect(response).to have_gitlab_http_status(:ok)
expect(json_response.first['exception_message']).to eq(failure_3.exception_message)
end
it_behaves_like 'disabled feature'
end
end
|