debian-mirror-gitlab/spec/lib/backup/gitaly_backup_spec.rb

253 lines
11 KiB
Ruby
Raw Normal View History

2021-09-04 01:27:46 +05:30
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Backup::GitalyBackup do
2022-03-02 08:16:31 +05:30
let(:max_parallelism) { nil }
let(:storage_parallelism) { nil }
2022-05-07 20:08:51 +05:30
let(:destination) { File.join(Gitlab.config.backup.path, 'repositories') }
let(:backup_id) { '20220101' }
2021-11-18 22:05:49 +05:30
2021-09-04 01:27:46 +05:30
let(:progress) do
Tempfile.new('progress').tap do |progress|
progress.unlink
end
end
2021-11-18 22:05:49 +05:30
let(:expected_env) do
{
'SSL_CERT_FILE' => OpenSSL::X509::DEFAULT_CERT_FILE,
'SSL_CERT_DIR' => OpenSSL::X509::DEFAULT_CERT_DIR
}.merge(ENV)
end
2021-09-04 01:27:46 +05:30
after do
progress.close
end
2022-05-07 20:08:51 +05:30
subject { described_class.new(progress, max_parallelism: max_parallelism, storage_parallelism: storage_parallelism, backup_id: backup_id) }
2021-09-04 01:27:46 +05:30
context 'unknown' do
it 'fails to start unknown' do
2022-05-07 20:08:51 +05:30
expect { subject.start(:unknown, destination) }.to raise_error(::Backup::Error, 'unknown backup type: unknown')
2021-09-04 01:27:46 +05:30
end
end
context 'create' do
RSpec.shared_examples 'creates a repository backup' do
it 'creates repository bundles', :aggregate_failures do
# Add data to the wiki, design repositories, and snippets, so they will be included in the dump.
create(:wiki_page, container: project)
create(:design, :with_file, issue: create(:issue, project: project))
project_snippet = create(:project_snippet, :repository, project: project)
2022-04-04 11:22:00 +05:30
personal_snippet = create(:personal_snippet, :repository, author: project.first_owner)
2021-09-04 01:27:46 +05:30
2022-05-07 20:08:51 +05:30
expect(Open3).to receive(:popen2).with(expected_env, anything, 'create', '-path', anything, '-layout', 'pointer', '-id', backup_id).and_call_original
2021-09-30 23:02:18 +05:30
2022-05-07 20:08:51 +05:30
subject.start(:create, destination)
2021-09-04 01:27:46 +05:30
subject.enqueue(project, Gitlab::GlRepository::PROJECT)
subject.enqueue(project, Gitlab::GlRepository::WIKI)
subject.enqueue(project, Gitlab::GlRepository::DESIGN)
subject.enqueue(personal_snippet, Gitlab::GlRepository::SNIPPET)
subject.enqueue(project_snippet, Gitlab::GlRepository::SNIPPET)
2022-03-02 08:16:31 +05:30
subject.finish!
2021-09-04 01:27:46 +05:30
2022-05-07 20:08:51 +05:30
expect(File).to exist(File.join(destination, project.disk_path, backup_id, '001.bundle'))
expect(File).to exist(File.join(destination, project.disk_path + '.wiki', backup_id, '001.bundle'))
expect(File).to exist(File.join(destination, project.disk_path + '.design', backup_id, '001.bundle'))
expect(File).to exist(File.join(destination, personal_snippet.disk_path, backup_id, '001.bundle'))
expect(File).to exist(File.join(destination, project_snippet.disk_path, backup_id, '001.bundle'))
2021-09-04 01:27:46 +05:30
end
2021-09-30 23:02:18 +05:30
context 'parallel option set' do
2022-03-02 08:16:31 +05:30
let(:max_parallelism) { 3 }
2021-09-30 23:02:18 +05:30
it 'passes parallel option through' do
2022-05-07 20:08:51 +05:30
expect(Open3).to receive(:popen2).with(expected_env, anything, 'create', '-path', anything, '-parallel', '3', '-layout', 'pointer', '-id', backup_id).and_call_original
2021-09-30 23:02:18 +05:30
2022-05-07 20:08:51 +05:30
subject.start(:create, destination)
2022-03-02 08:16:31 +05:30
subject.finish!
2021-09-30 23:02:18 +05:30
end
end
context 'parallel_storage option set' do
2022-03-02 08:16:31 +05:30
let(:storage_parallelism) { 3 }
2021-09-30 23:02:18 +05:30
it 'passes parallel option through' do
2022-05-07 20:08:51 +05:30
expect(Open3).to receive(:popen2).with(expected_env, anything, 'create', '-path', anything, '-parallel-storage', '3', '-layout', 'pointer', '-id', backup_id).and_call_original
2021-09-30 23:02:18 +05:30
2022-05-07 20:08:51 +05:30
subject.start(:create, destination)
2022-03-02 08:16:31 +05:30
subject.finish!
2021-09-30 23:02:18 +05:30
end
end
2021-09-04 01:27:46 +05:30
it 'raises when the exit code not zero' do
expect(subject).to receive(:bin_path).and_return(Gitlab::Utils.which('false'))
2022-05-07 20:08:51 +05:30
subject.start(:create, destination)
2022-03-02 08:16:31 +05:30
expect { subject.finish! }.to raise_error(::Backup::Error, 'gitaly-backup exit status 1')
2021-09-04 01:27:46 +05:30
end
2022-05-07 20:08:51 +05:30
context 'feature flag incremental_repository_backup disabled' do
before do
stub_feature_flags(incremental_repository_backup: false)
end
it 'creates repository bundles', :aggregate_failures do
# Add data to the wiki, design repositories, and snippets, so they will be included in the dump.
create(:wiki_page, container: project)
create(:design, :with_file, issue: create(:issue, project: project))
project_snippet = create(:project_snippet, :repository, project: project)
personal_snippet = create(:personal_snippet, :repository, author: project.first_owner)
expect(Open3).to receive(:popen2).with(expected_env, anything, 'create', '-path', anything).and_call_original
subject.start(:create, destination)
subject.enqueue(project, Gitlab::GlRepository::PROJECT)
subject.enqueue(project, Gitlab::GlRepository::WIKI)
subject.enqueue(project, Gitlab::GlRepository::DESIGN)
subject.enqueue(personal_snippet, Gitlab::GlRepository::SNIPPET)
subject.enqueue(project_snippet, Gitlab::GlRepository::SNIPPET)
subject.finish!
expect(File).to exist(File.join(destination, project.disk_path + '.bundle'))
expect(File).to exist(File.join(destination, project.disk_path + '.wiki.bundle'))
expect(File).to exist(File.join(destination, project.disk_path + '.design.bundle'))
expect(File).to exist(File.join(destination, personal_snippet.disk_path + '.bundle'))
expect(File).to exist(File.join(destination, project_snippet.disk_path + '.bundle'))
end
end
2021-09-04 01:27:46 +05:30
end
context 'hashed storage' do
let_it_be(:project) { create(:project, :repository) }
it_behaves_like 'creates a repository backup'
end
context 'legacy storage' do
let_it_be(:project) { create(:project, :repository, :legacy_storage) }
it_behaves_like 'creates a repository backup'
end
2021-11-18 22:05:49 +05:30
context 'custom SSL envs set' do
let(:ssl_env) do
{
'SSL_CERT_FILE' => '/some/cert/file',
'SSL_CERT_DIR' => '/some/cert'
}
end
before do
stub_const('ENV', ssl_env)
end
it 'passes through SSL envs' do
2022-05-07 20:08:51 +05:30
expect(Open3).to receive(:popen2).with(ssl_env, anything, 'create', '-path', anything, '-layout', 'pointer', '-id', backup_id).and_call_original
2021-11-18 22:05:49 +05:30
2022-05-07 20:08:51 +05:30
subject.start(:create, destination)
2022-03-02 08:16:31 +05:30
subject.finish!
2021-11-18 22:05:49 +05:30
end
end
2021-09-04 01:27:46 +05:30
end
context 'restore' do
let_it_be(:project) { create(:project, :repository) }
2022-04-04 11:22:00 +05:30
let_it_be(:personal_snippet) { create(:personal_snippet, author: project.first_owner) }
let_it_be(:project_snippet) { create(:project_snippet, project: project, author: project.first_owner) }
2021-09-04 01:27:46 +05:30
def copy_bundle_to_backup_path(bundle_name, destination)
FileUtils.mkdir_p(File.join(Gitlab.config.backup.path, 'repositories', File.dirname(destination)))
FileUtils.cp(Rails.root.join('spec/fixtures/lib/backup', bundle_name), File.join(Gitlab.config.backup.path, 'repositories', destination))
end
it 'restores from repository bundles', :aggregate_failures do
copy_bundle_to_backup_path('project_repo.bundle', project.disk_path + '.bundle')
copy_bundle_to_backup_path('wiki_repo.bundle', project.disk_path + '.wiki.bundle')
copy_bundle_to_backup_path('design_repo.bundle', project.disk_path + '.design.bundle')
copy_bundle_to_backup_path('personal_snippet_repo.bundle', personal_snippet.disk_path + '.bundle')
copy_bundle_to_backup_path('project_snippet_repo.bundle', project_snippet.disk_path + '.bundle')
2022-05-07 20:08:51 +05:30
expect(Open3).to receive(:popen2).with(expected_env, anything, 'restore', '-path', anything, '-layout', 'pointer').and_call_original
2021-09-30 23:02:18 +05:30
2022-05-07 20:08:51 +05:30
subject.start(:restore, destination)
2021-09-04 01:27:46 +05:30
subject.enqueue(project, Gitlab::GlRepository::PROJECT)
subject.enqueue(project, Gitlab::GlRepository::WIKI)
subject.enqueue(project, Gitlab::GlRepository::DESIGN)
subject.enqueue(personal_snippet, Gitlab::GlRepository::SNIPPET)
subject.enqueue(project_snippet, Gitlab::GlRepository::SNIPPET)
2022-03-02 08:16:31 +05:30
subject.finish!
2021-09-04 01:27:46 +05:30
collect_commit_shas = -> (repo) { repo.commits('master', limit: 10).map(&:sha) }
2022-05-07 20:08:51 +05:30
expect(collect_commit_shas.call(project.repository)).to match_array(['393a7d860a5a4c3cc736d7eb00604e3472bb95ec'])
expect(collect_commit_shas.call(project.wiki.repository)).to match_array(['c74b9948d0088d703ee1fafeddd9ed9add2901ea'])
expect(collect_commit_shas.call(project.design_repository)).to match_array(['c3cd4d7bd73a51a0f22045c3a4c871c435dc959d'])
expect(collect_commit_shas.call(personal_snippet.repository)).to match_array(['3b3c067a3bc1d1b695b51e2be30c0f8cf698a06e'])
expect(collect_commit_shas.call(project_snippet.repository)).to match_array(['6e44ba56a4748be361a841e759c20e421a1651a1'])
2021-09-04 01:27:46 +05:30
end
2021-09-30 23:02:18 +05:30
context 'parallel option set' do
2022-03-02 08:16:31 +05:30
let(:max_parallelism) { 3 }
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
it 'passes parallel option through' do
2022-05-07 20:08:51 +05:30
expect(Open3).to receive(:popen2).with(expected_env, anything, 'restore', '-path', anything, '-parallel', '3', '-layout', 'pointer').and_call_original
2021-11-11 11:23:49 +05:30
2022-05-07 20:08:51 +05:30
subject.start(:restore, destination)
2022-03-02 08:16:31 +05:30
subject.finish!
2021-11-11 11:23:49 +05:30
end
end
context 'parallel_storage option set' do
2022-03-02 08:16:31 +05:30
let(:storage_parallelism) { 3 }
2021-11-11 11:23:49 +05:30
it 'passes parallel option through' do
2022-05-07 20:08:51 +05:30
expect(Open3).to receive(:popen2).with(expected_env, anything, 'restore', '-path', anything, '-parallel-storage', '3', '-layout', 'pointer').and_call_original
2021-09-30 23:02:18 +05:30
2022-05-07 20:08:51 +05:30
subject.start(:restore, destination)
2022-03-02 08:16:31 +05:30
subject.finish!
2021-09-30 23:02:18 +05:30
end
end
2022-05-07 20:08:51 +05:30
context 'feature flag incremental_repository_backup disabled' do
before do
stub_feature_flags(incremental_repository_backup: false)
end
it 'restores from repository bundles', :aggregate_failures do
copy_bundle_to_backup_path('project_repo.bundle', project.disk_path + '.bundle')
copy_bundle_to_backup_path('wiki_repo.bundle', project.disk_path + '.wiki.bundle')
copy_bundle_to_backup_path('design_repo.bundle', project.disk_path + '.design.bundle')
copy_bundle_to_backup_path('personal_snippet_repo.bundle', personal_snippet.disk_path + '.bundle')
copy_bundle_to_backup_path('project_snippet_repo.bundle', project_snippet.disk_path + '.bundle')
expect(Open3).to receive(:popen2).with(expected_env, anything, 'restore', '-path', anything).and_call_original
subject.start(:restore, destination)
subject.enqueue(project, Gitlab::GlRepository::PROJECT)
subject.enqueue(project, Gitlab::GlRepository::WIKI)
subject.enqueue(project, Gitlab::GlRepository::DESIGN)
subject.enqueue(personal_snippet, Gitlab::GlRepository::SNIPPET)
subject.enqueue(project_snippet, Gitlab::GlRepository::SNIPPET)
subject.finish!
collect_commit_shas = -> (repo) { repo.commits('master', limit: 10).map(&:sha) }
expect(collect_commit_shas.call(project.repository)).to match_array(['393a7d860a5a4c3cc736d7eb00604e3472bb95ec'])
expect(collect_commit_shas.call(project.wiki.repository)).to match_array(['c74b9948d0088d703ee1fafeddd9ed9add2901ea'])
expect(collect_commit_shas.call(project.design_repository)).to match_array(['c3cd4d7bd73a51a0f22045c3a4c871c435dc959d'])
expect(collect_commit_shas.call(personal_snippet.repository)).to match_array(['3b3c067a3bc1d1b695b51e2be30c0f8cf698a06e'])
expect(collect_commit_shas.call(project_snippet.repository)).to match_array(['6e44ba56a4748be361a841e759c20e421a1651a1'])
end
end
2021-09-04 01:27:46 +05:30
it 'raises when the exit code not zero' do
expect(subject).to receive(:bin_path).and_return(Gitlab::Utils.which('false'))
2022-05-07 20:08:51 +05:30
subject.start(:restore, destination)
2022-03-02 08:16:31 +05:30
expect { subject.finish! }.to raise_error(::Backup::Error, 'gitaly-backup exit status 1')
2021-09-04 01:27:46 +05:30
end
end
end