gitlab-org--gitlab-foss/lib/backup/repository.rb

291 lines
8.8 KiB
Ruby
Raw Normal View History

2013-04-05 12:01:19 -04:00
require 'yaml'
require_relative 'helper'
2013-04-05 12:01:19 -04:00
module Backup
class Repository
include Backup::Helper
attr_reader :progress
def initialize(progress)
@progress = progress
end
2013-04-05 12:01:19 -04:00
def dump
prepare
Project.find_each(batch_size: 1000) do |project|
progress.print " * #{display_repo_path(project)} ... "
if project.hashed_storage?(:repository)
FileUtils.mkdir_p(File.dirname(File.join(backup_repos_path, project.disk_path)))
else
FileUtils.mkdir_p(File.join(backup_repos_path, project.namespace.full_path)) if project.namespace
end
2013-04-05 12:01:19 -04:00
2018-06-13 05:19:17 -04:00
if !empty_repo?(project)
backup_project(project)
2018-06-18 10:42:39 -04:00
progress.puts "[DONE]".color(:green)
2013-04-05 12:01:19 -04:00
else
2018-06-13 05:19:17 -04:00
progress.puts "[SKIPPED]".color(:cyan)
2013-04-05 12:01:19 -04:00
end
2013-04-05 14:20:11 -04:00
wiki = ProjectWiki.new(project)
2013-04-05 14:20:11 -04:00
2018-06-18 10:42:39 -04:00
if !empty_repo?(wiki)
2018-06-13 05:19:17 -04:00
backup_project(wiki)
2018-06-18 10:42:39 -04:00
progress.puts "[DONE] Wiki".color(:green)
2018-06-13 05:19:17 -04:00
else
progress.puts "[SKIPPED] Wiki".color(:cyan)
2013-04-05 14:20:11 -04:00
end
2013-04-05 12:01:19 -04:00
end
end
def prepare_directories
Gitlab.config.repositories.storages.each do |name, repository_storage|
delete_all_repositories(name, repository_storage)
end
end
2018-06-13 05:19:17 -04:00
def backup_project(project)
2018-06-25 10:21:54 -04:00
gitaly_migrate(:repository_backup, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
2018-06-13 05:19:17 -04:00
if is_enabled
backup_project_gitaly(project)
else
backup_project_local(project)
end
end
2018-06-19 10:26:39 -04:00
backup_custom_hooks(project)
2018-06-13 05:19:17 -04:00
rescue => e
progress_warn(project, e, 'Failed to backup repo')
end
def backup_project_gitaly(project)
path_to_project_bundle = path_to_bundle(project)
Gitlab::GitalyClient::RepositoryService.new(project.repository)
.create_bundle(path_to_project_bundle)
end
def backup_project_local(project)
path_to_project_repo = Gitlab::GitalyClient::StorageSettings.allow_disk_access do
path_to_repo(project)
end
path_to_project_bundle = path_to_bundle(project)
cmd = %W(#{Gitlab.config.git.bin_path} --git-dir=#{path_to_project_repo} bundle create #{path_to_project_bundle} --all)
output, status = Gitlab::Popen.popen(cmd)
progress_warn(project, cmd.join(' '), output) unless status.zero?
end
def delete_all_repositories(name, repository_storage)
2018-06-25 10:21:54 -04:00
gitaly_migrate(:delete_all_repositories, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
if is_enabled
Gitlab::GitalyClient::StorageService.new(name).delete_all_repositories
else
local_delete_all_repositories(name, repository_storage)
end
2013-04-05 12:01:19 -04:00
end
end
2013-04-05 12:01:19 -04:00
def local_delete_all_repositories(name, repository_storage)
path = repository_storage.legacy_disk_path
return unless File.exist?(path)
bk_repos_path = File.join(Gitlab.config.backup.path, "tmp", "#{name}-repositories.old." + Time.now.to_i.to_s)
FileUtils.mkdir_p(bk_repos_path, mode: 0700)
files = Dir.glob(File.join(path, "*"), File::FNM_DOTMATCH) - [File.join(path, "."), File.join(path, "..")]
begin
FileUtils.mv(files, bk_repos_path)
rescue Errno::EACCES
access_denied_error(path)
rescue Errno::EBUSY
resource_busy_error(path)
end
end
def local_restore_custom_hooks(project, dir)
path_to_project_repo = Gitlab::GitalyClient::StorageSettings.allow_disk_access do
path_to_repo(project)
end
cmd = %W(tar -xf #{path_to_tars(project, dir)} -C #{path_to_project_repo} #{dir})
output, status = Gitlab::Popen.popen(cmd)
unless status.zero?
progress_warn(project, cmd.join(' '), output)
end
end
def gitaly_restore_custom_hooks(project, dir)
custom_hooks_path = path_to_tars(project, dir)
Gitlab::GitalyClient::RepositoryService.new(project.repository)
.restore_custom_hooks(custom_hooks_path)
end
2018-06-13 05:19:17 -04:00
def local_backup_custom_hooks(project)
in_path(path_to_tars(project)) do |dir|
path_to_project_repo = Gitlab::GitalyClient::StorageSettings.allow_disk_access do
path_to_repo(project)
end
break unless File.exist?(File.join(path_to_project_repo, dir))
FileUtils.mkdir_p(path_to_tars(project))
cmd = %W(tar -cf #{path_to_tars(project, dir)} -c #{path_to_project_repo} #{dir})
output, status = Gitlab::Popen.popen(cmd)
unless status.zero?
progress_warn(project, cmd.join(' '), output)
end
end
end
def gitaly_backup_custom_hooks(project)
FileUtils.mkdir_p(path_to_tars(project))
custom_hooks_path = path_to_tars(project, 'custom_hooks')
Gitlab::GitalyClient::RepositoryService.new(project.repository)
.backup_custom_hooks(custom_hooks_path)
end
def backup_custom_hooks(project)
2018-06-25 10:21:54 -04:00
gitaly_migrate(:backup_custom_hooks, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
2018-06-13 05:19:17 -04:00
if is_enabled
gitaly_backup_custom_hooks(project)
else
local_backup_custom_hooks(project)
end
end
end
def restore_custom_hooks(project)
in_path(path_to_tars(project)) do |dir|
2018-06-25 10:21:54 -04:00
gitaly_migrate(:restore_custom_hooks, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
if is_enabled
gitaly_restore_custom_hooks(project, dir)
2018-06-13 05:19:17 -04:00
else
local_restore_custom_hooks(project, dir)
end
end
end
end
def restore
prepare_directories
gitlab_shell = Gitlab::Shell.new
2013-04-05 12:01:19 -04:00
Project.find_each(batch_size: 1000) do |project|
2018-05-11 18:09:26 -04:00
progress.print " * #{project.full_path} ... "
path_to_project_bundle = path_to_bundle(project)
2017-08-15 22:49:54 -04:00
project.ensure_storage_path_exists
2013-04-05 12:01:19 -04:00
restore_repo_success = nil
if File.exist?(path_to_project_bundle)
begin
project.repository.create_from_bundle path_to_project_bundle
restore_repo_success = true
rescue => e
restore_repo_success = false
progress.puts "Error: #{e}".color(:red)
end
else
restore_repo_success = gitlab_shell.create_repository(project.repository_storage, project.disk_path)
end
if restore_repo_success
2017-06-07 10:50:21 -04:00
progress.puts "[DONE]".color(:green)
2013-04-05 12:01:19 -04:00
else
2018-05-11 18:09:26 -04:00
progress.puts "[Failed] restoring #{project.full_path} repository".color(:red)
2013-04-05 12:01:19 -04:00
end
2013-04-05 14:20:11 -04:00
restore_custom_hooks(project)
wiki = ProjectWiki.new(project)
path_to_wiki_bundle = path_to_bundle(wiki)
2013-04-05 14:20:11 -04:00
if File.exist?(path_to_wiki_bundle)
2018-05-11 18:09:26 -04:00
progress.print " * #{wiki.full_path} ... "
begin
2018-05-11 18:09:26 -04:00
wiki.repository.create_from_bundle(path_to_wiki_bundle)
2018-06-21 07:56:00 -04:00
restore_custom_hooks(wiki)
2018-05-11 18:09:26 -04:00
progress.puts "[DONE]".color(:green)
rescue => e
2018-05-11 18:09:26 -04:00
progress.puts "[Failed] restoring #{wiki.full_path} wiki".color(:red)
progress.puts "Error #{e}".color(:red)
end
2013-04-05 14:20:11 -04:00
end
2013-04-05 12:01:19 -04:00
end
end
protected
def path_to_repo(project)
2014-11-05 11:51:08 -05:00
project.repository.path_to_repo
2013-04-05 12:01:19 -04:00
end
def path_to_bundle(project)
File.join(backup_repos_path, project.disk_path + '.bundle')
end
def path_to_tars(project, dir = nil)
path = File.join(backup_repos_path, project.disk_path)
if dir
File.join(path, "#{dir}.tar")
else
path
end
2013-04-05 12:01:19 -04:00
end
def backup_repos_path
File.join(Gitlab.config.backup.path, 'repositories')
end
def in_path(path)
return unless Dir.exist?(path)
dir_entries = Dir.entries(path)
2017-02-24 07:18:07 -05:00
2017-03-28 10:24:40 -04:00
if dir_entries.include?('custom_hooks') || dir_entries.include?('custom_hooks.tar')
yield('custom_hooks')
end
2013-04-05 12:01:19 -04:00
end
def prepare
FileUtils.rm_rf(backup_repos_path)
FileUtils.mkdir_p(Gitlab.config.backup.path)
FileUtils.mkdir(backup_repos_path, mode: 0700)
2013-04-05 12:01:19 -04:00
end
2013-11-05 09:00:48 -05:00
def silent
{ err: '/dev/null', out: '/dev/null' }
2013-11-05 09:00:48 -05:00
end
private
def progress_warn(project, cmd, output)
2017-06-07 10:50:21 -04:00
progress.puts "[WARNING] Executing #{cmd}".color(:orange)
progress.puts "Ignoring error on #{display_repo_path(project)} - #{output}".color(:orange)
end
2017-06-07 10:50:21 -04:00
def empty_repo?(project_or_wiki)
2017-12-07 10:33:30 -05:00
project_or_wiki.repository.expire_emptiness_caches
project_or_wiki.repository.empty?
end
def repository_storage_paths_args
Gitlab.config.repositories.storages.values.map { |rs| rs.legacy_disk_path }
end
2017-06-07 10:50:21 -04:00
def display_repo_path(project)
project.hashed_storage?(:repository) ? "#{project.full_path} (#{project.disk_path})" : project.full_path
end
def gitaly_migrate(method, status: Gitlab::GitalyClient::MigrationStatus::OPT_IN, &block)
Gitlab::GitalyClient.migrate(method, status: status, &block)
rescue GRPC::NotFound, GRPC::BadStatus => e
raise Error, e
end
2013-04-05 12:01:19 -04:00
end
end