resizing 1.2.2 → 1.3.1

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

data/test/resizing/carrier_wave_test.rb

@@ -5,20 +5,13 @@ require 'test_helper'
 module Resizing
   class CarrierWaveTest < Minitest::Test
     include VCRRequestAssertions
+    include ResizingTestConfiguration
 
     def setup
       TestModel.delete_all
       TestJPGModel.delete_all
 
-      @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
     end
 
     def teardown; end
@@ -163,11 +156,6 @@ module Resizing
       assert_instance_of Resizing::CarrierWave::Storage::File, file
     end
 
-    def expect_url
-      'http://192.168.56.101:5000/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/' \
-        'upload/images/14ea7aac-a194-4330-931f-6b562aec413d/v_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e'
-    end
-
     def prepare_model(model_class)
       result = nil
       VCR.use_cassette 'carrier_wave_test/save', record: :once do
@@ -177,18 +165,6 @@ module Resizing
       result
     end
 
-    # モデルにサンプル画像を添付するヘルパーメソッド
-    # VCRカセット内で呼び出す必要がある
-    def attach_sample_image(model)
-      file = File.open('test/data/images/sample1.jpg', 'r')
-      uploaded_file = ActionDispatch::Http::UploadedFile.new(
-        filename: File.basename(file.path),
-        type: 'image/jpeg',
-        tempfile: file
-      )
-      model.resizing_picture = uploaded_file
-    end
-
     # TestModelWithCallbackTracking 用のヘルパーメソッド
     def prepare_tracking_model
       prepare_model(TestModelWithCallbackTracking)
@@ -462,5 +438,204 @@ module Resizing
       # コールバックが正しい順序で呼ばれたことを確認
       assert_equal %i[before_destroy after_destroy destroy_commit], model.callback_log
     end
+
+    # ============================================================
+    # DB から再読込したモデルに対する操作 (retrieve_from_store! 経由)
+    # ============================================================
+
+    def test_url_of_freshly_loaded_model_matches_saved_url
+      model = prepare_model TestModel
+      model.save!
+
+      loaded = TestModel.find(model.id)
+
+      assert_equal "#{expect_url}/", loaded.resizing_picture_url
+      assert_equal "#{expect_url}/c_fill,w_40,h_40", loaded.resizing_picture_url(:small)
+      refute loaded.resizing_picture.blank?
+    end
+
+    def test_remove_on_freshly_loaded_model_deletes_remote_image_and_clears_column
+      model = prepare_model TestModel
+      model.save!
+
+      loaded = TestModel.find(model.id)
+
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        loaded.remove_resizing_picture!
+        loaded.save!
+      end
+
+      assert_nil loaded.read_attribute(:resizing_picture)
+      assert_nil loaded.resizing_picture_url
+      assert_nil TestModel.find(model.id).read_attribute(:resizing_picture)
+    end
+
+    def test_remove_flag_on_freshly_loaded_model_deletes_remote_image_and_clears_column
+      model = prepare_model TestModel
+      model.save!
+
+      loaded = TestModel.find(model.id)
+      loaded.remove_resizing_picture = true
+
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        loaded.save!
+      end
+
+      assert loaded.resizing_picture.blank?
+      assert_nil TestModel.find(model.id).read_attribute(:resizing_picture)
+    end
+
+    def test_destroy_on_freshly_loaded_model_deletes_remote_image
+      model = prepare_model TestModel
+      model.save!
+
+      loaded = TestModel.find(model.id)
+
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        ActiveRecord::Base.transaction do
+          loaded.destroy!
+        end
+      end
+
+      assert loaded.destroyed?
+      assert_nil TestModel.find_by(id: model.id)
+    end
+
+    def test_remove_persists_nil_to_database
+      model = prepare_model TestModel
+      model.save!
+
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        model.remove_resizing_picture!
+        model.save!
+      end
+
+      assert_nil TestModel.find(model.id).read_attribute(:resizing_picture)
+    end
+
+    # ============================================================
+    # 代入時の挙動
+    # ============================================================
+
+    def test_column_is_set_immediately_after_assignment
+      model = TestModel.new
+
+      assert_vcr_requests_made 'carrier_wave_test/save' do
+        attach_sample_image(model)
+      end
+
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+      assert_equal expect_identifier, model.resizing_picture.identifier
+      assert_equal expect_identifier, model.resizing_picture.file.public_id.to_s
+      assert_equal 'image/jpeg', model.resizing_picture.file.content_type
+      assert model.resizing_picture.present?
+    end
+
+    def test_save_after_assignment_does_not_upload_again
+      model = prepare_model TestModel
+
+      # 代入時に既にアップロード済みなので、save! で再度 POST は発行されない
+      assert_vcr_no_requests 'carrier_wave_test/save' do
+        model.save!
+      end
+
+      assert_equal expect_identifier, TestModel.find(model.id).read_attribute(:resizing_picture)
+    end
+
+    def test_assigning_nil_keeps_existing_image
+      model = prepare_model TestModel
+      model.save!
+
+      assert_vcr_no_requests 'carrier_wave_test/save' do
+        model.resizing_picture = nil
+        model.save!
+      end
+
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+      assert_equal "#{expect_url}/", model.resizing_picture_url
+    end
+
+    def test_assigning_blank_string_keeps_existing_image
+      model = prepare_model TestModel
+      model.save!
+
+      assert_vcr_no_requests 'carrier_wave_test/save' do
+        model.resizing_picture = ''
+        model.save!
+      end
+
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+    end
+
+    def test_assigning_plain_file_object_uploads_image
+      model = TestModel.new
+
+      assert_vcr_requests_made 'carrier_wave_test/save' do
+        model.resizing_picture = File.open('test/data/images/sample1.jpg', 'r')
+      end
+
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+    end
+
+    def test_default_url_is_returned_after_remove
+      TestModelWithDefaultURL.delete_all
+      model = prepare_model TestModelWithDefaultURL
+      model.save!
+      refute_equal 'http://example.com/test.jpg', model.resizing_picture_url
+
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        model.remove_resizing_picture!
+        model.save!
+      end
+
+      assert_equal 'http://example.com/test.jpg', model.resizing_picture_url
+    end
+
+    # ============================================================
+    # 画像更新時の永続化
+    # ============================================================
+
+    def test_updated_image_is_persisted_and_old_image_deleted
+      # update_image カセット: POST(old) -> POST(new) -> DELETE(old)
+      model = nil
+      assert_vcr_requests_made 'carrier_wave_test/update_image' do
+        model = TestModel.new
+        model.resizing_picture = File.open('test/data/images/sample1.jpg', 'r')
+        model.save!
+
+        model.resizing_picture = File.open('test/data/images/sample1.jpg', 'r')
+        ActiveRecord::Base.transaction do
+          model.save!
+        end
+      end
+
+      loaded = TestModel.find(model.id)
+      assert_equal(
+        '/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/new-image-id-2222-2222-222222222222/v2',
+        loaded.read_attribute(:resizing_picture)
+      )
+      assert_equal(
+        'http://192.168.56.101:5000/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/new-image-id-2222-2222-222222222222/v2/',
+        loaded.resizing_picture_url
+      )
+    end
+
+    def test_previous_changes_after_update_records_old_and_new_identifier
+      model = nil
+      assert_vcr_requests_made 'carrier_wave_test/update_image' do
+        model = TestModel.new
+        model.resizing_picture = File.open('test/data/images/sample1.jpg', 'r')
+        model.save!
+
+        model.resizing_picture = File.open('test/data/images/sample1.jpg', 'r')
+        ActiveRecord::Base.transaction do
+          model.save!
+        end
+      end
+
+      old_value, new_value = model.previous_changes['resizing_picture']
+      assert_match(/old-image-id/, old_value)
+      assert_match(/new-image-id/, new_value)
+    end
   end
 end