debian-mirror-gitlab/lib/backup/database.rb

174 lines
4.6 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
require 'yaml'
module Backup
class Database
2019-07-07 11:18:12 +05:30
include Backup::Helper
2018-11-08 19:23:39 +05:30
attr_reader :progress
2015-11-26 14:37:03 +05:30
attr_reader :config, :db_file_name
2014-09-02 18:07:02 +05:30
2020-11-24 15:15:51 +05:30
IGNORED_ERRORS = [
2021-09-30 23:02:18 +05:30
# Ignore warnings
/WARNING:/,
2020-11-24 15:15:51 +05:30
# Ignore the DROP errors; recent database dumps will use --if-exists with pg_dump
/does not exist$/,
# User may not have permissions to drop extensions or schemas
/must be owner of/
].freeze
IGNORED_ERRORS_REGEXP = Regexp.union(IGNORED_ERRORS).freeze
def initialize(progress, filename: nil)
2018-11-08 19:23:39 +05:30
@progress = progress
2021-09-30 23:02:18 +05:30
@config = ActiveRecord::Base.configurations.find_db_config(Rails.env).configuration_hash
2020-11-24 15:15:51 +05:30
@db_file_name = filename || File.join(Gitlab.config.backup.path, 'db', 'database.sql.gz')
2014-09-02 18:07:02 +05:30
end
def dump
2015-11-26 14:37:03 +05:30
FileUtils.mkdir_p(File.dirname(db_file_name))
FileUtils.rm_f(db_file_name)
compress_rd, compress_wr = IO.pipe
2019-07-07 11:18:12 +05:30
compress_pid = spawn(gzip_cmd, in: compress_rd, out: [db_file_name, 'w', 0600])
2015-11-26 14:37:03 +05:30
compress_rd.close
2015-09-11 14:41:01 +05:30
2017-08-17 22:00:37 +05:30
dump_pid =
2021-09-30 23:02:18 +05:30
case config[:adapter]
2017-08-17 22:00:37 +05:30
when "postgresql" then
2021-09-30 23:02:18 +05:30
progress.print "Dumping PostgreSQL database #{database} ... "
2017-08-17 22:00:37 +05:30
pg_env
pgsql_args = ["--clean"] # Pass '--clean' to include 'DROP TABLE' statements in the DB dump.
2020-11-24 15:15:51 +05:30
pgsql_args << '--if-exists'
2020-07-28 23:09:34 +05:30
2017-08-17 22:00:37 +05:30
if Gitlab.config.backup.pg_schema
2020-07-28 23:09:34 +05:30
pgsql_args << '-n'
2017-08-17 22:00:37 +05:30
pgsql_args << Gitlab.config.backup.pg_schema
2020-07-28 23:09:34 +05:30
Gitlab::Database::EXTRA_SCHEMAS.each do |schema|
pgsql_args << '-n'
pgsql_args << schema.to_s
end
2017-08-17 22:00:37 +05:30
end
2018-03-17 18:26:18 +05:30
2021-09-30 23:02:18 +05:30
Process.spawn('pg_dump', *pgsql_args, database, out: compress_wr)
2015-09-25 12:07:36 +05:30
end
2015-11-26 14:37:03 +05:30
compress_wr.close
2017-08-17 22:00:37 +05:30
success = [compress_pid, dump_pid].all? do |pid|
Process.waitpid(pid)
$?.success?
end
2015-09-11 14:41:01 +05:30
report_success(success)
2020-11-24 15:15:51 +05:30
progress.flush
2022-03-02 08:16:31 +05:30
raise DatabaseBackupError.new(config, db_file_name) unless success
2014-09-02 18:07:02 +05:30
end
def restore
2015-11-26 14:37:03 +05:30
decompress_rd, decompress_wr = IO.pipe
2017-08-17 22:00:37 +05:30
decompress_pid = spawn(*%w(gzip -cd), out: decompress_wr, in: db_file_name)
2015-11-26 14:37:03 +05:30
decompress_wr.close
2015-09-11 14:41:01 +05:30
2020-11-24 15:15:51 +05:30
status, errors =
2021-09-30 23:02:18 +05:30
case config[:adapter]
2017-08-17 22:00:37 +05:30
when "postgresql" then
2021-09-30 23:02:18 +05:30
progress.print "Restoring PostgreSQL database #{database} ... "
2017-08-17 22:00:37 +05:30
pg_env
2020-11-24 15:15:51 +05:30
execute_and_track_errors(pg_restore_cmd, decompress_rd)
2017-08-17 22:00:37 +05:30
end
2015-11-26 14:37:03 +05:30
decompress_rd.close
2020-11-24 15:15:51 +05:30
Process.waitpid(decompress_pid)
success = $?.success? && status.success?
if errors.present?
progress.print "------ BEGIN ERRORS -----\n".color(:yellow)
progress.print errors.join.color(:yellow)
progress.print "------ END ERRORS -------\n".color(:yellow)
2017-08-17 22:00:37 +05:30
end
2015-11-26 14:37:03 +05:30
2014-09-02 18:07:02 +05:30
report_success(success)
2020-11-24 15:15:51 +05:30
raise Backup::Error, 'Restore failed' unless success
errors
2014-09-02 18:07:02 +05:30
end
protected
2021-09-30 23:02:18 +05:30
def database
@config[:database]
end
2020-11-24 15:15:51 +05:30
def ignore_error?(line)
IGNORED_ERRORS_REGEXP.match?(line)
end
def execute_and_track_errors(cmd, decompress_rd)
errors = []
Open3.popen3(ENV, *cmd) do |stdin, stdout, stderr, thread|
stdin.binmode
out_reader = Thread.new do
data = stdout.read
$stdout.write(data)
end
err_reader = Thread.new do
until (raw_line = stderr.gets).nil?
warn(raw_line)
errors << raw_line unless ignore_error?(raw_line)
end
end
begin
IO.copy_stream(decompress_rd, stdin)
rescue Errno::EPIPE
end
stdin.close
[thread, out_reader, err_reader].each(&:join)
[thread.value, errors]
end
end
2014-09-02 18:07:02 +05:30
def pg_env
2017-08-17 22:00:37 +05:30
args = {
2021-09-30 23:02:18 +05:30
username: 'PGUSER',
host: 'PGHOST',
port: 'PGPORT',
password: 'PGPASSWORD',
2017-08-17 22:00:37 +05:30
# SSL
2021-09-30 23:02:18 +05:30
sslmode: 'PGSSLMODE',
sslkey: 'PGSSLKEY',
sslcert: 'PGSSLCERT',
sslrootcert: 'PGSSLROOTCERT',
sslcrl: 'PGSSLCRL',
sslcompression: 'PGSSLCOMPRESSION'
2017-08-17 22:00:37 +05:30
}
2021-01-03 14:25:43 +05:30
args.each do |opt, arg|
# This enables the use of different PostgreSQL settings in
# case PgBouncer is used. PgBouncer clears the search path,
# which wreaks havoc on Rails if connections are reused.
override = "GITLAB_BACKUP_#{arg}"
val = ENV[override].presence || config[opt].to_s.presence
ENV[arg] = val if val
end
2014-09-02 18:07:02 +05:30
end
def report_success(success)
if success
2018-11-08 19:23:39 +05:30
progress.puts '[DONE]'.color(:green)
2014-09-02 18:07:02 +05:30
else
2018-11-08 19:23:39 +05:30
progress.puts '[FAILED]'.color(:red)
2014-09-02 18:07:02 +05:30
end
end
2020-11-24 15:15:51 +05:30
private
def pg_restore_cmd
2021-09-30 23:02:18 +05:30
['psql', database]
2020-11-24 15:15:51 +05:30
end
2014-09-02 18:07:02 +05:30
end
end