summaryrefslogtreecommitdiff
path: root/spec/lib/backup/gitaly_rpc_backup_spec.rb
blob: 6cba8c5c9b105b1cad238329b094b5416e7c13dd (plain)
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
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Backup::GitalyRpcBackup do
  let(:progress) { spy(:stdout) }
  let(:destination) { File.join(Gitlab.config.backup.path, 'repositories') }

  subject { described_class.new(progress) }

  after do
    # make sure we do not leave behind any backup files
    FileUtils.rm_rf(File.join(Gitlab.config.backup.path, 'repositories'))
  end

  context 'unknown' do
    it 'fails to start unknown' do
      expect { subject.start(:unknown, destination) }.to raise_error(::Backup::Error, 'unknown backup type: unknown')
    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)
        personal_snippet = create(:personal_snippet, :repository, author: project.first_owner)

        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

      context 'failure' do
        before do
          allow_next_instance_of(Repository) do |repository|
            allow(repository).to receive(:bundle_to_disk) { raise 'Fail in tests' }
          end
        end

        it 'logs an appropriate message', :aggregate_failures do
          subject.start(:create, destination)
          subject.enqueue(project, Gitlab::GlRepository::PROJECT)
          subject.finish!

          expect(progress).to have_received(:puts).with("[Failed] backing up #{project.full_path} (#{project.disk_path})")
          expect(progress).to have_received(:puts).with("Error Fail in tests")
        end
      end
    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
  end

  context 'restore' do
    let_it_be(:project) { create(:project, :repository) }
    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) }

    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')

      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 eq(['393a7d860a5a4c3cc736d7eb00604e3472bb95ec'])
      expect(collect_commit_shas.call(project.wiki.repository)).to eq(['c74b9948d0088d703ee1fafeddd9ed9add2901ea'])
      expect(collect_commit_shas.call(project.design_repository)).to eq(['c3cd4d7bd73a51a0f22045c3a4c871c435dc959d'])
      expect(collect_commit_shas.call(personal_snippet.repository)).to eq(['3b3c067a3bc1d1b695b51e2be30c0f8cf698a06e'])
      expect(collect_commit_shas.call(project_snippet.repository)).to eq(['6e44ba56a4748be361a841e759c20e421a1651a1'])
    end

    it 'cleans existing repositories', :aggregate_failures do
      expect_next_instance_of(DesignManagement::Repository) do |repository|
        expect(repository).to receive(:remove)
      end

      # 4 times = project repo + wiki repo + project_snippet repo + personal_snippet repo
      expect(Repository).to receive(:new).exactly(4).times.and_wrap_original do |method, *original_args|
        full_path, container, kwargs = original_args

        repository = method.call(full_path, container, **kwargs)

        expect(repository).to receive(:remove)

        repository
      end

      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!
    end

    context 'failure' do
      before do
        allow_next_instance_of(Repository) do |repository|
          allow(repository).to receive(:create_repository) { raise 'Fail in tests' }
          allow(repository).to receive(:create_from_bundle) { raise 'Fail in tests' }
        end
      end

      it 'logs an appropriate message', :aggregate_failures do
        subject.start(:restore, destination)
        subject.enqueue(project, Gitlab::GlRepository::PROJECT)
        subject.finish!

        expect(progress).to have_received(:puts).with("[Failed] restoring #{project.full_path} (#{project.disk_path})")
        expect(progress).to have_received(:puts).with("Error Fail in tests")
      end
    end
  end
end