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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Database::Migrations::BatchedBackgroundMigrationHelpers do
let(:migration_class) do
Class.new(ActiveRecord::Migration[6.1])
.include(described_class)
.include(Gitlab::Database::Migrations::ReestablishedConnectionStack)
end
let(:migration) do
migration_class.new
end
describe '#queue_batched_background_migration' do
let(:pgclass_info) { instance_double('Gitlab::Database::PgClass', cardinality_estimate: 42) }
let(:job_class) do
Class.new(Gitlab::BackgroundMigration::BatchedMigrationJob) do
def self.name
'MyJobClass'
end
end
end
before do
allow(Gitlab::Database::PgClass).to receive(:for_table).and_call_original
expect(Gitlab::Database::QueryAnalyzers::RestrictAllowedSchemas).to receive(:require_dml_mode!)
allow(migration).to receive(:transaction_open?).and_return(false)
stub_const("Gitlab::Database::BackgroundMigration::BatchedMigration::JOB_CLASS_MODULE", '')
allow_next_instance_of(Gitlab::Database::BackgroundMigration::BatchedMigration) do |batched_migration|
allow(batched_migration).to receive(:job_class)
.and_return(job_class)
end
end
context 'when such migration already exists' do
it 'does not create duplicate migration' do
create(
:batched_background_migration,
job_class_name: 'MyJobClass',
table_name: :projects,
column_name: :id,
interval: 10.minutes,
min_value: 5,
max_value: 1005,
batch_class_name: 'MyBatchClass',
batch_size: 200,
sub_batch_size: 20,
job_arguments: [[:id], [:id_convert_to_bigint]],
gitlab_schema: :gitlab_ci
)
expect do
migration.queue_batched_background_migration(
job_class.name,
:projects,
:id,
[:id], [:id_convert_to_bigint],
job_interval: 5.minutes,
batch_min_value: 5,
batch_max_value: 1000,
batch_class_name: 'MyBatchClass',
batch_size: 100,
sub_batch_size: 10,
gitlab_schema: :gitlab_ci)
end.not_to change { Gitlab::Database::BackgroundMigration::BatchedMigration.count }
end
end
it 'creates the database record for the migration' do
expect(Gitlab::Database::PgClass).to receive(:for_table).with(:projects).and_return(pgclass_info)
expect do
migration.queue_batched_background_migration(
job_class.name,
:projects,
:id,
job_interval: 5.minutes,
batch_min_value: 5,
batch_max_value: 1000,
batch_class_name: 'MyBatchClass',
batch_size: 100,
max_batch_size: 10000,
sub_batch_size: 10,
gitlab_schema: :gitlab_ci)
end.to change { Gitlab::Database::BackgroundMigration::BatchedMigration.count }.by(1)
expect(Gitlab::Database::BackgroundMigration::BatchedMigration.last).to have_attributes(
job_class_name: 'MyJobClass',
table_name: 'projects',
column_name: 'id',
interval: 300,
min_value: 5,
max_value: 1000,
batch_class_name: 'MyBatchClass',
batch_size: 100,
max_batch_size: 10000,
sub_batch_size: 10,
job_arguments: %w[],
status_name: :active,
total_tuple_count: pgclass_info.cardinality_estimate,
gitlab_schema: 'gitlab_ci')
end
context 'when the job interval is lower than the minimum' do
let(:minimum_delay) { described_class::BATCH_MIN_DELAY }
it 'sets the job interval to the minimum value' do
expect do
migration.queue_batched_background_migration(job_class.name, :events, :id, job_interval: minimum_delay - 1.minute)
end.to change { Gitlab::Database::BackgroundMigration::BatchedMigration.count }.by(1)
created_migration = Gitlab::Database::BackgroundMigration::BatchedMigration.last
expect(created_migration.interval).to eq(minimum_delay)
end
end
context 'when additional arguments are passed to the method' do
context 'when the job class provides job_arguments_count' do
context 'when defined job arguments for the job class does not match provided arguments' do
it 'raises an error' do
expect do
migration.queue_batched_background_migration(
job_class.name,
:projects,
:id,
'my',
'arguments',
job_interval: 2.minutes)
end.to raise_error(RuntimeError, /Wrong number of job arguments for MyJobClass \(given 2, expected 0\)/)
end
end
context 'when defined job arguments for the job class match provided arguments' do
let(:job_class) do
Class.new(Gitlab::BackgroundMigration::BatchedMigrationJob) do
def self.name
'MyJobClass'
end
job_arguments :foo, :bar
end
end
it 'saves the arguments on the database record' do
expect do
migration.queue_batched_background_migration(
job_class.name,
:projects,
:id,
'my',
'arguments',
job_interval: 5.minutes,
batch_max_value: 1000)
end.to change { Gitlab::Database::BackgroundMigration::BatchedMigration.count }.by(1)
expect(Gitlab::Database::BackgroundMigration::BatchedMigration.last).to have_attributes(
job_class_name: 'MyJobClass',
table_name: 'projects',
column_name: 'id',
interval: 300,
min_value: 1,
max_value: 1000,
job_arguments: %w[my arguments])
end
end
end
context 'when the job class does not provide job_arguments_count' do
let(:job_class) do
Class.new do
def self.name
'MyJobClass'
end
end
end
it 'does not raise an error' do
expect do
migration.queue_batched_background_migration(
job_class.name,
:projects,
:id,
'my',
'arguments',
job_interval: 2.minutes)
end.not_to raise_error
end
end
end
context 'when the max_value is not given' do
context 'when records exist in the database' do
let!(:event1) { create(:event) }
let!(:event2) { create(:event) }
let!(:event3) { create(:event) }
it 'creates the record with the current max value' do
expect do
migration.queue_batched_background_migration(job_class.name, :events, :id, job_interval: 5.minutes)
end.to change { Gitlab::Database::BackgroundMigration::BatchedMigration.count }.by(1)
created_migration = Gitlab::Database::BackgroundMigration::BatchedMigration.last
expect(created_migration.max_value).to eq(event3.id)
end
it 'creates the record with an active status' do
expect do
migration.queue_batched_background_migration(job_class.name, :events, :id, job_interval: 5.minutes)
end.to change { Gitlab::Database::BackgroundMigration::BatchedMigration.count }.by(1)
expect(Gitlab::Database::BackgroundMigration::BatchedMigration.last).to be_active
end
end
context 'when the database is empty' do
it 'sets the max value to the min value' do
expect do
migration.queue_batched_background_migration(job_class.name, :events, :id, job_interval: 5.minutes)
end.to change { Gitlab::Database::BackgroundMigration::BatchedMigration.count }.by(1)
created_migration = Gitlab::Database::BackgroundMigration::BatchedMigration.last
expect(created_migration.max_value).to eq(created_migration.min_value)
end
it 'creates the record with a finished status' do
expect do
migration.queue_batched_background_migration(job_class.name, :projects, :id, job_interval: 5.minutes)
end.to change { Gitlab::Database::BackgroundMigration::BatchedMigration.count }.by(1)
expect(Gitlab::Database::BackgroundMigration::BatchedMigration.last).to be_finished
end
end
end
context 'when gitlab_schema is not given' do
it 'fetches gitlab_schema from the migration context' do
expect(migration).to receive(:gitlab_schema_from_context).and_return(:gitlab_ci)
expect do
migration.queue_batched_background_migration(job_class.name, :events, :id, job_interval: 5.minutes)
end.to change { Gitlab::Database::BackgroundMigration::BatchedMigration.count }.by(1)
created_migration = Gitlab::Database::BackgroundMigration::BatchedMigration.last
expect(created_migration.gitlab_schema).to eq('gitlab_ci')
end
end
end
describe '#finalize_batched_background_migration' do
let!(:batched_migration) { create(:batched_background_migration, job_class_name: 'MyClass', table_name: :projects, column_name: :id, job_arguments: []) }
before do
expect(Gitlab::Database::QueryAnalyzers::RestrictAllowedSchemas).to receive(:require_dml_mode!)
allow(migration).to receive(:transaction_open?).and_return(false)
end
it 'finalizes the migration' do
allow_next_instance_of(Gitlab::Database::BackgroundMigration::BatchedMigrationRunner) do |runner|
expect(runner).to receive(:finalize).with('MyClass', :projects, :id, [])
end
migration.finalize_batched_background_migration(job_class_name: 'MyClass', table_name: :projects, column_name: :id, job_arguments: [])
end
context 'when the migration does not exist' do
it 'raises an exception' do
expect do
migration.finalize_batched_background_migration(job_class_name: 'MyJobClass', table_name: :projects, column_name: :id, job_arguments: [])
end.to raise_error(RuntimeError, 'Could not find batched background migration')
end
end
context 'when within transaction' do
before do
allow(migration).to receive(:transaction_open?).and_return(true)
end
it 'does raise an exception' do
expect { migration.finalize_batched_background_migration(job_class_name: 'MyJobClass', table_name: :projects, column_name: :id, job_arguments: []) }
.to raise_error /`finalize_batched_background_migration` cannot be run inside a transaction./
end
end
context 'when running migration in reconfigured ActiveRecord::Base context' do
it_behaves_like 'reconfigures connection stack', 'ci' do
before do
create(:batched_background_migration,
job_class_name: 'Ci::MyClass',
table_name: :ci_builds,
column_name: :id,
job_arguments: [],
gitlab_schema: :gitlab_ci)
end
context 'when restrict_gitlab_migration is set to gitlab_ci' do
it 'finalizes the migration' do
migration_class.include(Gitlab::Database::MigrationHelpers::RestrictGitlabSchema)
migration_class.restrict_gitlab_migration gitlab_schema: :gitlab_ci
allow_next_instance_of(Gitlab::Database::BackgroundMigration::BatchedMigrationRunner) do |runner|
expect(runner).to receive(:finalize).with('Ci::MyClass', :ci_builds, :id, []) do
validate_connections_stack!
end
end
migration.finalize_batched_background_migration(
job_class_name: 'Ci::MyClass', table_name: :ci_builds, column_name: :id, job_arguments: [])
end
end
context 'when restrict_gitlab_migration is set to gitlab_main' do
it 'does not find any migrations' do
migration_class.include(Gitlab::Database::MigrationHelpers::RestrictGitlabSchema)
migration_class.restrict_gitlab_migration gitlab_schema: :gitlab_main
expect do
migration.finalize_batched_background_migration(
job_class_name: 'Ci::MyClass', table_name: :ci_builds, column_name: :id, job_arguments: [])
end.to raise_error /Could not find batched background migration/
end
end
context 'when no restrict is set' do
it 'does not find any migrations' do
expect do
migration.finalize_batched_background_migration(
job_class_name: 'Ci::MyClass', table_name: :ci_builds, column_name: :id, job_arguments: [])
end.to raise_error /Could not find batched background migration/
end
end
end
end
context 'when within transaction' do
before do
allow(migration).to receive(:transaction_open?).and_return(true)
end
it 'does raise an exception' do
expect { migration.finalize_batched_background_migration(job_class_name: 'MyJobClass', table_name: :projects, column_name: :id, job_arguments: []) }
.to raise_error /`finalize_batched_background_migration` cannot be run inside a transaction./
end
end
end
describe '#delete_batched_background_migration' do
before do
expect(Gitlab::Database::QueryAnalyzers::RestrictAllowedSchemas).to receive(:require_dml_mode!)
end
context 'when migration exists' do
it 'deletes it' do
create(
:batched_background_migration,
job_class_name: 'MyJobClass',
table_name: :projects,
column_name: :id,
interval: 10.minutes,
min_value: 5,
max_value: 1005,
batch_class_name: 'MyBatchClass',
batch_size: 200,
sub_batch_size: 20,
job_arguments: [[:id], [:id_convert_to_bigint]]
)
expect do
migration.delete_batched_background_migration(
'MyJobClass',
:projects,
:id,
[[:id], [:id_convert_to_bigint]])
end.to change { Gitlab::Database::BackgroundMigration::BatchedMigration.count }.from(1).to(0)
end
end
context 'when migration does not exist' do
it 'does nothing' do
create(
:batched_background_migration,
job_class_name: 'SomeOtherJobClass',
table_name: :projects,
column_name: :id,
interval: 10.minutes,
min_value: 5,
max_value: 1005,
batch_class_name: 'MyBatchClass',
batch_size: 200,
sub_batch_size: 20,
job_arguments: [[:id], [:id_convert_to_bigint]]
)
expect do
migration.delete_batched_background_migration(
'MyJobClass',
:projects,
:id,
[[:id], [:id_convert_to_bigint]])
end.not_to change { Gitlab::Database::BackgroundMigration::BatchedMigration.count }
end
end
end
describe '#gitlab_schema_from_context' do
context 'when allowed_gitlab_schemas is not available' do
it 'defaults to :gitlab_main' do
expect(migration.gitlab_schema_from_context).to eq(:gitlab_main)
end
end
context 'when allowed_gitlab_schemas is available' do
it 'uses schema from allowed_gitlab_schema' do
expect(migration).to receive(:allowed_gitlab_schemas).and_return([:gitlab_ci])
expect(migration.gitlab_schema_from_context).to eq(:gitlab_ci)
end
end
end
end
|