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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Database::BackgroundMigration::BatchedMigration, type: :model, feature_category: :database do
it_behaves_like 'having unique enum values'
it { is_expected.to be_a Gitlab::Database::SharedModel }
describe 'associations' do
it { is_expected.to have_many(:batched_jobs).with_foreign_key(:batched_background_migration_id) }
describe '#last_job' do
let!(:batched_migration) { create(:batched_background_migration) }
let!(:batched_job1) { create(:batched_background_migration_job, batched_migration: batched_migration, max_value: 1000) }
let!(:batched_job2) { create(:batched_background_migration_job, batched_migration: batched_migration, max_value: 500) }
it 'returns the batched job with highest max_value' do
expect(batched_migration.last_job).to eq(batched_job1)
end
end
end
describe 'validations' do
subject { build(:batched_background_migration) }
it { is_expected.to validate_uniqueness_of(:job_arguments).scoped_to(:job_class_name, :table_name, :column_name) }
context 'when there are failed jobs' do
let(:batched_migration) { create(:batched_background_migration, :active, total_tuple_count: 100) }
let!(:batched_job) { create(:batched_background_migration_job, :failed, batched_migration: batched_migration) }
it 'raises an exception' do
expect { batched_migration.finish! }.to raise_error(StateMachines::InvalidTransition)
expect(batched_migration.reload.status_name).to be :active
end
end
context 'when the jobs are completed' do
let(:batched_migration) { create(:batched_background_migration, :active, total_tuple_count: 100) }
let!(:batched_job) { create(:batched_background_migration_job, :succeeded, batched_migration: batched_migration) }
it 'finishes the migration' do
batched_migration.finish!
expect(batched_migration.status_name).to be :finished
end
it 'updates the finished_at' do
freeze_time do
expect { batched_migration.finish! }.to change(batched_migration, :finished_at).from(nil).to(Time.current)
end
end
end
end
describe 'state machine' do
context 'when a migration is executed' do
let!(:batched_migration) { create(:batched_background_migration) }
it 'updates the started_at' do
expect { batched_migration.execute! }.to change(batched_migration, :started_at).from(nil).to(Time)
end
end
end
describe '#pause!' do
context 'when an invalid transition is applied' do
%i[finished failed finalizing].each do |state|
it 'raises an exception' do
batched_migration = create(:batched_background_migration, state)
expect { batched_migration.pause! }.to raise_error(StateMachines::InvalidTransition, /Cannot transition status/)
end
end
end
context 'when a valid transition is applied' do
%i[active paused].each do |state|
it 'moves to pause' do
batched_migration = create(:batched_background_migration, state)
expect(batched_migration.pause!).to be_truthy
end
end
end
end
describe '#execute!' do
context 'when an invalid transition is applied' do
%i[finalizing finished].each do |state|
it 'raises an exception' do
batched_migration = create(:batched_background_migration, state)
expect { batched_migration.execute! }.to raise_error(StateMachines::InvalidTransition, /Cannot transition status/)
end
end
end
context 'when a valid transition is applied' do
%i[active paused failed].each do |state|
it 'moves to active' do
batched_migration = create(:batched_background_migration, state)
expect(batched_migration.execute!).to be_truthy
end
end
end
end
describe '#finish!' do
context 'when an invalid transition is applied' do
it 'raises an exception' do
batched_migration = create(:batched_background_migration, :failed)
expect { batched_migration.finish! }.to raise_error(StateMachines::InvalidTransition, /Cannot transition status/)
end
end
context 'when a valid transition is applied' do
%i[active paused finished finalizing].each do |state|
it 'moves to active' do
batched_migration = create(:batched_background_migration, state)
expect(batched_migration.finish!).to be_truthy
end
end
end
end
describe '#failure!' do
context 'when an invalid transition is applied' do
%i[paused finished].each do |state|
it 'raises an exception' do
batched_migration = create(:batched_background_migration, state)
expect { batched_migration.failure! }.to raise_error(StateMachines::InvalidTransition, /Cannot transition status/)
end
end
end
context 'when a valid transition is applied' do
%i[failed finalizing active].each do |state|
it 'moves to active' do
batched_migration = create(:batched_background_migration, state)
expect(batched_migration.failure!).to be_truthy
end
end
end
end
describe '.valid_status' do
valid_status = [:paused, :active, :finished, :failed, :finalizing]
it 'returns valid status' do
expect(described_class.valid_status).to eq(valid_status)
end
end
describe '.queue_order' do
let!(:migration1) { create(:batched_background_migration) }
let!(:migration2) { create(:batched_background_migration) }
let!(:migration3) { create(:batched_background_migration) }
it 'returns batched migrations ordered by their id' do
expect(described_class.queue_order.all).to eq([migration1, migration2, migration3])
end
end
describe '.ordered_by_created_at_desc' do
let!(:migration_1) { create(:batched_background_migration, created_at: Time.zone.now - 2) }
let!(:migration_2) { create(:batched_background_migration, created_at: Time.zone.now - 1) }
let!(:migration_3) { create(:batched_background_migration, created_at: Time.zone.now - 3) }
it 'returns batched migrations ordered by created_at (DESC)' do
expect(described_class.ordered_by_created_at_desc).to eq([migration_2, migration_1, migration_3])
end
end
describe '.find_executable' do
let(:connection) { Gitlab::Database.database_base_models[:main].connection }
let(:migration_id) { migration.id }
subject(:executable_migration) { described_class.find_executable(migration_id, connection: connection) }
around do |example|
Gitlab::Database::SharedModel.using_connection(connection) do
example.run
end
end
context 'when the migration does not exist' do
let(:migration_id) { non_existing_record_id }
it 'returns nil' do
expect(executable_migration).to be_nil
end
end
context 'when the migration is not active' do
let!(:migration) { create(:batched_background_migration, :finished) }
it 'returns nil' do
expect(executable_migration).to be_nil
end
end
context 'when the migration is on hold' do
let!(:migration) { create(:batched_background_migration, :active, on_hold_until: 10.minutes.from_now) }
it 'returns nil' do
expect(executable_migration).to be_nil
end
end
context 'when the migration is not available for the current connection' do
let!(:migration) { create(:batched_background_migration, :active, gitlab_schema: :gitlab_not_existing) }
it 'returns nil' do
expect(executable_migration).to be_nil
end
end
context 'when ther migration exists and is executable' do
let!(:migration) { create(:batched_background_migration, :active, gitlab_schema: :gitlab_main) }
it 'returns the migration' do
expect(executable_migration).to eq(migration)
end
end
end
describe '.active_migrations_distinct_on_table' do
let(:connection) { Gitlab::Database.database_base_models[:main].connection }
around do |example|
Gitlab::Database::SharedModel.using_connection(connection) do
example.run
end
end
it 'returns one pending executable migration per table' do
# non-active migration
create(:batched_background_migration, :finished)
# migration put on hold
create(:batched_background_migration, :active, on_hold_until: 10.minutes.from_now)
# migration not availab for the current connection
create(:batched_background_migration, :active, gitlab_schema: :gitlab_not_existing)
# active migration that is no longer on hold
migration_1 = create(:batched_background_migration, :active, table_name: :users, on_hold_until: 10.minutes.ago)
# another active migration for the same table
create(:batched_background_migration, :active, table_name: :users)
# active migration for different table
migration_2 = create(:batched_background_migration, :active, table_name: :projects)
# active migration for third table
create(:batched_background_migration, :active, table_name: :namespaces)
actual = described_class.active_migrations_distinct_on_table(connection: connection, limit: 2)
expect(actual).to eq([migration_1, migration_2])
end
it 'returns epmty collection when there are no pending executable migrations' do
actual = described_class.active_migrations_distinct_on_table(connection: connection, limit: 2)
expect(actual).to be_empty
end
end
describe '.created_after' do
let!(:migration_old) { create :batched_background_migration, created_at: 2.days.ago }
let!(:migration_new) { create :batched_background_migration, created_at: 0.days.ago }
it 'only returns migrations created after the specified time' do
expect(described_class.created_after(1.day.ago)).to contain_exactly(migration_new)
end
end
describe '.queued' do
let!(:migration1) { create(:batched_background_migration, :finished) }
let!(:migration2) { create(:batched_background_migration, :paused) }
let!(:migration3) { create(:batched_background_migration, :active) }
it 'returns active and paused migrations' do
expect(described_class.queued).to contain_exactly(migration2, migration3)
end
end
describe '.finalizing' do
let!(:migration1) { create(:batched_background_migration, :active) }
let!(:migration2) { create(:batched_background_migration, :paused) }
let!(:migration3) { create(:batched_background_migration, :finalizing) }
let!(:migration4) { create(:batched_background_migration, :finished) }
it 'returns only finalizing migrations' do
expect(described_class.finalizing).to contain_exactly(migration3)
end
end
describe '.successful_rows_counts' do
let!(:migration1) { create(:batched_background_migration) }
let!(:migration2) { create(:batched_background_migration) }
let!(:migration_without_jobs) { create(:batched_background_migration) }
before do
create(:batched_background_migration_job, :succeeded, batched_migration: migration1, batch_size: 1000)
create(:batched_background_migration_job, :failed, batched_migration: migration1, batch_size: 200)
create(:batched_background_migration_job, :succeeded, batched_migration: migration2, batch_size: 500)
create(:batched_background_migration_job, :running, batched_migration: migration2, batch_size: 200)
end
it 'returns totals from successful jobs' do
results = described_class.successful_rows_counts([migration1, migration2, migration_without_jobs])
expect(results[migration1.id]).to eq(1000)
expect(results[migration2.id]).to eq(500)
expect(results[migration_without_jobs.id]).to eq(nil)
end
end
describe '#reset_attempts_of_blocked_jobs!' do
let!(:migration) { create(:batched_background_migration) }
let(:max_attempts) { Gitlab::Database::BackgroundMigration::BatchedJob::MAX_ATTEMPTS }
before do
create(:batched_background_migration_job, attempts: max_attempts - 1, batched_migration: migration)
create(:batched_background_migration_job, attempts: max_attempts + 1, batched_migration: migration)
create(:batched_background_migration_job, attempts: max_attempts + 1, batched_migration: migration)
end
it 'sets the number of attempts to zero for blocked jobs' do
migration.reset_attempts_of_blocked_jobs!
expect(migration.batched_jobs.size).to eq(3)
migration.batched_jobs.blocked_by_max_attempts.each do |job|
expect(job.attempts).to be_zero
end
end
end
describe '#interval_elapsed?' do
context 'when the migration has no last_job' do
let(:batched_migration) { build(:batched_background_migration) }
it 'returns true' do
expect(batched_migration.interval_elapsed?).to eq(true)
end
end
context 'when the migration has a last_job' do
let(:interval) { 2.minutes }
let(:batched_migration) { create(:batched_background_migration, interval: interval) }
context 'when the last_job is less than an interval old' do
it 'returns false' do
freeze_time do
create(:batched_background_migration_job,
batched_migration: batched_migration,
created_at: Time.current - 1.minute)
expect(batched_migration.interval_elapsed?).to eq(false)
end
end
end
context 'when the last_job is exactly an interval old' do
it 'returns true' do
freeze_time do
create(:batched_background_migration_job,
batched_migration: batched_migration,
created_at: Time.current - 2.minutes)
expect(batched_migration.interval_elapsed?).to eq(true)
end
end
end
context 'when the last_job is more than an interval old' do
it 'returns true' do
freeze_time do
create(:batched_background_migration_job,
batched_migration: batched_migration,
created_at: Time.current - 3.minutes)
expect(batched_migration.interval_elapsed?).to eq(true)
end
end
end
context 'when an interval variance is given' do
let(:variance) { 2.seconds }
context 'when the last job is less than an interval with variance old' do
it 'returns false' do
freeze_time do
create(:batched_background_migration_job,
batched_migration: batched_migration,
created_at: Time.current - 1.minute - 57.seconds)
expect(batched_migration.interval_elapsed?(variance: variance)).to eq(false)
end
end
end
context 'when the last job is more than an interval with variance old' do
it 'returns true' do
freeze_time do
create(:batched_background_migration_job,
batched_migration: batched_migration,
created_at: Time.current - 1.minute - 58.seconds)
expect(batched_migration.interval_elapsed?(variance: variance)).to eq(true)
end
end
end
end
end
end
describe '#create_batched_job!' do
let(:batched_migration) do
create(:batched_background_migration,
batch_size: 999,
sub_batch_size: 99,
pause_ms: 250
)
end
it 'creates a batched_job with the correct batch configuration' do
batched_job = batched_migration.create_batched_job!(1, 5)
expect(batched_job).to have_attributes(
min_value: 1,
max_value: 5,
batch_size: batched_migration.batch_size,
sub_batch_size: batched_migration.sub_batch_size,
pause_ms: 250
)
end
end
describe '#next_min_value' do
let!(:batched_migration) { create(:batched_background_migration) }
context 'when a previous job exists' do
let!(:batched_job) { create(:batched_background_migration_job, batched_migration: batched_migration) }
it 'returns the next value after the previous maximum' do
expect(batched_migration.next_min_value).to eq(batched_job.max_value + 1)
end
end
context 'when a previous job does not exist' do
it 'returns the migration minimum value' do
expect(batched_migration.next_min_value).to eq(batched_migration.min_value)
end
end
end
describe '#job_class' do
let(:job_class) { Gitlab::BackgroundMigration::CopyColumnUsingBackgroundMigrationJob }
let(:batched_migration) { build(:batched_background_migration) }
it 'returns the class of the job for the migration' do
expect(batched_migration.job_class).to eq(job_class)
end
end
describe '#batch_class' do
let(:batch_class) { Gitlab::BackgroundMigration::BatchingStrategies::PrimaryKeyBatchingStrategy }
let(:batched_migration) { build(:batched_background_migration) }
it 'returns the class of the batch strategy for the migration' do
expect(batched_migration.batch_class).to eq(batch_class)
end
end
shared_examples_for 'an attr_writer that assigns class names' do |attribute_name|
let(:batched_migration) { build(:batched_background_migration) }
context 'when a module name exists' do
it 'keeps the class with module name' do
batched_migration.public_send(:"#{attribute_name}=", 'Foo::Bar')
expect(batched_migration[attribute_name]).to eq('Foo::Bar')
end
it 'removes leading namespace resolution operator' do
batched_migration.public_send(:"#{attribute_name}=", '::Foo::Bar')
expect(batched_migration[attribute_name]).to eq('Foo::Bar')
end
end
context 'when a module name does not exist' do
it 'does not change the given class name' do
batched_migration.public_send(:"#{attribute_name}=", 'Bar')
expect(batched_migration[attribute_name]).to eq('Bar')
end
end
end
describe '#retry_failed_jobs!' do
let(:batched_migration) { create(:batched_background_migration, status: 'failed') }
let(:job_class) { Gitlab::BackgroundMigration::CopyColumnUsingBackgroundMigrationJob }
subject(:retry_failed_jobs) { batched_migration.retry_failed_jobs! }
context 'when there are failed migration jobs' do
let!(:batched_background_migration_job) { create(:batched_background_migration_job, :failed, batched_migration: batched_migration, batch_size: 10, min_value: 6, max_value: 15, attempts: 3) }
before do
allow_next_instance_of(Gitlab::BackgroundMigration::BatchingStrategies::PrimaryKeyBatchingStrategy) do |batch_class|
allow(batch_class).to receive(:next_batch).with(
anything,
anything,
batch_min_value: 6,
batch_size: 5,
job_arguments: batched_migration.job_arguments,
job_class: job_class
).and_return([6, 10])
end
end
it 'moves the status of the migration to active' do
retry_failed_jobs
expect(batched_migration.status_name).to be :active
end
it 'changes the number of attempts to 0' do
retry_failed_jobs
expect(batched_background_migration_job.reload.attempts).to be_zero
end
end
context 'when there are no failed migration jobs' do
it 'moves the status of the migration to active' do
retry_failed_jobs
expect(batched_migration.status_name).to be :active
end
end
end
describe '#should_stop?' do
subject(:should_stop?) { batched_migration.should_stop? }
let(:batched_migration) { create(:batched_background_migration, started_at: started_at) }
before do
stub_const('Gitlab::Database::BackgroundMigration::BatchedMigration::MINIMUM_JOBS', 1)
end
context 'when the started_at is nil' do
let(:started_at) { nil }
it { expect(should_stop?).to be_falsey }
end
context 'when the number of jobs is lesser than the MINIMUM_JOBS' do
let(:started_at) { Time.zone.now - 6.days }
before do
stub_const('Gitlab::Database::BackgroundMigration::BatchedMigration::MINIMUM_JOBS', 10)
stub_const('Gitlab::Database::BackgroundMigration::BatchedMigration::MAXIMUM_FAILED_RATIO', 0.70)
create_list(:batched_background_migration_job, 1, :succeeded, batched_migration: batched_migration)
create_list(:batched_background_migration_job, 3, :failed, batched_migration: batched_migration)
end
it { expect(should_stop?).to be_falsey }
end
context 'when the calculated value is greater than the threshold' do
let(:started_at) { Time.zone.now - 6.days }
before do
stub_const('Gitlab::Database::BackgroundMigration::BatchedMigration::MAXIMUM_FAILED_RATIO', 0.70)
create_list(:batched_background_migration_job, 1, :succeeded, batched_migration: batched_migration)
create_list(:batched_background_migration_job, 3, :failed, batched_migration: batched_migration)
end
it { expect(should_stop?).to be_truthy }
end
context 'when the calculated value is lesser than the threshold' do
let(:started_at) { Time.zone.now - 6.days }
before do
create_list(:batched_background_migration_job, 2, :succeeded, batched_migration: batched_migration)
end
it { expect(should_stop?).to be_falsey }
end
end
describe '#job_class_name=' do
it_behaves_like 'an attr_writer that assigns class names', :job_class_name
end
describe '#batch_class_name=' do
it_behaves_like 'an attr_writer that assigns class names', :batch_class_name
end
describe '#migrated_tuple_count' do
subject { batched_migration.migrated_tuple_count }
let(:batched_migration) { create(:batched_background_migration) }
before do
create_list(:batched_background_migration_job, 5, :succeeded, batch_size: 1_000, batched_migration: batched_migration)
create_list(:batched_background_migration_job, 1, :running, batch_size: 1_000, batched_migration: batched_migration)
create_list(:batched_background_migration_job, 1, :failed, batch_size: 1_000, batched_migration: batched_migration)
end
it 'sums the batch_size of succeeded jobs' do
expect(subject).to eq(5_000)
end
end
describe '#prometheus_labels' do
let(:batched_migration) { create(:batched_background_migration, job_class_name: 'TestMigration', table_name: 'foo', column_name: 'bar') }
it 'returns a hash with labels for the migration' do
labels = {
migration_id: batched_migration.id,
migration_identifier: 'TestMigration/foo.bar'
}
expect(batched_migration.prometheus_labels).to eq(labels)
end
end
describe '#smoothed_time_efficiency' do
let_it_be(:migration) { create(:batched_background_migration, interval: 120.seconds) }
let_it_be(:end_time) { Time.zone.now }
around do |example|
freeze_time do
example.run
end
end
let_it_be(:common_attrs) do
{
batched_migration: migration,
finished_at: end_time
}
end
context 'when there are not enough jobs' do
subject { migration.smoothed_time_efficiency(number_of_jobs: 10) }
it 'returns nil' do
create_list(:batched_background_migration_job, 9, :succeeded, **common_attrs)
expect(subject).to be_nil
end
end
context 'when there are enough jobs' do
let_it_be(:number_of_jobs) { 10 }
let_it_be(:jobs) { create_list(:batched_background_migration_job, number_of_jobs, **common_attrs.merge(batched_migration: migration)) }
subject { migration.smoothed_time_efficiency(number_of_jobs: number_of_jobs) }
let!(:jobs) { create_list(:batched_background_migration_job, number_of_jobs, :succeeded, **common_attrs.merge(batched_migration: migration)) }
before do
expect(migration).to receive_message_chain(:batched_jobs, :successful_in_execution_order, :reverse_order, :limit, :with_preloads)
.and_return(jobs)
end
def mock_efficiencies(*effs)
effs.each_with_index do |eff, i|
expect(jobs[i]).to receive(:time_efficiency).and_return(eff)
end
end
context 'example 1: increasing trend, but only recently crossed threshold' do
it 'returns the smoothed time efficiency' do
mock_efficiencies(1.1, 1, 0.95, 0.9, 0.8, 0.95, 0.9, 0.8, 0.9, 0.95)
expect(subject).to be_within(0.05).of(0.95)
end
end
context 'example 2: increasing trend, crossed threshold a while ago' do
it 'returns the smoothed time efficiency' do
mock_efficiencies(1.2, 1.1, 1, 1, 1.1, 1, 0.95, 0.9, 0.95, 0.9)
expect(subject).to be_within(0.05).of(1.1)
end
end
context 'example 3: decreasing trend, but only recently crossed threshold' do
it 'returns the smoothed time efficiency' do
mock_efficiencies(0.9, 0.95, 1, 1.2, 1.1, 1.2, 1.1, 1.0, 1.1, 1.0)
expect(subject).to be_within(0.05).of(1.0)
end
end
context 'example 4: latest run spiked' do
it 'returns the smoothed time efficiency' do
mock_efficiencies(1.2, 0.9, 0.8, 0.9, 0.95, 0.9, 0.92, 0.9, 0.95, 0.9)
expect(subject).to be_within(0.02).of(0.96)
end
end
end
context 'with preloaded batched migration' do
it 'avoids N+1' do
create_list(:batched_background_migration_job, 11, **common_attrs.merge(started_at: end_time - 10.seconds))
control = ActiveRecord::QueryRecorder.new do
migration.smoothed_time_efficiency(number_of_jobs: 10)
end
expect { migration.smoothed_time_efficiency(number_of_jobs: 11) }.not_to exceed_query_limit(control)
end
end
end
describe '#optimize!' do
subject { batched_migration.optimize! }
let(:batched_migration) { create(:batched_background_migration) }
let(:optimizer) { instance_double('Gitlab::Database::BackgroundMigration::BatchOptimizer') }
it 'calls the BatchOptimizer' do
expect(Gitlab::Database::BackgroundMigration::BatchOptimizer).to receive(:new).with(batched_migration).and_return(optimizer)
expect(optimizer).to receive(:optimize!)
subject
end
end
describe '#hold!', :freeze_time do
subject { create(:batched_background_migration) }
let(:time) { 5.minutes.from_now }
it 'updates on_hold_until property' do
expect { subject.hold!(until_time: time) }.to change { subject.on_hold_until }.from(nil).to(time)
end
it 'defaults to 10 minutes' do
expect { subject.hold! }.to change { subject.on_hold_until }.from(nil).to(10.minutes.from_now)
end
end
describe '#on_hold?', :freeze_time do
subject { migration.on_hold? }
let(:migration) { create(:batched_background_migration) }
it 'returns false if no on_hold_until is set' do
migration.on_hold_until = nil
expect(subject).to be_falsey
end
it 'returns false if on_hold_until has passed' do
migration.on_hold_until = 1.minute.ago
expect(subject).to be_falsey
end
it 'returns true if on_hold_until is in the future' do
migration.on_hold_until = 1.minute.from_now
expect(subject).to be_truthy
end
end
describe '#progress' do
subject { migration.progress }
context 'when the migration is completed' do
let(:migration) do
create(:batched_background_migration, :finished, total_tuple_count: 1).tap do |record|
create(:batched_background_migration_job, :succeeded, batched_migration: record, batch_size: 1)
end
end
it 'returns 100' do
expect(subject).to be 100
end
end
context 'when the status is finished' do
let(:migration) do
create(:batched_background_migration, :finished, total_tuple_count: 100).tap do |record|
create(:batched_background_migration_job, :succeeded, batched_migration: record, batch_size: 5)
end
end
it 'returns 100' do
expect(subject).to be 100
end
end
context 'when the migration does not have jobs' do
let(:migration) { create(:batched_background_migration, :active) }
it 'returns zero' do
expect(subject).to be 0
end
end
context 'when the `total_tuple_count` is zero' do
let(:migration) { create(:batched_background_migration, :active, total_tuple_count: 0) }
let!(:batched_job) { create(:batched_background_migration_job, :succeeded, batched_migration: migration) }
it 'returns nil' do
expect(subject).to be nil
end
end
context 'when migration has completed jobs' do
let(:migration) { create(:batched_background_migration, :active, total_tuple_count: 100) }
let!(:batched_job) { create(:batched_background_migration_job, :succeeded, batched_migration: migration, batch_size: 8) }
it 'calculates the progress' do
expect(subject).to be 8
end
end
end
describe '.for_configuration' do
let!(:attributes) do
{
job_class_name: 'MyJobClass',
table_name: :projects,
column_name: :id,
job_arguments: [[:id], [:id_convert_to_bigint]],
gitlab_schema: :gitlab_main
}
end
let!(:migration) { create(:batched_background_migration, attributes) }
before do
create(:batched_background_migration, attributes.merge(job_class_name: 'OtherClass'))
create(:batched_background_migration, attributes.merge(table_name: 'other_table'))
create(:batched_background_migration, attributes.merge(column_name: 'other_column'))
create(:batched_background_migration, attributes.merge(job_arguments: %w[other arguments]))
end
it 'finds the migration matching the given configuration parameters' do
actual = described_class.for_configuration(:gitlab_main, 'MyJobClass', :projects, :id, [[:id], [:id_convert_to_bigint]])
expect(actual).to contain_exactly(migration)
end
it 'filters by gitlab schemas available for the connection' do
actual = described_class.for_configuration(:gitlab_ci, 'MyJobClass', :projects, :id, [[:id], [:id_convert_to_bigint]])
expect(actual).to be_empty
end
it 'doesn not filter by gitlab schemas available for the connection if the column is nor present' do
skip_if_multiple_databases_not_setup(:ci)
expect(described_class).to receive(:gitlab_schema_column_exists?).and_return(false)
actual = described_class.for_configuration(:gitlab_main, 'MyJobClass', :projects, :id, [[:id], [:id_convert_to_bigint]])
expect(actual).to contain_exactly(migration)
end
end
describe '.find_for_configuration' do
it 'returns nill if such migration does not exists' do
expect(described_class.find_for_configuration(:gitlab_main, 'MyJobClass', :projects, :id, [[:id], [:id_convert_to_bigint]])).to be_nil
end
it 'returns the migration when it exists' do
migration = create(
:batched_background_migration,
job_class_name: 'MyJobClass',
table_name: :projects,
column_name: :id,
job_arguments: [[:id], [:id_convert_to_bigint]],
gitlab_schema: :gitlab_main
)
expect(described_class.find_for_configuration(:gitlab_main, 'MyJobClass', :projects, :id, [[:id], [:id_convert_to_bigint]])).to eq(migration)
end
end
describe '.for_gitlab_schema' do
let!(:migration) { create(:batched_background_migration, gitlab_schema: :gitlab_main) }
before do
create(:batched_background_migration, gitlab_schema: :gitlab_not_existing)
end
it 'finds the migrations matching the given gitlab schema' do
actual = described_class.for_gitlab_schema(:gitlab_main)
expect(actual).to contain_exactly(migration)
end
end
end
|