resizing 1.2.1 → 1.3.1

data/test/resizing/carrier_wave_uploader_test.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Resizing
+  # Resizing::CarrierWave を include したアップローダ単体の挙動をテストする
+  # (モデルの保存・削除を伴う結合テストは carrier_wave_test.rb を参照)
+  class CarrierWaveUploaderTest < Minitest::Test
+    include VCRRequestAssertions
+    include ResizingTestConfiguration
+
+    IDENTIFIER = ResizingTestConfiguration::UPLOADED_IDENTIFIER
+
+    class TransformationUploader < ::CarrierWave::Uploader::Base
+      include Resizing::CarrierWave
+
+      process resize_to_fit: [100, 200]
+      process transformation: { quality: 80, fetch_format: 'webp' }
+    end
+
+    class FormatOverridesFetchFormatUploader < ::CarrierWave::Uploader::Base
+      include Resizing::CarrierWave
+
+      process transformation: { fetch_format: 'webp', format: 'png' }
+    end
+
+    class UnsupportedProcessorUploader < ::CarrierWave::Uploader::Base
+      include Resizing::CarrierWave
+
+      process convert: 'png'
+    end
+
+    class NoProcessorUploader < ::CarrierWave::Uploader::Base
+      include Resizing::CarrierWave
+    end
+
+    def setup
+      configure_resizing
+    end
+
+    def teardown
+      # NOP
+    end
+
+    def model_with_image(model_class = TestModel, identifier = IDENTIFIER)
+      model = model_class.new
+      model.send(:write_attribute, :resizing_picture, identifier)
+      model
+    end
+
+    # ============================================================
+    # include 時の設定
+    # ============================================================
+
+    def test_including_module_sets_remote_storage
+      assert_equal Resizing::CarrierWave::Storage::Remote, NoProcessorUploader.storage
+      assert_instance_of Resizing::CarrierWave::Storage::Remote, NoProcessorUploader.new.send(:storage)
+    end
+
+    def test_railtie_is_defined
+      assert Resizing::CarrierWave::Railtie < ::Rails::Railtie
+    end
+
+    # ============================================================
+    # transform_string
+    # ============================================================
+
+    def test_transform_string_for_resize_to_limit_without_height
+      assert_equal 'c_limit,w_1000', ResizingUploader.new.transform_string
+    end
+
+    def test_transform_string_for_version_with_resize_to_fill
+      assert_equal 'c_fill,w_40,h_40', TestModel.new.resizing_picture.versions[:small].transform_string
+    end
+
+    def test_transform_string_joins_multiple_processors_with_slash
+      assert_equal 'c_fit,w_100,h_200/q_80,f_webp', TransformationUploader.new.transform_string
+    end
+
+    def test_transform_string_format_takes_precedence_over_fetch_format
+      assert_equal 'f_png', FormatOverridesFetchFormatUploader.new.transform_string
+    end
+
+    def test_transform_string_is_empty_without_processors
+      assert_equal '', NoProcessorUploader.new.transform_string
+    end
+
+    def test_transform_string_raises_for_unsupported_processor
+      error = assert_raises(NotImplementedError) { UnsupportedProcessorUploader.new.transform_string }
+      assert_includes error.message, 'convert'
+    end
+
+    # ============================================================
+    # url
+    # ============================================================
+
+    def test_url_is_built_from_configured_image_host_and_column_value
+      model = model_with_image
+
+      assert_equal "http://192.168.56.101:5000#{IDENTIFIER}/", model.resizing_picture.url
+
+      # image_host を差し替えると URL も追従する (保存済みカラム値にはホストを含まない)
+      configure_resizing(image_host: 'https://cdn.example.com')
+      assert_equal "https://cdn.example.com#{IDENTIFIER}/", model.resizing_picture.url
+    end
+
+    def test_url_with_version_appends_transform_string
+      model = model_with_image
+
+      assert_equal "http://192.168.56.101:5000#{IDENTIFIER}/c_fill,w_40,h_40", model.resizing_picture.url(:small)
+    end
+
+    def test_url_accepts_string_version_name
+      model = model_with_image
+
+      assert_equal model.resizing_picture.url(:small), model.resizing_picture.url('small')
+    end
+
+    def test_url_raises_for_unknown_version
+      model = model_with_image
+
+      error = assert_raises(RuntimeError) { model.resizing_picture.url(:nope) }
+      assert_includes error.message, 'nope'
+      assert_includes error.message, 'small'
+    end
+
+    def test_url_returns_default_url_when_column_is_blank
+      assert_nil TestModel.new.resizing_picture.url
+      assert_equal 'http://example.com/test.jpg', TestModelWithDefaultURL.new.resizing_picture.url
+    end
+
+    def test_url_ignores_version_when_column_is_blank
+      # カラムが空なら version 指定があっても default_url を返す
+      assert_nil TestModel.new.resizing_picture.url(:small)
+    end
+
+    def test_model_url_helper_delegates_to_uploader_url
+      model = model_with_image
+
+      assert_equal model.resizing_picture.url, model.resizing_picture_url
+      assert_equal model.resizing_picture.url(:small), model.resizing_picture_url(:small)
+    end
+
+    # ============================================================
+    # identifier / filename / file
+    # ============================================================
+
+    def test_filename_and_identifier_return_column_value
+      model = model_with_image
+
+      assert_equal IDENTIFIER, model.resizing_picture.filename
+      assert_equal IDENTIFIER, model.resizing_picture.identifier
+    end
+
+    def test_file_reflects_column_value
+      model = model_with_image
+      file = model.resizing_picture.file
+
+      assert_instance_of Resizing::CarrierWave::Storage::File, file
+      assert_equal IDENTIFIER, file.public_id.to_s
+      assert_equal IDENTIFIER, file.path
+    end
+
+    def test_uploader_is_present_when_column_has_value
+      model = model_with_image
+
+      assert model.resizing_picture.present?
+      refute model.resizing_picture.blank?
+    end
+
+    # ============================================================
+    # cache! / store_versions! / remove_versions! / rename
+    # ============================================================
+
+    def test_cache_with_nil_does_nothing
+      uploader = TestModel.new.resizing_picture
+
+      assert_vcr_no_requests 'carrier_wave_test/save' do
+        assert_nil uploader.cache!(nil)
+      end
+      assert_nil uploader.file
+    end
+
+    def test_store_versions_and_remove_versions_are_noop
+      uploader = TestModel.new.resizing_picture
+
+      assert_nil uploader.store_versions!
+      assert_nil uploader.remove_versions!
+    end
+
+    def test_rename_raises_not_implemented_error
+      assert_raises(NotImplementedError) { TestModel.new.resizing_picture.rename }
+    end
+
+    # ============================================================
+    # format
+    # ============================================================
+
+    def test_format_related_methods_default_to_nil
+      uploader = TestModel.new.resizing_picture
+
+      assert_nil uploader.requested_format
+      assert_nil uploader.default_format
+      assert_nil uploader.format
+    end
+
+    def test_format_uses_overridden_default_format
+      assert_equal 'jpg', TestJPGModel.new.resizing_picture.format
+    end
+  end
+end

data/test/resizing/client_test.rb

@@ -4,23 +4,14 @@ require 'test_helper'
 
 module Resizing
   class ClientTest < Minitest::Test
-    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
-      }
-    end
+    include ResizingTestConfiguration
 
     def teardown
       # NOP
     end
 
     def test_is_initialized
-      Resizing.configure = @configuration_template
+      Resizing.configure = configuration_template
 
       client = Resizing::Client.new
       assert(!client.config.nil?)
@@ -28,14 +19,14 @@ module Resizing
     end
 
     def test_is_initialized_with_configuration
-      config = Resizing::Configuration.new(@configuration_template)
+      config = Resizing::Configuration.new(configuration_template)
       client = Resizing::Client.new(config)
       assert(!client.config.nil?)
       assert_equal(client.config, config)
     end
 
     def test_is_postable_with_filename
-      Resizing.configure = @configuration_template
+      Resizing.configure = configuration_template
 
       client = Resizing::Client.new
       VCR.use_cassette 'client/post', record: :once do
@@ -53,7 +44,7 @@ module Resizing
     end
 
     def test_is_unpostable_with_filename
-      Resizing.configure = @configuration_template
+      Resizing.configure = configuration_template
 
       client = Resizing::Client.new
       VCR.use_cassette 'client/post', record: :once do
@@ -64,7 +55,7 @@ module Resizing
     end
 
     def test_is_postable_with_file
-      Resizing.configure = @configuration_template
+      Resizing.configure = configuration_template
 
       client = Resizing::Client.new
       VCR.use_cassette 'client/post', record: :once do
@@ -83,7 +74,7 @@ module Resizing
     end
 
     def test_is_timeout_with_post_method
-      Resizing.configure = @configuration_template.merge(project_id: 'timeout_project_id')
+      Resizing.configure = configuration_template.merge(project_id: 'timeout_project_id')
 
       client = Resizing::Client.new
       f = File.open('test/data/images/sample1.jpg', 'r')
@@ -93,7 +84,7 @@ module Resizing
     end
 
     def test_is_putable_file
-      Resizing.configure = @configuration_template
+      Resizing.configure = configuration_template
 
       client = Resizing::Client.new
       VCR.use_cassette 'client/put', record: :once do
@@ -115,7 +106,7 @@ module Resizing
     end
 
     def test_is_timeout_with_put_method
-      Resizing.configure = @configuration_template.merge(project_id: 'timeout_project_id')
+      Resizing.configure = configuration_template.merge(project_id: 'timeout_project_id')
 
       client = Resizing::Client.new
       name = 'AWEaewfAreaweFAFASfwe'
@@ -127,7 +118,7 @@ module Resizing
     end
 
     def test_raise_error
-      Resizing.configure = @configuration_template
+      Resizing.configure = configuration_template
 
       client = Resizing::Client.new
       VCR.use_cassette 'client/error', record: :once do
@@ -139,7 +130,7 @@ module Resizing
     end
 
     def test_handleable_response_body_from_resizing
-      Resizing.configure = @configuration_template
+      Resizing.configure = configuration_template
 
       client = Resizing::Client.new
       VCR.use_cassette 'client/error', record: :once do
@@ -159,7 +150,7 @@ module Resizing
     def test_get_the_metadata
       # TODO
 
-      Resizing.configure = @configuration_template
+      Resizing.configure = configuration_template
 
       client = Resizing::Client.new
       VCR.use_cassette 'client/metadata', record: :once do
@@ -202,7 +193,7 @@ module Resizing
     end
 
     def test_get_raises_not_implemented_error
-      Resizing.configure = @configuration_template
+      Resizing.configure = configuration_template
       client = Resizing::Client.new
 
       assert_raises NotImplementedError do
@@ -211,7 +202,7 @@ module Resizing
     end
 
     def test_post_raises_error_without_content_type
-      Resizing.configure = @configuration_template
+      Resizing.configure = configuration_template
       client = Resizing::Client.new
 
       assert_raises ArgumentError do
@@ -220,7 +211,7 @@ module Resizing
     end
 
     def test_post_raises_error_with_invalid_io
-      Resizing.configure = @configuration_template
+      Resizing.configure = configuration_template
       client = Resizing::Client.new
 
       assert_raises ArgumentError do
@@ -229,12 +220,320 @@ module Resizing
     end
 
     def test_put_raises_error_without_content_type
-      Resizing.configure = @configuration_template
+      Resizing.configure = configuration_template
       client = Resizing::Client.new
 
       assert_raises ArgumentError do
         client.put('image_id', 'test/data/images/sample1.jpg', {})
       end
     end
+
+    # ============================================================
+    # 偽 HTTP クライアントを使ったリクエスト内容・レスポンス処理のテスト
+    # VCR カセットでは表現しづらい (URL, ヘッダ, multipart パラメータ, 異常系ステータス) を検証する
+    # ============================================================
+
+    # Faraday::Connection の代わりに使う偽クライアント
+    # 発行されたリクエスト (メソッド, URL, パラメータ, ヘッダ) を記録し、あらかじめ設定したレスポンスを返す
+    class FakeHttpClient
+      FakeRequest = Struct.new(:headers)
+      FakeResponse = Struct.new(:status, :body)
+
+      attr_reader :requests
+
+      def initialize(status: 200, body: '{}', respond_with_nil: false)
+        @response = respond_with_nil ? nil : FakeResponse.new(status, body)
+        @requests = []
+      end
+
+      %i[post put delete get].each do |verb|
+        define_method(verb) do |url, params = nil, &block|
+          request = FakeRequest.new({})
+          block&.call(request)
+          @requests << { method: verb, url: url, params: params, headers: request.headers }
+          @response
+        end
+      end
+
+      def last_request
+        @requests.last
+      end
+    end
+
+    def client_with_fake_http(**fake_options)
+      Resizing.configure = configuration_template
+      client = Resizing::Client.new
+      fake = FakeHttpClient.new(**fake_options)
+      client.instance_variable_set(:@http_client, fake)
+      [client, fake]
+    end
+
+    def base_url
+      "#{configuration_template[:image_host]}/projects/#{configuration_template[:project_id]}/upload/images"
+    end
+
+    def sample_path
+      'test/data/images/sample1.jpg'
+    end
+
+    def not_found_body(image_id)
+      %({"error":"ActiveRecord::RecordNotFound","message":"Upload::Image##{image_id} not found(no record)"})
+    end
+
+    def forbidden_body
+      '{"error":"AuthenticatableSecretToken::SecretTokenError","message":"invalid token is found"}'
+    end
+
+    def test_post_sends_multipart_image_to_upload_url_with_auth_header
+      client, fake = client_with_fake_http(body: '{"id":"posted"}')
+
+      Timecop.freeze do
+        result = client.post(sample_path, content_type: 'image/jpeg')
+
+        request = fake.last_request
+        assert_equal :post, request[:method]
+        assert_equal "#{base_url}/", request[:url]
+        assert_equal client.config.generate_auth_header, request[:headers]['X-ResizingToken']
+
+        part = request[:params][:image]
+        assert_instance_of Faraday::Multipart::FilePart, part
+        assert_equal 'image/jpeg', part.content_type
+        assert_equal 'sample1.jpg', part.original_filename
+
+        assert_equal({ 'id' => 'posted' }, result)
+      end
+    end
+
+    def test_post_uses_filename_option_over_path_basename
+      client, fake = client_with_fake_http
+
+      client.post(sample_path, content_type: 'image/jpeg', filename: 'renamed.jpg')
+
+      assert_equal 'renamed.jpg', fake.last_request[:params][:image].original_filename
+    end
+
+    def test_post_accepts_io_like_object
+      client, fake = client_with_fake_http
+      io = StringIO.new(File.binread(sample_path))
+
+      client.post(io, content_type: 'image/png', filename: 'from_io.png')
+
+      part = fake.last_request[:params][:image]
+      assert_same io, part.io
+      assert_equal 'image/png', part.content_type
+      assert_equal 'from_io.png', part.original_filename
+    end
+
+    def test_post_accepts_created_status
+      client, = client_with_fake_http(status: 201, body: '{"id":"created"}')
+
+      assert_equal({ 'id' => 'created' }, client.post(sample_path, content_type: 'image/jpeg'))
+    end
+
+    def test_post_raises_api_error_with_server_message_on_error_status
+      client, = client_with_fake_http(status: 403, body: forbidden_body)
+
+      error = assert_raises(Resizing::APIError) { client.post(sample_path, content_type: 'image/jpeg') }
+
+      assert_equal 'invalid token is found', error.message
+      assert_equal JSON.parse(forbidden_body), error.decoded_body
+    end
+
+    def test_post_raises_api_error_on_not_found
+      client, = client_with_fake_http(status: 404, body: not_found_body('x'))
+
+      assert_raises(Resizing::APIError) { client.post(sample_path, content_type: 'image/jpeg') }
+    end
+
+    def test_post_raises_api_error_with_status_code_when_body_is_not_json
+      client, = client_with_fake_http(status: 502, body: '<html>Bad Gateway</html>')
+
+      error = assert_raises(Resizing::APIError) { client.post(sample_path, content_type: 'image/jpeg') }
+
+      assert_equal 'invalid http status code 502', error.message
+      assert_equal({}, error.decoded_body)
+    end
+
+    def test_post_raises_api_error_when_response_is_nil
+      client, = client_with_fake_http(respond_with_nil: true)
+
+      error = assert_raises(Resizing::APIError) { client.post(sample_path, content_type: 'image/jpeg') }
+      assert_equal 'No response is returned', error.message
+    end
+
+    def test_put_sends_multipart_image_to_image_url_with_auth_header
+      client, fake = client_with_fake_http(body: '{"id":"img-1"}')
+
+      result = client.put('img-1', sample_path, content_type: 'image/jpeg')
+
+      request = fake.last_request
+      assert_equal :put, request[:method]
+      assert_equal "#{base_url}/img-1", request[:url]
+      assert_match(/\Av1,\d+,[0-9a-f]{64}\z/, request[:headers]['X-ResizingToken'])
+      part = request[:params][:image]
+      assert_instance_of Faraday::Multipart::FilePart, part
+      assert_equal 'image/jpeg', part.content_type
+      assert_equal 'sample1.jpg', part.original_filename
+      assert_equal({ 'id' => 'img-1' }, result)
+    end
+
+    def test_put_raises_api_error_on_error_status
+      client, = client_with_fake_http(status: 403, body: forbidden_body)
+
+      error = assert_raises(Resizing::APIError) { client.put('img-1', sample_path, content_type: 'image/jpeg') }
+      assert_equal 'invalid token is found', error.message
+    end
+
+    def test_put_raises_error_with_invalid_io
+      Resizing.configure = configuration_template
+      client = Resizing::Client.new
+
+      assert_raises ArgumentError do
+        client.put('image_id', 12_345, content_type: 'image/jpeg')
+      end
+    end
+
+    def test_delete_sends_delete_request_to_image_url_with_auth_header
+      client, fake = client_with_fake_http(body: '{"id":"img-1"}')
+
+      result = client.delete('img-1')
+
+      request = fake.last_request
+      assert_equal :delete, request[:method]
+      assert_equal "#{base_url}/img-1", request[:url]
+      assert_match(/\Av1,\d+,[0-9a-f]{64}\z/, request[:headers]['X-ResizingToken'])
+      assert_equal({ 'id' => 'img-1' }, result)
+    end
+
+    def test_delete_returns_error_body_without_raising_on_not_found
+      client, = client_with_fake_http(status: 404, body: not_found_body('img-1'))
+
+      result = client.delete('img-1')
+
+      assert_equal 'ActiveRecord::RecordNotFound', result['error']
+    end
+
+    def test_delete_raises_api_error_on_other_error_status
+      client, = client_with_fake_http(status: 403, body: forbidden_body)
+
+      error = assert_raises(Resizing::APIError) { client.delete('img-1') }
+      assert_equal 'invalid token is found', error.message
+    end
+
+    def test_delete_raises_api_error_when_response_is_nil
+      client, = client_with_fake_http(respond_with_nil: true)
+
+      assert_raises(Resizing::APIError) { client.delete('img-1') }
+    end
+
+    def test_metadata_sends_get_request_to_metadata_url_with_auth_header
+      client, fake = client_with_fake_http(body: '{"id":"img-1","width":100}')
+
+      result = client.metadata('img-1')
+
+      request = fake.last_request
+      assert_equal :get, request[:method]
+      assert_equal "#{base_url}/img-1/metadata", request[:url]
+      assert_match(/\Av1,\d+,[0-9a-f]{64}\z/, request[:headers]['X-ResizingToken'])
+      assert_equal({ 'id' => 'img-1', 'width' => 100 }, result)
+    end
+
+    def test_metadata_returns_error_body_without_raising_on_not_found_by_default
+      client, = client_with_fake_http(status: 404, body: not_found_body('img-1'))
+
+      result = client.metadata('img-1')
+
+      assert_equal 'ActiveRecord::RecordNotFound', result['error']
+    end
+
+    def test_metadata_raises_api_error_on_not_found_when_requested
+      client, = client_with_fake_http(status: 404, body: not_found_body('img-1'))
+
+      error = assert_raises(Resizing::APIError) { client.metadata('img-1', when_not_found: :raise) }
+
+      assert_equal 'Upload::Image#img-1 not found(no record)', error.message
+      assert_equal 'ActiveRecord::RecordNotFound', error.decoded_body['error']
+    end
+
+    def test_metadata_raises_api_error_on_other_error_status
+      client, = client_with_fake_http(status: 500, body: 'Internal Server Error')
+
+      error = assert_raises(Resizing::APIError) { client.metadata('img-1') }
+      assert_equal 'invalid http status code 500', error.message
+    end
+
+    def test_metadata_raises_api_error_when_response_is_nil
+      client, = client_with_fake_http(respond_with_nil: true)
+
+      assert_raises(Resizing::APIError) { client.metadata('img-1') }
+    end
+
+    # ============================================================
+    # VCR カセットを使った delete / timeout のテスト
+    # ============================================================
+
+    def test_is_deletable
+      # client/delete.yml は別プロジェクト ID で記録されている
+      Resizing.configure = configuration_template.merge(project_id: '098a2a0d-c387-4135-a071-1254d6d7e70a')
+      client = Resizing::Client.new
+      image_id = '28c49144-c00d-4cb5-8619-98ce95977b9c'
+
+      VCR.use_cassette 'client/delete', record: :none do
+        r = client.delete(image_id)
+
+        assert_equal image_id, r['id']
+        assert_equal '098a2a0d-c387-4135-a071-1254d6d7e70a', r['project_id']
+        assert_equal(
+          "/projects/098a2a0d-c387-4135-a071-1254d6d7e70a/upload/images/#{image_id}/v1Id850__tqNsnoGWWUibtIBZ5NgjV45M",
+          r['public_id']
+        )
+      end
+    end
+
+    def test_is_timeout_with_delete_method
+      Resizing.configure = configuration_template.merge(project_id: 'timeout_project_id')
+      client = Resizing::Client.new
+
+      assert_raises Resizing::APIError do
+        client.delete('some_image_id')
+      end
+    end
+
+    def test_is_timeout_with_metadata_method
+      Resizing.configure = configuration_template.merge(project_id: 'timeout_project_id')
+      client = Resizing::Client.new
+
+      assert_raises Resizing::APIError do
+        client.metadata('some_image_id')
+      end
+    end
+
+    # ============================================================
+    # 設定の受け渡し
+    # ============================================================
+
+    def test_is_initialized_with_hash
+      client = Resizing::Client.new(configuration_template)
+
+      assert_equal Resizing::Configuration.new(configuration_template), client.config
+    end
+
+    def test_each_client_instance_keeps_its_own_configuration
+      Resizing.configure = configuration_template
+      other = Resizing::Client.new(configuration_template.merge(project_id: 'other-project'))
+
+      assert_equal 'other-project', other.config.project_id
+      assert_equal configuration_template[:project_id], Resizing::Client.new.config.project_id
+    end
+
+    def test_client_uses_configuration_at_instantiation
+      Resizing.configure = configuration_template
+      client = Resizing::Client.new
+
+      # インスタンス生成後にグローバル設定を差し替えても既存クライアントには影響しない
+      Resizing.configure = configuration_template.merge(project_id: 'replaced-project')
+
+      assert_equal configuration_template[:project_id], client.config.project_id
+    end
   end
 end