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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.configure do |rspec|
rspec.expect_with :rspec do |c|
c.max_formatted_output_length = nil
end
end
RSpec.describe Backup::Database, feature_category: :backup_restore do
let(:progress) { StringIO.new }
let(:output) { progress.string }
let(:one_database_configured?) { base_models_for_backup.one? }
let(:timeout_service) do
instance_double(Gitlab::Database::TransactionTimeoutSettings, restore_timeouts: nil, disable_timeouts: nil)
end
let(:base_models_for_backup) do
Gitlab::Database.database_base_models_with_gitlab_shared.select do |database_name|
Gitlab::Database.has_database?(database_name)
end
end
before(:all) do
Rake::Task.define_task(:environment)
Rake.application.rake_require 'active_record/railties/databases'
Rake.application.rake_require 'tasks/gitlab/backup'
Rake.application.rake_require 'tasks/gitlab/shell'
Rake.application.rake_require 'tasks/gitlab/db'
Rake.application.rake_require 'tasks/cache'
end
describe '#dump', :delete do
let(:backup_id) { 'some_id' }
let(:force) { true }
subject { described_class.new(progress, force: force) }
before do
base_models_for_backup.each do |_, base_model|
base_model.connection.rollback_transaction unless base_model.connection.open_transactions.zero?
allow(base_model.connection).to receive(:execute).and_call_original
end
end
it 'creates gzipped database dumps' do
Dir.mktmpdir do |dir|
subject.dump(dir, backup_id)
base_models_for_backup.each_key do |database_name|
filename = database_name == 'main' ? 'database.sql.gz' : "#{database_name}_database.sql.gz"
expect(File.exist?(File.join(dir, filename))).to eq(true)
end
end
end
context 'when using multiple databases' do
before do
skip_if_shared_database(:ci)
end
it 'uses snapshots' do
Dir.mktmpdir do |dir|
base_model = Gitlab::Database.database_base_models['main']
expect(base_model.connection).to receive(:begin_transaction).with(
isolation: :repeatable_read
).and_call_original
expect(base_model.connection).to receive(:select_value).with(
"SELECT pg_export_snapshot()"
).and_call_original
expect(base_model.connection).to receive(:rollback_transaction).and_call_original
subject.dump(dir, backup_id)
end
end
it 'disables transaction time out' do
number_of_databases = base_models_for_backup.count
expect(Gitlab::Database::TransactionTimeoutSettings)
.to receive(:new).exactly(2 * number_of_databases).times.and_return(timeout_service)
expect(timeout_service).to receive(:disable_timeouts).exactly(number_of_databases).times
expect(timeout_service).to receive(:restore_timeouts).exactly(number_of_databases).times
Dir.mktmpdir do |dir|
subject.dump(dir, backup_id)
end
end
end
context 'when using a single databases' do
before do
skip_if_database_exists(:ci)
end
it 'does not use snapshots' do
Dir.mktmpdir do |dir|
base_model = Gitlab::Database.database_base_models['main']
expect(base_model.connection).not_to receive(:begin_transaction).with(
isolation: :repeatable_read
).and_call_original
expect(base_model.connection).not_to receive(:select_value).with(
"SELECT pg_export_snapshot()"
).and_call_original
expect(base_model.connection).not_to receive(:rollback_transaction).and_call_original
subject.dump(dir, backup_id)
end
end
end
describe 'pg_dump arguments' do
let(:snapshot_id) { 'fake_id' }
let(:pg_args) do
args = [
'--clean',
'--if-exists'
]
if Gitlab::Database.database_mode == Gitlab::Database::MODE_MULTIPLE_DATABASES
args + ["--snapshot=#{snapshot_id}"]
else
args
end
end
let(:dumper) { double }
let(:destination_dir) { 'tmp' }
before do
allow(Backup::Dump::Postgres).to receive(:new).and_return(dumper)
allow(dumper).to receive(:dump).with(any_args).and_return(true)
base_models_for_backup.each do |_, base_model|
allow(base_model.connection).to receive(:select_value).with(
"SELECT pg_export_snapshot()"
).and_return(snapshot_id)
end
end
it 'calls Backup::Dump::Postgres with correct pg_dump arguments' do
expect(dumper).to receive(:dump).with(anything, anything, pg_args)
subject.dump(destination_dir, backup_id)
end
context 'when a PostgreSQL schema is used' do
let(:schema) { 'gitlab' }
let(:additional_args) do
pg_args + ['-n', schema] + Gitlab::Database::EXTRA_SCHEMAS.flat_map do |schema|
['-n', schema.to_s]
end
end
before do
allow(Gitlab.config.backup).to receive(:pg_schema).and_return(schema)
end
it 'calls Backup::Dump::Postgres with correct pg_dump arguments' do
expect(dumper).to receive(:dump).with(anything, anything, additional_args)
subject.dump(destination_dir, backup_id)
end
end
end
context 'when a StandardError (or descendant) is raised' do
before do
allow(FileUtils).to receive(:mkdir_p).and_raise(StandardError)
end
it 'restores timeouts' do
Dir.mktmpdir do |dir|
number_of_databases = base_models_for_backup.count
expect(Gitlab::Database::TransactionTimeoutSettings)
.to receive(:new).exactly(number_of_databases).times.and_return(timeout_service)
expect(timeout_service).to receive(:restore_timeouts).exactly(number_of_databases).times
expect { subject.dump(dir, backup_id) }.to raise_error StandardError
end
end
end
end
describe '#restore' do
let(:cmd) { %W[#{Gem.ruby} -e $stdout.puts(1)] }
let(:backup_dir) { Rails.root.join("spec/fixtures/") }
let(:force) { true }
let(:rake_task) { instance_double(Rake::Task, invoke: true) }
subject { described_class.new(progress, force: force) }
before do
allow(Rake::Task).to receive(:[]).with(any_args).and_return(rake_task)
allow(subject).to receive(:pg_restore_cmd).and_return(cmd)
end
context 'when not forced' do
let(:force) { false }
it 'warns the user and waits' do
expect(subject).to receive(:sleep)
if one_database_configured?
expect(Rake::Task['gitlab:db:drop_tables']).to receive(:invoke)
else
expect(Rake::Task['gitlab:db:drop_tables:main']).to receive(:invoke)
end
subject.restore(backup_dir)
expect(output).to include('Removing all tables. Press `Ctrl-C` within 5 seconds to abort')
end
it 'has a pre restore warning' do
expect(subject.pre_restore_warning).not_to be_nil
end
end
context 'with an empty .gz file' do
it 'returns successfully' do
if one_database_configured?
expect(Rake::Task['gitlab:db:drop_tables']).to receive(:invoke)
else
expect(Rake::Task['gitlab:db:drop_tables:main']).to receive(:invoke)
end
subject.restore(backup_dir)
expect(output).to include("Restoring PostgreSQL database")
expect(output).to include("[DONE]")
expect(output).not_to include("ERRORS")
end
end
context 'with a corrupted .gz file' do
before do
allow(subject).to receive(:file_name).and_return("#{backup_dir}big-image.png")
end
it 'raises a backup error' do
if one_database_configured?
expect(Rake::Task['gitlab:db:drop_tables']).to receive(:invoke)
else
expect(Rake::Task['gitlab:db:drop_tables:main']).to receive(:invoke)
end
expect { subject.restore(backup_dir) }.to raise_error(Backup::Error)
end
end
context 'when the restore command prints errors' do
let(:visible_error) { "This is a test error\n" }
let(:noise) { "must be owner of extension pg_trgm\nWARNING: no privileges could be revoked for public\n" }
let(:cmd) { %W[#{Gem.ruby} -e $stderr.write("#{noise}#{visible_error}")] }
it 'filters out noise from errors and has a post restore warning' do
if one_database_configured?
expect(Rake::Task['gitlab:db:drop_tables']).to receive(:invoke)
else
expect(Rake::Task['gitlab:db:drop_tables:main']).to receive(:invoke)
end
subject.restore(backup_dir)
expect(output).to include("ERRORS")
expect(output).not_to include(noise)
expect(output).to include(visible_error)
expect(subject.post_restore_warning).not_to be_nil
end
end
context 'with PostgreSQL settings defined in the environment' do
let(:cmd) { %W[#{Gem.ruby} -e] + ["$stderr.puts ENV.to_h.select { |k, _| k.start_with?('PG') }"] }
let(:config) { YAML.load_file(File.join(Rails.root, 'config', 'database.yml'))['test'] }
before do
stub_const 'ENV', ENV.to_h.merge({
'GITLAB_BACKUP_PGHOST' => 'test.example.com',
'PGPASSWORD' => 'donotchange'
})
end
it 'overrides default config values' do
if one_database_configured?
expect(Rake::Task['gitlab:db:drop_tables']).to receive(:invoke)
else
expect(Rake::Task['gitlab:db:drop_tables:main']).to receive(:invoke)
end
subject.restore(backup_dir)
expect(output).to include(%("PGHOST"=>"test.example.com"))
expect(output).to include(%("PGPASSWORD"=>"donotchange"))
expect(output).to include(%("PGPORT"=>"#{config['port']}")) if config['port']
expect(output).to include(%("PGUSER"=>"#{config['username']}")) if config['username']
end
end
context 'when the source file is missing' do
context 'for main database' do
before do
allow(File).to receive(:exist?).and_call_original
allow(File).to receive(:exist?).with("#{backup_dir}database.sql.gz").and_return(false)
allow(File).to receive(:exist?).with("#{backup_dir}ci_database.sql.gz").and_return(false)
end
it 'raises an error about missing source file' do
if one_database_configured?
expect(Rake::Task['gitlab:db:drop_tables']).not_to receive(:invoke)
else
expect(Rake::Task['gitlab:db:drop_tables:main']).not_to receive(:invoke)
end
expect do
subject.restore('db')
end.to raise_error(Backup::Error, /Source database file does not exist/)
end
end
context 'for ci database' do
it 'ci database tolerates missing source file' do
expect { subject.restore(backup_dir) }.not_to raise_error
end
end
end
end
end
|