summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/background_migration/prepare_untracked_uploads_spec.rb
blob: 81af3f7830788750cb8cfb145acd1566abcecacb (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
require 'spec_helper'

describe Gitlab::BackgroundMigration::PrepareUntrackedUploads, :migration, :sidekiq, schema: 20171103140253 do
  include TrackUntrackedUploadsHelpers

  let!(:untracked_files_for_uploads) { table(:untracked_files_for_uploads) }

  matcher :be_scheduled_migration do |*expected|
    match do |migration|
      BackgroundMigrationWorker.jobs.any? do |job|
        job['args'] == [migration, expected]
      end
    end

    failure_message do |migration|
      "Migration `#{migration}` with args `#{expected.inspect}` not scheduled!"
    end
  end

  around do |example|
    # Especially important so the follow-up migration does not get run
    Sidekiq::Testing.fake! do
      example.run
    end
  end

  context 'when files were uploaded before and after hashed storage was enabled' do
    let!(:appearance) { create(:appearance, logo: uploaded_file, header_logo: uploaded_file) }
    let!(:user) { create(:user, :with_avatar) }
    let!(:project1) { create(:project, :with_avatar) }
    let(:project2) { create(:project) } # instantiate after enabling hashed_storage

    before do
      # Markdown upload before enabling hashed_storage
      UploadService.new(project1, uploaded_file, FileUploader).execute

      stub_application_setting(hashed_storage_enabled: true)

      # Markdown upload after enabling hashed_storage
      UploadService.new(project2, uploaded_file, FileUploader).execute
    end

    it 'adds unhashed files to the untracked_files_for_uploads table' do
      expect do
        described_class.new.perform
      end.to change { untracked_files_for_uploads.count }.from(0).to(5)
    end

    it 'adds files with paths relative to CarrierWave.root' do
      described_class.new.perform
      untracked_files_for_uploads.all.each do |file|
        expect(file.path.start_with?('uploads/')).to be_truthy
      end
    end

    it 'does not add hashed files to the untracked_files_for_uploads table' do
      described_class.new.perform

      hashed_file_path = project2.uploads.where(uploader: 'FileUploader').first.path
      expect(untracked_files_for_uploads.where("path like '%#{hashed_file_path}%'").exists?).to be_falsey
    end

    it 'correctly schedules the follow-up background migration jobs' do
      described_class.new.perform

      expect(described_class::FOLLOW_UP_MIGRATION).to be_scheduled_migration(1, 5)
      expect(BackgroundMigrationWorker.jobs.size).to eq(1)
    end

    # E.g. from a previous failed run of this background migration
    context 'when there is existing data in untracked_files_for_uploads' do
      before do
        described_class.new.perform
      end

      it 'does not error or produce duplicates of existing data' do
        expect do
          described_class.new.perform
        end.not_to change { untracked_files_for_uploads.count }.from(5)
      end
    end

    # E.g. The installation is in use at the time of migration, and someone has
    # just uploaded a file
    context 'when there are files in /uploads/tmp' do
      let(:tmp_file) { Rails.root.join(described_class::ABSOLUTE_UPLOAD_DIR, 'tmp', 'some_file.jpg') }

      before do
        FileUtils.touch(tmp_file)
      end

      after do
        FileUtils.rm(tmp_file)
      end

      it 'does not add files from /uploads/tmp' do
        expect do
          described_class.new.perform
        end.to change { untracked_files_for_uploads.count }.from(0).to(5)
      end
    end
  end

  # Very new or lightly-used installations that are running this migration
  # may not have an upload directory because they have no uploads.
  context 'when no files were ever uploaded' do
    it 'does not add to the untracked_files_for_uploads table (and does not raise error)' do
      expect do
        described_class.new.perform
      end.not_to change { untracked_files_for_uploads.count }.from(0)
    end
  end
end