resizing 1.2.1 → 1.3.1

data/test/resizing/carrier_wave/storage/remote_test.rb

@@ -6,16 +6,11 @@ module Resizing
   module CarrierWave
     module Storage
       class RemoteTest < Minitest::Test
+        include FakeApiClientAssertions
+        include ResizingTestConfiguration
+
         def setup
-          @configuration_template = {
-            image_host: 'http://192.168.56.101:5000',
-            video_host: 'http://192.168.56.101:5000',
-            project_id: 'e06e710d-f026-4dcf-b2c0-eab0de8bb83f',
-            secret_token: 'ewbym2r1pk49x1d2lxdbiiavnqp25j2kh00hsg3koy0ppm620x5mhlmgl3rq5ci8',
-            open_timeout: 10,
-            response_timeout: 20
-          }
-          Resizing.configure = @configuration_template
+          configure_resizing
 
           model = TestModel.new
           @uploader = model.resizing_picture
@@ -69,6 +64,93 @@ module Resizing
           assert_instance_of Resizing::CarrierWave::Storage::File, result
           assert_equal identifier, result.public_id.to_s
         end
+
+        IDENTIFIER = '/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/14ea7aac-a194-4330-931f-6b562aec413d/v_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e'
+
+        def test_store_uploads_and_returns_file_with_public_id
+          VCR.use_cassette 'carrier_wave_test/save', record: :none do
+            file = @storage.store!(::File.open('test/data/images/sample1.jpg', 'r'))
+
+            assert_instance_of Resizing::CarrierWave::Storage::File, file
+            assert_equal IDENTIFIER, file.public_id.to_s
+            assert_equal 'image/jpeg', file.content_type
+          end
+
+          assert_equal IDENTIFIER, @uploader.model.read_attribute(:resizing_picture)
+        end
+
+        def test_cache_uploads_immediately_like_store
+          # Resizing はキャッシュをサポートしないため cache! でも直接アップロードする
+          VCR.use_cassette 'carrier_wave_test/save', record: :none do
+            file = @storage.cache!(::File.open('test/data/images/sample1.jpg', 'r'))
+
+            assert_instance_of Resizing::CarrierWave::Storage::File, file
+            assert_equal IDENTIFIER, file.public_id.to_s
+          end
+
+          assert_equal IDENTIFIER, @uploader.model.read_attribute(:resizing_picture)
+        end
+
+        def test_retrieve_returns_new_file_instance_each_time
+          first = @storage.retrieve!(IDENTIFIER)
+          second = @storage.retrieve!(IDENTIFIER)
+
+          refute_same first, second
+          assert_equal first.public_id.to_s, second.public_id.to_s
+        end
+
+        IMAGE_ID = '14ea7aac-a194-4330-931f-6b562aec413d'
+        OTHER_IDENTIFIER = '/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/new-image-id-2222-2222-222222222222/v2'
+
+        def test_remove_deletes_the_image_stored_in_the_model_column
+          model = @uploader.model
+          model.send(:write_attribute, :resizing_picture, IDENTIFIER)
+
+          file = with_fake_api_client({ 'id' => IMAGE_ID }) do |fake|
+            result = @storage.remove!(nil)
+            assert_equal [IMAGE_ID], fake.deleted_ids
+            result
+          end
+
+          assert_instance_of Resizing::CarrierWave::Storage::File, file
+          assert_nil model.read_attribute(:resizing_picture)
+        end
+
+        def test_remove_accepts_a_carrier_wave_file_argument
+          # CarrierWave が storage.remove!(file) 経由で呼ぶ場合も ArgumentError にならないこと
+          model = @uploader.model
+          model.send(:write_attribute, :resizing_picture, IDENTIFIER)
+
+          with_fake_api_client({ 'id' => IMAGE_ID }) do |fake|
+            file = @uploader.file
+            result = @storage.remove!(file)
+
+            assert_equal [IMAGE_ID], fake.deleted_ids
+            assert_same file, result
+          end
+
+          assert_nil model.read_attribute(:resizing_picture)
+        end
+
+        def test_remove_deletes_the_given_file_not_the_current_column_value
+          # 画像更新後に古い画像を消す場合: 削除対象は渡された file、カラムは新しい画像のまま
+          model = @uploader.model
+          model.send(:write_attribute, :resizing_picture, OTHER_IDENTIFIER)
+          file = Resizing::CarrierWave::Storage::File.new(@uploader, IDENTIFIER)
+
+          with_fake_api_client({ 'id' => IMAGE_ID }) do |fake|
+            @storage.remove!(file)
+
+            assert_equal [IMAGE_ID], fake.deleted_ids
+          end
+
+          assert_equal OTHER_IDENTIFIER, model.read_attribute(:resizing_picture)
+        end
+
+        def test_storage_is_subclass_of_carrierwave_abstract_storage
+          assert Remote < ::CarrierWave::Storage::Abstract
+          assert_same @uploader, @storage.uploader
+        end
       end
     end
   end

data/test/resizing/carrier_wave_cache_callbacks_test.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Resizing
+  # Resizing::CarrierWave#cache! が CarrierWave の :cache コールバックを通すことをテストする
+  #
+  # - before :cache のチェック (拡張子 / content_type / サイズ) はアップロード前に働く
+  # - process! と cache_versions! は Resizing の設計に合わないので発火しない
+  class CarrierWaveCacheCallbacksTest < Minitest::Test
+    include VCRRequestAssertions
+    include ResizingTestConfiguration
+
+    def setup
+      TestModel.delete_all
+      configure_resizing
+    end
+
+    def teardown; end
+
+    # ============================================================
+    # before :cache のチェックが働くこと (アップロードされない)
+    # ============================================================
+
+    def test_extension_allowlist_rejects_file_without_uploading
+      assert_rejected_before_upload TestModelWithExtensionAllowlist
+    end
+
+    def test_extension_denylist_rejects_file_without_uploading
+      assert_rejected_before_upload TestModelWithExtensionDenylist
+    end
+
+    def test_content_type_allowlist_rejects_file_without_uploading
+      assert_rejected_before_upload TestModelWithContentTypeAllowlist
+    end
+
+    def test_size_range_rejects_file_without_uploading
+      assert_rejected_before_upload TestModelWithSizeRange
+    end
+
+    def test_cache_raises_integrity_error_when_called_directly
+      model = TestModelWithExtensionAllowlist.new
+      uploader = ResizingUploaderWithExtensionAllowlist.new(model, :resizing_picture)
+
+      assert_vcr_no_requests 'carrier_wave_test/save' do
+        assert_raises(::CarrierWave::IntegrityError) { uploader.cache!(sample_uploaded_file) }
+      end
+
+      assert_nil model.read_attribute(:resizing_picture)
+    end
+
+    def test_cache_ignores_empty_file
+      # 中身のないファイルは CarrierWave 本体の cache! と同じくアップロードしない
+      model = TestModel.new
+      uploader = ResizingUploader.new(model, :resizing_picture)
+
+      assert_vcr_no_requests 'carrier_wave_test/save' do
+        assert_nil uploader.cache!(StringIO.new(''))
+      end
+
+      assert_nil model.read_attribute(:resizing_picture)
+    end
+
+    # ============================================================
+    # 拡張子のチェックが content_type から判定されること
+    # ============================================================
+
+    # Resizing の公開 URL は末尾がバージョン文字列 (`/v<version>`) で、ドットを含むため
+    # ファイル名から取れる「拡張子」はバージョンの一部 (`Fv_Q`) になる
+    # (ダウンロードは差し替えるので、URL の中身は実在しなくてよい)
+    RESIZING_IMAGE_URL = "#{ResizingTestConfiguration::CONFIGURATION_TEMPLATE[:image_host]}" \
+                         "/projects/#{ResizingTestConfiguration::CONFIGURATION_TEMPLATE[:project_id]}" \
+                         '/upload/images/3f2c9d1e-5b7a-4e8c-9a0d-6c1b2e3f4a5d/v0cRq7Yb2mZt9LxA3wN8eKd5pHs1.Fv_Q'.freeze
+
+    def test_remote_resizing_url_is_accepted_by_content_type
+      # `remote_<column>_url=` に Resizing の URL を渡した場合、ファイル名の拡張子 (Fv_Q) ではなく
+      # レスポンスの Content-Type (image/jpeg) で判定され、アップロードされる
+      model = TestModelWithJpegAllowlist.new
+      remote_file = sample_remote_file(RESIZING_IMAGE_URL, content_type: 'image/jpeg')
+
+      assert_vcr_requests_count 'carrier_wave_test/save', 1 do
+        with_stubbed_download(remote_file) do
+          model.remote_resizing_picture_url = RESIZING_IMAGE_URL
+        end
+      end
+
+      assert model.valid?, model.errors.full_messages.join(', ')
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+    end
+
+    def test_remote_file_is_rejected_when_content_type_is_not_allowed
+      # Content-Type が image/png なら、拡張子の許可リスト (jpg / jpeg) に合わないので拒否される
+      model = TestModelWithJpegAllowlist.new
+      remote_file = sample_remote_file(RESIZING_IMAGE_URL, content_type: 'image/png')
+
+      assert_vcr_no_requests 'carrier_wave_test/save' do
+        with_stubbed_download(remote_file) do
+          model.remote_resizing_picture_url = RESIZING_IMAGE_URL
+        end
+      end
+
+      refute model.valid?
+      refute_empty model.errors[:resizing_picture]
+      assert_nil model.read_attribute(:resizing_picture)
+    end
+
+    def test_extension_of_file_name_is_used_when_content_type_is_unknown
+      # application/octet-stream は型の情報を持たないので、ファイル名の拡張子 (jpg) で判定される
+      model = TestModelWithJpegAllowlist.new
+      url = 'https://example.com/images/photo.jpg'
+      remote_file = sample_remote_file(url, content_type: 'application/octet-stream')
+
+      assert_vcr_requests_count 'carrier_wave_test/save', 1 do
+        with_stubbed_download(remote_file) do
+          model.remote_resizing_picture_url = url
+        end
+      end
+
+      assert model.valid?, model.errors.full_messages.join(', ')
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+    end
+
+    def test_extension_of_file_name_is_used_when_content_type_is_not_registered
+      # MIME::Types / MiniMime に登録されていない content_type でもエラーにならず、
+      # ファイル名の拡張子 (jpg) で判定される
+      model = TestModelWithJpegAllowlist.new
+      url = 'https://example.com/images/photo.jpg'
+      remote_file = sample_remote_file(url, content_type: 'image/x-unregistered-type')
+
+      assert_vcr_requests_count 'carrier_wave_test/save', 1 do
+        with_stubbed_download(remote_file) do
+          model.remote_resizing_picture_url = url
+        end
+      end
+
+      assert model.valid?, model.errors.full_messages.join(', ')
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+    end
+
+    def test_content_type_parameters_are_ignored
+      # `image/jpeg; charset=binary` のようなパラメータ付きの値でも image/jpeg として判定される
+      model = TestModelWithJpegAllowlist.new
+      remote_file = sample_remote_file(RESIZING_IMAGE_URL, content_type: 'image/jpeg; charset=binary')
+
+      assert_vcr_requests_count 'carrier_wave_test/save', 1 do
+        with_stubbed_download(remote_file) do
+          model.remote_resizing_picture_url = RESIZING_IMAGE_URL
+        end
+      end
+
+      assert model.valid?, model.errors.full_messages.join(', ')
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+    end
+
+    def test_content_type_takes_precedence_over_extension_of_uploaded_file
+      # ローカルからのアップロードでも、ファイル名の拡張子 (jpg) より content_type (image/png) が優先される
+      model = TestModelWithJpegAllowlist.new
+      file = File.open('test/data/images/sample1.jpg', 'r')
+      uploaded_file = ActionDispatch::Http::UploadedFile.new(filename: 'sample1.jpg', type: 'image/png', tempfile: file)
+
+      assert_vcr_no_requests 'carrier_wave_test/save' do
+        model.resizing_picture = uploaded_file
+      end
+
+      refute model.valid?
+      assert_nil model.read_attribute(:resizing_picture)
+    end
+
+    def test_uploaded_file_matching_its_content_type_is_accepted
+      # 拡張子と content_type が一致する通常のアップロードは、これまで通り受け付けられる
+      model = TestModelWithJpegAllowlist.new
+
+      assert_vcr_requests_count 'carrier_wave_test/save', 1 do
+        model.resizing_picture = sample_uploaded_file
+      end
+
+      assert model.valid?, model.errors.full_messages.join(', ')
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+    end
+
+    # ============================================================
+    # Resizing の設計に合わないコールバックが発火しないこと
+    # ============================================================
+
+    def test_versions_are_not_uploaded_again
+      # ResizingUploader は version :small を持つが、version は配信時に変換されるので
+      # cache_versions! による追加アップロードは発生しない
+      model = TestModel.new
+
+      assert_vcr_requests_count 'carrier_wave_test/save', 1 do
+        model.resizing_picture = sample_uploaded_file
+      end
+
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+    end
+
+    def test_processors_are_not_executed_on_upload
+      # process は配信 URL の transform 定義なので、uploader のメソッドとしては存在しない。
+      # process! が発火すると NoMethodError になる
+      model = TestModelWithUndefinedProcessor.new
+
+      assert_vcr_requests_count 'carrier_wave_test/save', 1 do
+        model.resizing_picture = sample_uploaded_file
+      end
+
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+    end
+
+    private
+
+    # 画像の代入時に POST が発行されず、モデルが integrity error で invalid になることを確認する
+    def assert_rejected_before_upload(model_class)
+      model = model_class.new
+
+      assert_vcr_no_requests 'carrier_wave_test/save' do
+        model.resizing_picture = sample_uploaded_file
+      end
+
+      refute model.valid?, "#{model_class} should be invalid after the file was rejected"
+      refute_empty model.errors[:resizing_picture]
+      assert_nil model.read_attribute(:resizing_picture)
+    end
+  end
+end

data/test/resizing/carrier_wave_callback_file_test.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Resizing
+  # :cache コールバックに渡されるファイル (CallbackFile) の拡張子が content_type から決まることをテストする
+  class CarrierWaveCallbackFileTest < Minitest::Test
+    # Resizing の公開 URL の最後のセグメント (バージョン文字列)。ドットを含むので
+    # ファイル名としては `Fv_Q` が拡張子に見える
+    RESIZING_FILENAME = 'v0cRq7Yb2mZt9LxA3wN8eKd5pHs1.Fv_Q'
+
+    def test_original_filename_is_nil_when_the_file_has_no_name
+      file = Resizing::CarrierWave::CallbackFile.new(StringIO.new('data'))
+
+      assert_nil file.original_filename
+      assert_nil file.extension
+    end
+
+    def test_extension_follows_the_content_type
+      file = build_file(RESIZING_FILENAME, 'image/jpeg')
+
+      assert_equal 'v0cRq7Yb2mZt9LxA3wN8eKd5pHs1.jpeg', file.original_filename
+      assert_equal 'jpeg', file.extension
+    end
+
+    def test_file_name_is_kept_when_its_extension_belongs_to_the_content_type
+      # jpg は image/jpeg の拡張子の一つなので、jpeg に付け替えられない (大文字小文字も区別しない)
+      file = build_file('photo.JPG', 'image/jpeg')
+
+      assert_equal 'photo.JPG', file.original_filename
+      assert_equal 'JPG', file.extension
+    end
+
+    def test_file_name_is_kept_when_the_content_type_is_not_registered
+      file = build_file('photo.jpg', 'image/x-unregistered-type')
+
+      assert_equal 'photo.jpg', file.original_filename
+    end
+
+    def test_mini_mime_is_used_when_mime_types_is_not_loaded
+      file = build_file(RESIZING_FILENAME, 'image/jpeg')
+
+      file.stub(:mime_types_available?, false) do
+        assert_equal 'v0cRq7Yb2mZt9LxA3wN8eKd5pHs1.jpeg', file.original_filename
+      end
+    end
+
+    def test_file_name_is_kept_when_mini_mime_does_not_know_the_content_type
+      file = build_file('photo.jpg', 'image/x-unregistered-type')
+
+      file.stub(:mime_types_available?, false) do
+        assert_equal 'photo.jpg', file.original_filename
+      end
+    end
+
+    def test_file_name_is_kept_when_no_lookup_library_is_loaded
+      file = build_file(RESIZING_FILENAME, 'image/jpeg')
+
+      file.stub(:mime_types_available?, false) do
+        file.stub(:mini_mime_available?, false) do
+          assert_equal RESIZING_FILENAME, file.original_filename
+        end
+      end
+    end
+
+    private
+
+    def build_file(filename, content_type)
+      uploaded_file = ActionDispatch::Http::UploadedFile.new(
+        filename: filename,
+        type: content_type,
+        tempfile: File.open('test/data/images/sample1.jpg', 'r')
+      )
+      Resizing::CarrierWave::CallbackFile.new(uploaded_file)
+    end
+  end
+end