path: root/activesupport/test/caching_test.rb

require 'logger'
require 'abstract_unit'
require 'active_support/cache'

class CacheKeyTest < ActiveSupport::TestCase
  def test_expand_cache_key
    assert_equal 'name/1/2/true', ActiveSupport::Cache.expand_cache_key([1, '2', true], :name)
  end
end

class CacheStoreSettingTest < ActiveSupport::TestCase
  def test_file_fragment_cache_store
    store = ActiveSupport::Cache.lookup_store :file_store, "/path/to/cache/directory"
    assert_kind_of(ActiveSupport::Cache::FileStore, store)
    assert_equal "/path/to/cache/directory", store.cache_path
  end

  def test_mem_cache_fragment_cache_store
    MemCache.expects(:new).with(%w[localhost], {})
    store = ActiveSupport::Cache.lookup_store :mem_cache_store, "localhost"
    assert_kind_of(ActiveSupport::Cache::MemCacheStore, store)
  end

  def test_mem_cache_fragment_cache_store_with_given_mem_cache
    mem_cache = MemCache.new
    MemCache.expects(:new).never
    store = ActiveSupport::Cache.lookup_store :mem_cache_store, mem_cache
    assert_kind_of(ActiveSupport::Cache::MemCacheStore, store)
  end

  def test_mem_cache_fragment_cache_store_with_given_mem_cache_like_object
    MemCache.expects(:new).never
    memcache = Object.new
    def memcache.get() true end
    store = ActiveSupport::Cache.lookup_store :mem_cache_store, memcache
    assert_kind_of(ActiveSupport::Cache::MemCacheStore, store)
  end

  def test_mem_cache_fragment_cache_store_with_multiple_servers
    MemCache.expects(:new).with(%w[localhost 192.168.1.1], {})
    store = ActiveSupport::Cache.lookup_store :mem_cache_store, "localhost", '192.168.1.1'
    assert_kind_of(ActiveSupport::Cache::MemCacheStore, store)
  end

  def test_mem_cache_fragment_cache_store_with_options
    MemCache.expects(:new).with(%w[localhost 192.168.1.1], { :namespace => "foo" })
    store = ActiveSupport::Cache.lookup_store :mem_cache_store, "localhost", '192.168.1.1', :namespace => 'foo'
    assert_kind_of(ActiveSupport::Cache::MemCacheStore, store)
  end

  def test_object_assigned_fragment_cache_store
    store = ActiveSupport::Cache.lookup_store ActiveSupport::Cache::FileStore.new("/path/to/cache/directory")
    assert_kind_of(ActiveSupport::Cache::FileStore, store)
    assert_equal "/path/to/cache/directory", store.cache_path
  end
end

class CacheStoreTest < ActiveSupport::TestCase
  def setup
    @cache = ActiveSupport::Cache.lookup_store(:memory_store)
  end

  def test_fetch_without_cache_miss
    @cache.stubs(:read).with('foo', {}).returns('bar')
    @cache.expects(:write).never
    assert_equal 'bar', @cache.fetch('foo') { 'baz' }
  end

  def test_fetch_with_cache_miss
    @cache.stubs(:read).with('foo', {}).returns(nil)
    @cache.expects(:write).with('foo', 'baz', {})
    assert_equal 'baz', @cache.fetch('foo') { 'baz' }
  end

  def test_fetch_with_forced_cache_miss
    @cache.expects(:read).never
    @cache.expects(:write).with('foo', 'bar', :force => true)
    @cache.fetch('foo', :force => true) { 'bar' }
  end
end

# Tests the base functionality that should be identical across all cache stores.
module CacheStoreBehavior
  def test_should_read_and_write_strings
    @cache.write('foo', 'bar')
    assert_equal 'bar', @cache.read('foo')
  end

  def test_should_read_and_write_hash
    @cache.write('foo', {:a => "b"})
    assert_equal({:a => "b"}, @cache.read('foo'))
  end

  def test_should_read_and_write_integer
    @cache.write('foo', 1)
    assert_equal 1, @cache.read('foo')
  end

  def test_should_read_and_write_nil
    @cache.write('foo', nil)
    assert_equal nil, @cache.read('foo')
  end

  def test_fetch_without_cache_miss
    @cache.write('foo', 'bar')
    assert_equal 'bar', @cache.fetch('foo') { 'baz' }
  end

  def test_fetch_with_cache_miss
    assert_equal 'baz', @cache.fetch('foo') { 'baz' }
  end

  def test_fetch_with_forced_cache_miss
    @cache.fetch('foo', :force => true) { 'bar' }
  end

  def test_increment
    @cache.write('foo', 1, :raw => true)
    assert_equal 1, @cache.read('foo', :raw => true).to_i
    assert_equal 2, @cache.increment('foo')
    assert_equal 2, @cache.read('foo', :raw => true).to_i
    assert_equal 3, @cache.increment('foo')
    assert_equal 3, @cache.read('foo', :raw => true).to_i
  end

  def test_decrement
    @cache.write('foo', 3, :raw => true)
    assert_equal 3, @cache.read('foo', :raw => true).to_i
    assert_equal 2, @cache.decrement('foo')
    assert_equal 2, @cache.read('foo', :raw => true).to_i
    assert_equal 1, @cache.decrement('foo')
    assert_equal 1, @cache.read('foo', :raw => true).to_i
  end

  def test_exist
    @cache.write('foo', 'bar')
    assert @cache.exist?('foo')
    assert !@cache.exist?('bar')
  end
end

class FileStoreTest < ActiveSupport::TestCase
  def setup
    @cache = ActiveSupport::Cache.lookup_store(:file_store, Dir.pwd)
  end

  def teardown
    File.delete("foo.cache")
  end

  include CacheStoreBehavior

  def test_expires_in
    time = Time.local(2008, 4, 24)
    Time.stubs(:now).returns(time)
    File.stubs(:mtime).returns(time)

    @cache.write('foo', 'bar')
    cache_read = lambda { @cache.read('foo', :expires_in => 60) }
    assert_equal 'bar', cache_read.call

    Time.stubs(:now).returns(time + 30)
    assert_equal 'bar', cache_read.call

    Time.stubs(:now).returns(time + 120)
    assert_nil cache_read.call
  end
end

class MemoryStoreTest < ActiveSupport::TestCase
  def setup
    @cache = ActiveSupport::Cache.lookup_store(:memory_store)
  end

  include CacheStoreBehavior

  def test_store_objects_should_be_immutable
    @cache.write('foo', 'bar')
    assert_raise(ActiveSupport::FrozenObjectError) { @cache.read('foo').gsub!(/.*/, 'baz') }
    assert_equal 'bar', @cache.read('foo')
  end

  def test_original_store_objects_should_not_be_immutable
    bar = 'bar'
    @cache.write('foo', bar)
    assert_nothing_raised { bar.gsub!(/.*/, 'baz') }
  end
end

uses_memcached 'memcached backed store' do
  class MemCacheStoreTest < ActiveSupport::TestCase
    def setup
      @cache = ActiveSupport::Cache.lookup_store(:mem_cache_store)
      @data = @cache.instance_variable_get(:@data)
      @cache.clear
      @cache.silence!
      @cache.logger = Logger.new("/dev/null")
    end

    include CacheStoreBehavior

    def test_store_objects_should_be_immutable
      @cache.with_local_cache do
        @cache.write('foo', 'bar')
        @cache.read('foo').gsub!(/.*/, 'baz')
        assert_equal 'bar', @cache.read('foo')
      end
    end

    def test_stored_objects_should_not_be_frozen
      @cache.with_local_cache do
        @cache.write('foo', 'bar')
      end
      @cache.with_local_cache do
        assert !@cache.read('foo').frozen?
      end
    end

    def test_write_should_return_true_on_success
      @cache.with_local_cache do
        result = @cache.write('foo', 'bar')
        assert_equal 'bar', @cache.read('foo') # make sure 'foo' was written
        assert result
      end
    end

    def test_local_writes_are_persistent_on_the_remote_cache
      @cache.with_local_cache do
        @cache.write('foo', 'bar')
      end

      assert_equal 'bar', @cache.read('foo')
    end

    def test_clear_also_clears_local_cache
      @cache.with_local_cache do
        @cache.write('foo', 'bar')
        @cache.clear
        assert_nil @cache.read('foo')
      end
    end

    def test_local_cache_of_read_and_write
      @cache.with_local_cache do
        @cache.write('foo', 'bar')
        @data.flush_all # Clear remote cache
        assert_equal 'bar', @cache.read('foo')
      end
    end

    def test_local_cache_should_read_and_write_integer
      @cache.with_local_cache do
        @cache.write('foo', 1)
        assert_equal 1, @cache.read('foo')
      end
    end

    def test_local_cache_of_delete
      @cache.with_local_cache do
        @cache.write('foo', 'bar')
        @cache.delete('foo')
        @data.flush_all # Clear remote cache
        assert_nil @cache.read('foo')
      end
    end

    def test_local_cache_of_exist
      @cache.with_local_cache do
        @cache.write('foo', 'bar')
        @cache.instance_variable_set(:@data, nil)
        @data.flush_all # Clear remote cache
        assert @cache.exist?('foo')
      end
    end

    def test_local_cache_of_increment
      @cache.with_local_cache do
        @cache.write('foo', 1, :raw => true)
        @cache.increment('foo')
        @data.flush_all # Clear remote cache
        assert_equal 2, @cache.read('foo', :raw => true).to_i
      end
    end

    def test_local_cache_of_decrement
      @cache.with_local_cache do
        @cache.write('foo', 1, :raw => true)
        @cache.decrement('foo')
        @data.flush_all # Clear remote cache
        assert_equal 0, @cache.read('foo', :raw => true).to_i
      end
    end

    def test_exist_with_nulls_cached_locally
      @cache.with_local_cache do
        @cache.write('foo', 'bar')
        @cache.delete('foo')
        assert !@cache.exist?('foo')
      end
    end

    def test_multi_get
      @cache.with_local_cache do
        @cache.write('foo', 1)
        @cache.write('goo', 2)
        result = @cache.read_multi('foo', 'goo')
        assert_equal({'foo' => 1, 'goo' => 2}, result)
      end
    end

    def test_middleware
      app = lambda { |env|
        result = @cache.write('foo', 'bar')
        assert_equal 'bar', @cache.read('foo') # make sure 'foo' was written
        assert result
      }
      app = @cache.middleware.new(app)
      app.call({})
    end

    def test_expires_in
      result = @cache.write('foo', 'bar', :expires_in => 1)
      assert_equal 'bar', @cache.read('foo')
      sleep 2
      assert_equal nil, @cache.read('foo')
    end

    def test_expires_in_with_invalid_value
      @cache.write('baz', 'bat')
      assert_raise(RuntimeError) do
        @cache.write('foo', 'bar', :expires_in => 'Mon Jun 29 13:10:40 -0700 2150')
      end
      assert_equal 'bat', @cache.read('baz')
      assert_equal nil, @cache.read('foo')
    end

    def test_delete_should_only_pass_key_to_data
      key = 'foo'
      @data.expects(:delete).with(key)
      @cache.delete(key)
    end
  end

  class CompressedMemCacheStore < ActiveSupport::TestCase
    def setup
      @cache = ActiveSupport::Cache.lookup_store(:compressed_mem_cache_store)
      @cache.clear
    end

    include CacheStoreBehavior
  end
end

class CacheStoreLoggerTest < ActiveSupport::TestCase
  def setup
    @cache = ActiveSupport::Cache.lookup_store(:memory_store)

    @buffer = StringIO.new
    @cache.logger = Logger.new(@buffer)
  end

  def test_logging
    @cache.fetch('foo') { 'bar' }
    assert @buffer.string.present?
  end

  def test_mute_logging
    @cache.mute { @cache.fetch('foo') { 'bar' } }
    assert @buffer.string.blank?
  end
end