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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Database::Migrations::TestBatchedBackgroundRunner, :freeze_time do
include Gitlab::Database::MigrationHelpers
include Database::MigrationTestingHelpers
def queue_migration(
job_class_name,
batch_table_name,
batch_column_name,
*job_arguments,
job_interval:,
batch_size: Gitlab::Database::Migrations::BatchedBackgroundMigrationHelpers::BATCH_SIZE,
sub_batch_size: Gitlab::Database::Migrations::BatchedBackgroundMigrationHelpers::SUB_BATCH_SIZE
)
batch_max_value = define_batchable_model(batch_table_name, connection: connection).maximum(batch_column_name)
Gitlab::Database::SharedModel.using_connection(connection) do
Gitlab::Database::BackgroundMigration::BatchedMigration.create!(
job_class_name: job_class_name,
table_name: batch_table_name,
column_name: batch_column_name,
job_arguments: job_arguments,
interval: job_interval,
min_value: Gitlab::Database::Migrations::BatchedBackgroundMigrationHelpers::BATCH_MIN_VALUE,
max_value: batch_max_value,
batch_class_name: Gitlab::Database::Migrations::BatchedBackgroundMigrationHelpers::BATCH_CLASS_NAME,
batch_size: batch_size,
sub_batch_size: sub_batch_size,
status_event: :execute,
max_batch_size: nil,
gitlab_schema: gitlab_schema
)
end
end
where(:case_name, :base_model, :gitlab_schema) do
[
['main database', ApplicationRecord, :gitlab_main],
['ci database', Ci::ApplicationRecord, :gitlab_ci]
]
end
with_them do
let(:result_dir) { Dir.mktmpdir }
after do
FileUtils.rm_rf(result_dir)
end
let(:connection) { base_model.connection }
let(:table_name) { "_test_column_copying" }
let(:from_id) { 0 }
before do
connection.execute(<<~SQL)
CREATE TABLE #{table_name} (
id bigint primary key not null,
data bigint default 0
);
insert into #{table_name} (id) select i from generate_series(1, 1000) g(i);
SQL
end
context 'running a real background migration' do
before do
queue_migration('CopyColumnUsingBackgroundMigrationJob',
table_name, :id,
:id, :data,
batch_size: 100,
job_interval: 5.minutes) # job_interval is skipped when testing
end
subject(:sample_migration) do
described_class.new(result_dir: result_dir, connection: connection,
from_id: from_id).run_jobs(for_duration: 1.minute)
end
it 'runs sampled jobs from the batched background migration' do
# Expect that running sampling for this migration processes some of the rows. Sampling doesn't run
# over every row in the table, so this does not completely migrate the table.
expect { subject }.to change {
define_batchable_model(table_name, connection: connection)
.where('id IS DISTINCT FROM data').count
}.by_at_most(-1)
end
it 'uses the correct connection to instrument the background migration' do
expect_next_instance_of(Gitlab::Database::Migrations::Instrumentation) do |instrumentation|
expect(instrumentation).to receive(:observe).with(hash_including(connection: connection))
.at_least(:once).and_call_original
end
subject
end
end
context 'with jobs to run' do
let(:migration_name) { 'TestBackgroundMigration' }
it 'samples jobs' do
calls = []
define_background_migration(migration_name) do |*args|
calls << args
end
queue_migration(migration_name, table_name, :id,
job_interval: 5.minutes,
batch_size: 100)
described_class.new(result_dir: result_dir, connection: connection,
from_id: from_id).run_jobs(for_duration: 3.minutes)
expect(calls).not_to be_empty
end
context 'with multiple jobs to run' do
let(:last_id) do
Gitlab::Database::SharedModel.using_connection(connection) do
Gitlab::Database::BackgroundMigration::BatchedMigration.maximum(:id)
end
end
it 'runs all pending jobs based on the last migration id' do
old_migration = define_background_migration(migration_name)
queue_migration(migration_name, table_name, :id,
job_interval: 5.minutes,
batch_size: 100)
last_id
new_migration = define_background_migration('NewMigration') { travel 1.second }
queue_migration('NewMigration', table_name, :id,
job_interval: 5.minutes,
batch_size: 10,
sub_batch_size: 5)
other_new_migration = define_background_migration('NewMigration2') { travel 2.seconds }
queue_migration('NewMigration2', table_name, :id,
job_interval: 5.minutes,
batch_size: 10,
sub_batch_size: 5)
expect_migration_runs(new_migration => 3, other_new_migration => 2, old_migration => 0) do
described_class.new(result_dir: result_dir, connection: connection,
from_id: last_id).run_jobs(for_duration: 5.seconds)
end
end
end
end
context 'choosing uniform batches to run' do
subject { described_class.new(result_dir: result_dir, connection: connection, from_id: from_id) }
describe '#uniform_fractions' do
it 'generates evenly distributed sequences of fractions' do
received = subject.uniform_fractions.take(9)
expected = [0, 1, 1.0 / 2, 1.0 / 4, 3.0 / 4, 1.0 / 8, 3.0 / 8, 5.0 / 8, 7.0 / 8]
# All the fraction numerators are small integers, and all denominators are powers of 2, so these
# fit perfectly into floating point numbers with zero loss of precision
expect(received).to eq(expected)
end
end
end
end
end
|
