From 9e4d9dc12508ba0c71638f039daa0b11b9ded254 Mon Sep 17 00:00:00 2001
From: Gabriel Mazetto <gabriel@gitlab.com>
Date: Fri, 28 Feb 2025 17:31:12 +0100
Subject: [PATCH] Use `Utils::Rake` to run the rake tasks when restoring
---
.../lib/gitlab/backup/cli/targets/database.rb | 32 ++++++++++++-------
.../backup/cli/targets/database_spec.rb | 6 ++--
2 files changed, 22 insertions(+), 16 deletions(-)
diff --git a/gems/gitlab-backup-cli/lib/gitlab/backup/cli/targets/database.rb b/gems/gitlab-backup-cli/lib/gitlab/backup/cli/targets/database.rb
index 79b3371cca919..aaa5340911f4d 100644
--- a/gems/gitlab-backup-cli/lib/gitlab/backup/cli/targets/database.rb
+++ b/gems/gitlab-backup-cli/lib/gitlab/backup/cli/targets/database.rb
@@ -18,6 +18,10 @@ class Database < Target
].freeze
IGNORED_ERRORS_REGEXP = Regexp.union(IGNORED_ERRORS).freeze
+ # Rake task used to drop all tables from GitLab databases
+ # This task is executed before restoring data
+ DROP_TABLES_TASK = "gitlab:db:drop_tables"
+
attr_reader :errors
def initialize(context)
@@ -66,6 +70,10 @@ def dump(destination_dir)
def restore(source)
databases = Gitlab::Backup::Cli::Services::Postgres.new(context)
+ # Drop all tables Load the schema to ensure we don't have any newer tables
+ # hanging out from a failed upgrade
+ drop_tables!
+
databases.each do |db|
database_name = db.configuration.name
pg_database_name = db.configuration.database
@@ -89,10 +97,6 @@ def restore(source)
next
end
- # Drop all tables Load the schema to ensure we don't have any newer tables
- # hanging out from a failed upgrade
- drop_tables(db)
-
Gitlab::Backup::Cli::Output.info "Restoring PostgreSQL database #{pg_database_name} ... "
status = restore_tables(database: db, filepath: db_file_name)
@@ -151,18 +155,22 @@ def report_finish_status(status)
Gitlab::Backup::Cli::Output.print_tag(status ? :success : :failure)
end
- def drop_tables(database)
- pg_database_name = database.configuration.database
- Gitlab::Backup::Cli::Output.print_info "Cleaning the '#{pg_database_name}' database ... "
+ def drop_tables!
+ Gitlab::Backup::Cli::Output.print_info "Cleaning existing databases ... "
+
+ gitlab_path = context.gitlab_basepath
+
+ # Drop existing tables from configured databases before restoring from a backup
+ rake = Utils::Rake.new(DROP_TABLES_TASK, chdir: gitlab_path).execute
+
+ unless rake.success?
+ Gitlab::Backup::Cli::Output.print_tag(:failure)
- if Rake::Task.task_defined? "gitlab:db:drop_tables:#{database.configuration.name}"
- Rake::Task["gitlab:db:drop_tables:#{database.configuration.name}"].invoke
- else
- # In single database (single or two connections)
- Rake::Task["gitlab:db:drop_tables"].invoke
+ raise Errors::DatabaseCleanupError.new(task: DROP_TABLES_TASK, path: gitlab_path, error: rake.stderr)
end
Gitlab::Backup::Cli::Output.print_tag(:success)
+ Gitlab::Backup::Cli::Output.info(rake.output) unless rake.output.empty?
end
def restore_tables(database:, filepath:)
diff --git a/gems/gitlab-backup-cli/spec/gitlab/backup/cli/targets/database_spec.rb b/gems/gitlab-backup-cli/spec/gitlab/backup/cli/targets/database_spec.rb
index e4a0963aa3df7..6e0064188b714 100644
--- a/gems/gitlab-backup-cli/spec/gitlab/backup/cli/targets/database_spec.rb
+++ b/gems/gitlab-backup-cli/spec/gitlab/backup/cli/targets/database_spec.rb
@@ -101,16 +101,14 @@
mock_databases_collection('main') do |db|
FileUtils.touch(source.join('database.sql.gz'))
-
- expect(database).to receive(:drop_tables).with(db)
end
+ expect(database).to receive(:drop_tables!)
+
database.restore(source)
end
it 'restores the database' do
- allow(database).to receive(:drop_tables)
-
mock_databases_collection('main') do |db|
filepath = source.join('database.sql.gz')
FileUtils.touch(filepath)
--
GitLab