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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Database::TablesLocker, :suppress_gitlab_schemas_validate_connection, :silence_stdout,
feature_category: :cell do
let(:default_lock_writes_manager) do
instance_double(
Gitlab::Database::LockWritesManager,
lock_writes: { action: 'any action' },
unlock_writes: { action: 'unlocked' }
)
end
before do
allow(Gitlab::Database::LockWritesManager).to receive(:new).with(any_args).and_return(default_lock_writes_manager)
# Limiting the scope of the tests to a subset of the database tables
allow(Gitlab::Database::GitlabSchema).to receive(:tables_to_schema).and_return({
'application_setttings' => :gitlab_main_clusterwide,
'projects' => :gitlab_main,
'security_findings' => :gitlab_main,
'ci_builds' => :gitlab_ci,
'ci_jobs' => :gitlab_ci,
'loose_foreign_keys_deleted_records' => :gitlab_shared,
'ar_internal_metadata' => :gitlab_internal
})
end
before(:all) do
create_partition_sql = <<~SQL
CREATE TABLE IF NOT EXISTS #{Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA}.security_findings_test_partition
PARTITION OF security_findings
FOR VALUES IN (0)
SQL
create_detached_partition_sql = <<~SQL
CREATE TABLE IF NOT EXISTS #{Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA}._test_gitlab_main_part_202201 (
id bigserial primary key not null
)
SQL
[ApplicationRecord, Ci::ApplicationRecord]
.map(&:connection)
.each do |conn|
conn.execute(create_partition_sql)
conn.execute(
"DROP TABLE IF EXISTS #{Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA}._test_gitlab_main_part_202201"
)
conn.execute(create_detached_partition_sql)
Gitlab::Database::SharedModel.using_connection(conn) do
Postgresql::DetachedPartition.delete_all
Postgresql::DetachedPartition.create!(
table_name: '_test_gitlab_main_part_20220101',
drop_after: Time.current
)
end
end
end
after(:all) do
[ApplicationRecord, Ci::ApplicationRecord]
.map(&:connection)
.each do |conn|
conn.execute(
"DROP TABLE IF EXISTS #{Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA}._test_gitlab_main_part_202201"
)
Gitlab::Database::SharedModel.using_connection(conn) { Postgresql::DetachedPartition.delete_all }
end
end
shared_examples "lock tables" do |gitlab_schema, database_name|
let(:connection) { Gitlab::Database.database_base_models[database_name].connection }
let(:tables_to_lock) do
Gitlab::Database::GitlabSchema
.tables_to_schema.filter_map { |table_name, schema| table_name if schema == gitlab_schema }
end
it "locks table in schema #{gitlab_schema} and database #{database_name}" do
expect(tables_to_lock).not_to be_empty
tables_to_lock.each do |table_name|
lock_writes_manager = instance_double(Gitlab::Database::LockWritesManager, lock_writes: nil)
expect(Gitlab::Database::LockWritesManager).to receive(:new).with(
table_name: table_name,
connection: connection,
database_name: database_name,
with_retries: true,
logger: anything,
dry_run: anything
).once.and_return(lock_writes_manager)
expect(lock_writes_manager).to receive(:lock_writes).once
end
subject
end
it 'returns list of actions' do
expect(subject).to include({ action: 'any action' })
end
end
shared_examples "unlock tables" do |gitlab_schema, database_name|
let(:connection) { Gitlab::Database.database_base_models[database_name].connection }
let(:tables_to_unlock) do
Gitlab::Database::GitlabSchema
.tables_to_schema.filter_map { |table_name, schema| table_name if schema == gitlab_schema }
end
it "unlocks table in schema #{gitlab_schema} and database #{database_name}" do
expect(tables_to_unlock).not_to be_empty
tables_to_unlock.each do |table_name|
lock_writes_manager = instance_double(Gitlab::Database::LockWritesManager, unlock_writes: nil)
expect(Gitlab::Database::LockWritesManager).to receive(:new).with(
table_name: table_name,
connection: anything,
database_name: database_name,
with_retries: true,
logger: anything,
dry_run: anything
).once.and_return(lock_writes_manager)
expect(lock_writes_manager).to receive(:unlock_writes)
end
subject
end
it 'returns list of actions' do
expect(subject).to include({ action: 'unlocked' })
end
end
shared_examples "lock partitions" do |partition_identifier, database_name|
let(:connection) { Gitlab::Database.database_base_models[database_name].connection }
it 'locks the partition' do
lock_writes_manager = instance_double(Gitlab::Database::LockWritesManager, lock_writes: nil)
expect(Gitlab::Database::LockWritesManager).to receive(:new).with(
table_name: partition_identifier,
connection: connection,
database_name: database_name,
with_retries: true,
logger: anything,
dry_run: anything
).once.and_return(lock_writes_manager)
expect(lock_writes_manager).to receive(:lock_writes)
subject
end
end
shared_examples "unlock partitions" do |partition_identifier, database_name|
let(:connection) { Gitlab::Database.database_base_models[database_name].connection }
it 'unlocks the partition' do
lock_writes_manager = instance_double(Gitlab::Database::LockWritesManager, unlock_writes: nil)
expect(Gitlab::Database::LockWritesManager).to receive(:new).with(
table_name: partition_identifier,
connection: connection,
database_name: database_name,
with_retries: true,
logger: anything,
dry_run: anything
).once.and_return(lock_writes_manager)
expect(lock_writes_manager).to receive(:unlock_writes)
subject
end
end
context 'when running on single database' do
before do
skip_if_database_exists(:ci)
end
describe '#lock_writes' do
subject { described_class.new.lock_writes }
it 'does not lock any table' do
expect(Gitlab::Database::LockWritesManager).to receive(:new)
.with(any_args).and_return(default_lock_writes_manager)
expect(default_lock_writes_manager).not_to receive(:lock_writes)
subject
end
it_behaves_like 'unlock tables', :gitlab_main, 'main'
it_behaves_like 'unlock tables', :gitlab_ci, 'main'
it_behaves_like 'unlock tables', :gitlab_main_clusterwide, 'main'
it_behaves_like 'unlock tables', :gitlab_shared, 'main'
it_behaves_like 'unlock tables', :gitlab_internal, 'main'
end
describe '#unlock_writes' do
subject { described_class.new.lock_writes }
it 'does call Gitlab::Database::LockWritesManager.unlock_writes' do
expect(Gitlab::Database::LockWritesManager).to receive(:new)
.with(any_args).and_return(default_lock_writes_manager)
expect(default_lock_writes_manager).to receive(:unlock_writes)
expect(default_lock_writes_manager).not_to receive(:lock_writes)
subject
end
end
end
context 'when running on multiple databases' do
before do
skip_if_shared_database(:ci)
end
describe '#lock_writes' do
subject { described_class.new.lock_writes }
it_behaves_like 'lock tables', :gitlab_ci, 'main'
it_behaves_like 'lock tables', :gitlab_main, 'ci'
it_behaves_like 'lock tables', :gitlab_main_clusterwide, 'ci'
it_behaves_like 'unlock tables', :gitlab_main_clusterwide, 'main'
it_behaves_like 'unlock tables', :gitlab_main, 'main'
it_behaves_like 'unlock tables', :gitlab_ci, 'ci'
it_behaves_like 'unlock tables', :gitlab_shared, 'main'
it_behaves_like 'unlock tables', :gitlab_shared, 'ci'
it_behaves_like 'unlock tables', :gitlab_internal, 'main'
it_behaves_like 'unlock tables', :gitlab_internal, 'ci'
gitlab_main_partition = "#{Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA}.security_findings_test_partition"
it_behaves_like 'unlock partitions', gitlab_main_partition, 'main'
it_behaves_like 'lock partitions', gitlab_main_partition, 'ci'
gitlab_main_detached_partition = "#{Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA}._test_gitlab_main_part_20220101"
it_behaves_like 'unlock partitions', gitlab_main_detached_partition, 'main'
it_behaves_like 'lock partitions', gitlab_main_detached_partition, 'ci'
end
describe '#unlock_writes' do
subject { described_class.new.unlock_writes }
it_behaves_like "unlock tables", :gitlab_ci, 'main'
it_behaves_like "unlock tables", :gitlab_main, 'ci'
it_behaves_like "unlock tables", :gitlab_main, 'main'
it_behaves_like "unlock tables", :gitlab_ci, 'ci'
it_behaves_like "unlock tables", :gitlab_shared, 'main'
it_behaves_like "unlock tables", :gitlab_shared, 'ci'
it_behaves_like "unlock tables", :gitlab_internal, 'main'
it_behaves_like "unlock tables", :gitlab_internal, 'ci'
gitlab_main_partition = "#{Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA}.security_findings_test_partition"
it_behaves_like 'unlock partitions', gitlab_main_partition, 'main'
it_behaves_like 'unlock partitions', gitlab_main_partition, 'ci'
gitlab_main_detached_partition = "#{Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA}._test_gitlab_main_part_20220101"
it_behaves_like 'unlock partitions', gitlab_main_detached_partition, 'main'
it_behaves_like 'unlock partitions', gitlab_main_detached_partition, 'ci'
end
context 'when not including partitions' do
subject { described_class.new(include_partitions: false).lock_writes }
it 'does not include any table partitions' do
gitlab_main_partition = "#{Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA}.security_findings_test_partition"
expect(Gitlab::Database::LockWritesManager).not_to receive(:new).with(
hash_including(table_name: gitlab_main_partition)
)
subject
end
it 'does not include any detached partitions' do
detached_partition_name = "_test_gitlab_main_part_20220101"
gitlab_main_detached_partition = "#{Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA}.#{detached_partition_name}"
expect(Gitlab::Database::LockWritesManager).not_to receive(:new).with(
hash_including(table_name: gitlab_main_detached_partition)
)
subject
end
end
context 'when running in dry_run mode' do
subject { described_class.new(dry_run: true).lock_writes }
it 'passes dry_run flag to LockWritesManager' do
expect(Gitlab::Database::LockWritesManager).to receive(:new).with(
table_name: 'security_findings',
connection: anything,
database_name: 'ci',
with_retries: true,
logger: anything,
dry_run: true
).and_return(default_lock_writes_manager)
expect(default_lock_writes_manager).to receive(:lock_writes)
subject
end
end
context 'when running on multiple shared databases' do
subject { described_class.new.lock_writes }
before do
allow(::Gitlab::Database).to receive(:db_config_share_with).and_return(nil)
ci_db_config = Ci::ApplicationRecord.connection_db_config
allow(::Gitlab::Database).to receive(:db_config_share_with).with(ci_db_config).and_return('main')
end
it 'does not lock any tables if the ci database is shared with main database' do
expect(Gitlab::Database::LockWritesManager).to receive(:new)
.with(any_args).and_return(default_lock_writes_manager)
expect(default_lock_writes_manager).not_to receive(:lock_writes)
subject
end
end
end
context 'when geo database is configured' do
let(:geo_table) do
Gitlab::Database::GitlabSchema
.tables_to_schema.filter_map { |table_name, schema| table_name if schema == :gitlab_geo }
.first
end
subject { described_class.new.unlock_writes }
before do
skip "Geo database is not configured" unless Gitlab::Database.has_config?(:geo)
end
it 'does not lock table in geo database' do
expect(Gitlab::Database::LockWritesManager).not_to receive(:new).with(
table_name: geo_table,
connection: anything,
database_name: 'geo',
with_retries: true,
logger: anything,
dry_run: anything
)
subject
end
end
end
|