file_uploader_spec.rb 9.08 KB
Newer Older
1
2
# frozen_string_literal: true

3
require 'spec_helper'
4
5

describe FileUploader do
6
  let(:group) { create(:group, name: 'awesome') }
Nick Thomas's avatar
Nick Thomas committed
7
  let(:project) { create(:project, :legacy_storage, namespace: group, name: 'project') }
8
  let(:uploader) { described_class.new(project, :avatar) }
9
10
  let(:upload) { double(model: project, path: "#{secret}/foo.jpg") }
  let(:secret) { "55dc16aa0edd05693fd98b5051e83321" } # this would be nicer as SecureRandom.hex, but the shared_examples breaks
11

12
  subject { uploader }
13

14
15
16
  shared_examples 'builds correct legacy storage paths' do
    include_examples 'builds correct paths',
                     store_dir: %r{awesome/project/\h+},
17
                     upload_path: %r{\h+/<filename>},
18
                     absolute_path: %r{#{described_class.root}/awesome/project/55dc16aa0edd05693fd98b5051e83321/foo.jpg}
19
20
  end

21
22
  context 'legacy storage' do
    it_behaves_like 'builds correct legacy storage paths'
Nick Thomas's avatar
Nick Thomas committed
23

24
25
26
    context 'uses hashed storage' do
      context 'when rolled out attachments' do
        let(:project) { build_stubbed(:project, namespace: group, name: 'project') }
27

28
29
30
31
        include_examples 'builds correct paths',
                         store_dir: %r{@hashed/\h{2}/\h{2}/\h+},
                         upload_path: %r{\h+/<filename>}
      end
32

33
34
      context 'when only repositories are rolled out' do
        let(:project) { build_stubbed(:project, namespace: group, name: 'project', storage_version: Project::HASHED_STORAGE_FEATURES[:repository]) }
35

36
37
        it_behaves_like 'builds correct legacy storage paths'
      end
38
39
    end
  end
40

41
42
43
44
  context 'object store is remote' do
    before do
      stub_uploads_object_storage
    end
45

46
    include_context 'with storage', described_class::Store::REMOTE
47

48
49
50
51
    # always use hashed storage path for remote uploads
    it_behaves_like 'builds correct paths',
                     store_dir: %r{@hashed/\h{2}/\h{2}/\h+},
                     upload_path: %r{@hashed/\h{2}/\h{2}/\h+/\h+/<filename>}
52
53
  end

54
  describe 'initialize' do
55
    let(:uploader) { described_class.new(double, secret: secret) }
56

57
    it 'accepts a secret parameter' do
58
      expect(described_class).not_to receive(:generate_secret)
59
      expect(uploader.secret).to eq(secret)
60
    end
61
  end
62

63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
  describe 'callbacks' do
    describe '#prune_store_dir after :remove' do
      before do
        uploader.store!(fixture_file_upload('spec/fixtures/doc_sample.txt'))
      end

      def store_dir
        File.expand_path(uploader.store_dir, uploader.root)
      end

      it 'is called' do
        expect(uploader).to receive(:prune_store_dir).once

        uploader.remove!
      end

      it 'prune the store directory' do
        expect { uploader.remove! }
Micael Bergeron's avatar
Micael Bergeron committed
81
          .to change { File.exist?(store_dir) }.from(true).to(false)
82
83
84
85
      end
    end
  end

86
  describe 'copy_to' do
87
88
89
    let(:new_project) { create(:project) }
    let(:moved) { described_class.copy_to(subject, new_project) }

90
91
92
93
94
95
96
97
    shared_examples 'returns a valid uploader' do
      describe 'returned uploader' do
        it 'generates a new secret' do
          expect(subject).to be
          expect(described_class).to receive(:generate_secret).once.and_call_original
          expect(moved).to be
        end

98
99
100
101
102
103
104
        it 'creates new upload correctly' do
          upload = moved.upload

          expect(upload).not_to eq(subject.upload)
          expect(upload.model).to eq(new_project)
          expect(upload.uploader).to eq('FileUploader')
          expect(upload.secret).not_to eq(subject.upload.secret)
105
106
107
108
109
110
111
112
113
114
115
        end

        it 'copies the file' do
          expect(subject.file).to exist
          expect(moved.file).to exist
          expect(subject.file).not_to eq(moved.file)
          expect(subject.object_store).to eq(moved.object_store)
        end
      end
    end

116
    context 'files are stored locally' do
117
118
119
      before do
        subject.store!(fixture_file_upload('spec/fixtures/dk.png'))
      end
120
121

      include_examples 'returns a valid uploader'
122
123
124
125
126
127

      it 'copies the file to the correct location' do
        expect(moved.upload.path).to eq("#{moved.upload.secret}/dk.png")
        expect(moved.file.path).to end_with("public/uploads/#{new_project.disk_path}/#{moved.upload.secret}/dk.png")
        expect(moved.filename).to eq('dk.png')
      end
128
129
130
131
132
133
134
135
136
137
    end

    context 'files are stored remotely' do
      before do
        stub_uploads_object_storage
        subject.store!(fixture_file_upload('spec/fixtures/dk.png'))
        subject.migrate!(ObjectStorage::Store::REMOTE)
      end

      include_examples 'returns a valid uploader'
138
139
140
141
142
143

      it 'copies the file to the correct location' do
        expect(moved.upload.path).to eq("#{new_project.disk_path}/#{moved.upload.secret}/dk.png")
        expect(moved.file.path).to eq("#{new_project.disk_path}/#{moved.upload.secret}/dk.png")
        expect(moved.filename).to eq('dk.png')
      end
144
145
146
    end
  end

147
148
149
150
151
152
153
154
155
  describe '.extract_dynamic_path' do
    it 'works with hashed storage' do
      path = 'export/4b227777d4dd1fc61c6f884f48641d02b4d121d3fd328cb08b5531fcacdabf8a/test/uploads/72a497a02fe3ee09edae2ed06d390038/dummy.txt'

      expect(described_class.extract_dynamic_path(path)[:identifier]).to eq('dummy.txt')
      expect(described_class.extract_dynamic_path(path)[:secret]).to eq('72a497a02fe3ee09edae2ed06d390038')
    end
  end

156
157
  describe '#secret' do
    it 'generates a secret if none is provided' do
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
      expect(described_class).to receive(:generate_secret).and_return(secret)
      expect(uploader.secret).to eq(secret)
      expect(uploader.secret.size).to eq(32)
    end

    context "validation" do
      before do
        uploader.instance_variable_set(:@secret, secret)
      end

      context "32-byte hexadecimal" do
        let(:secret) { SecureRandom.hex }

        it "returns the secret" do
          expect(uploader.secret).to eq(secret)
        end
      end

      context "10-byte hexadecimal" do
        let(:secret) { SecureRandom.hex(10) }

        it "returns the secret" do
          expect(uploader.secret).to eq(secret)
        end
      end

      context "invalid secret supplied" do
        let(:secret) { "%2E%2E%2F%2E%2E%2F%2E%2E%2F%2E%2E%2F%2E%2E%2F%2E%2E%2F%2E%2E%2Fgrafana%2Fconf%2F" }

        it "raises an exception" do
          expect { uploader.secret }.to raise_error(described_class::InvalidSecret)
        end
      end
191
192
193
    end
  end

194
195
  describe "#migrate!" do
    before do
196
      uploader.store!(fixture_file_upload('spec/fixtures/dk.png'))
197
      stub_uploads_object_storage
198
    end
199

200
201
    it_behaves_like "migrates", to_store: described_class::Store::REMOTE
    it_behaves_like "migrates", from_store: described_class::Store::REMOTE, to_store: described_class::Store::LOCAL
202
  end
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

  describe '#upload=' do
    let(:secret) { SecureRandom.hex }
    let(:upload) { create(:upload, :issuable_upload, secret: secret, filename: 'file.txt') }

    it 'handles nil' do
      expect(uploader).not_to receive(:apply_context!)

      uploader.upload = nil
    end

    it 'extract the uploader context from it' do
      expect(uploader).to receive(:apply_context!).with(a_hash_including(secret: secret, identifier: 'file.txt'))

      uploader.upload = upload
    end
  end
220

221
222
223
224
225
226
227
228
  describe '#replace_file_without_saving!' do
    let(:replacement) { Tempfile.create('replacement.jpg') }

    it 'replaces an existing file without changing its metadata' do
      expect { subject.replace_file_without_saving! CarrierWave::SanitizedFile.new(replacement) }.not_to change { subject.upload }
    end
  end

229
230
  context 'when remote file is used' do
    let(:temp_file) { Tempfile.new("test") }
231

232
233
234
    let!(:fog_connection) do
      stub_uploads_object_storage(described_class)
    end
235

236
237
238
239
    let(:filename) { "my file.txt" }
    let(:uploaded_file) do
      UploadedFile.new(temp_file.path, filename: filename, remote_id: "test/123123")
    end
240

241
242
243
244
245
246
    let!(:fog_file) do
      fog_connection.directories.new(key: 'uploads').files.create(
        key: 'tmp/uploads/test/123123',
        body: 'content'
      )
    end
247

248
249
    before do
      FileUtils.touch(temp_file)
250

251
252
      uploader.store!(uploaded_file)
    end
253

254
255
256
    after do
      FileUtils.rm_f(temp_file)
    end
257

258
    describe '#cache!' do
259
260
261
262
263
264
265
266
267
268
269
      it 'file is stored remotely in permament location with sanitized name' do
        expect(uploader).to be_exists
        expect(uploader).not_to be_cached
        expect(uploader).not_to be_file_storage
        expect(uploader.path).not_to be_nil
        expect(uploader.path).not_to include('tmp/upload')
        expect(uploader.path).not_to include('tmp/cache')
        expect(uploader.url).to include('/my_file.txt')
        expect(uploader.object_store).to eq(described_class::Store::REMOTE)
      end
    end
270
271
272
273
274
275
276
277
278
279
280
281
282

    describe '#to_h' do
      subject { uploader.to_h }

      let(:filename) { 'my+file.txt' }

      it 'generates URL using original file name instead of filename returned by object storage' do
        # GCS returns a URL with a `+` instead of `%2B`
        allow(uploader.file).to receive(:url).and_return('https://storage.googleapis.com/gitlab-test-uploads/@hashed/6b/86/6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b/64c5065e62100b1a12841644256a98be/my+file.txt')

        expect(subject[:url]).to end_with(filename)
      end
    end
283
  end
284
end