honkster-redis-store 0.3.10

data/spec/config/slave.conf

@@ -0,0 +1,171 @@
+# Redis configuration file example
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize no
+
+# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile /var/run/redis.pid
+
+# Accept connections on the specified port, default is 6379
+port 6381
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+save 900 1
+save 300 10
+save 60 10000
+
+# The filename where to dump the DB
+dbfilename slave-dump.rdb
+
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also 'stdout' can be used to force
+# the demon to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile stdout
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+
+slaveof localhost 6380
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+
+# requirepass foobared
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limts.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+
+# maxmemory <bytes>
+
+############################## APPEND ONLY MODE ###############################
+
+# By default Redis asynchronously dumps the dataset on disk. If you can live
+# with the idea that the latest records will be lost if something like a crash
+# happens this is the preferred way to run Redis. If instead you care a lot
+# about your data and don't want to that a single record can get lost you should
+# enable the append only mode: when this mode is enabled Redis will append
+# every write operation received in the file appendonly.log. This file will
+# be read on startup in order to rebuild the full dataset in memory.
+#
+# Note that you can have both the async dumps and the append only file if you
+# like (you have to comment the "save" statements above to disable the dumps).
+# Still if append only mode is enabled Redis will load the data from the
+# log file at startup ignoring the dump.rdb file.
+#
+# The name of the append only file is "appendonly.log"
+
+#appendonly no
+
+# The fsync() call tells the Operating System to actually write data on disk
+# instead to wait for more data in the output buffer. Some OS will really flush
+# data on disk, some other OS will just try to do it ASAP.
+#
+# Redis supports three different modes:
+#
+# no: don't fsync, just let the OS flush the data when it wants. Faster.
+# always: fsync after every write to the append only log . Slow, Safest.
+# everysec: fsync only if one second passed since the last fsync. Compromise.
+#
+# The default is "always" that's the safer of the options. It's up to you to
+# understand if you can relax this to "everysec" that will fsync every second
+# or to "no" that will let the operating system flush the output buffer when
+# it want, for better performances (but if you can live with the idea of
+# some data loss consider the default persistence mode that's snapshotting).
+
+#appendfsync always
+# appendfsync everysec
+# appendfsync no
+
+############################### ADVANCED CONFIG ###############################
+
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+glueoutputbuf yes
+
+# Use object sharing. Can save a lot of memory if you have many common
+# string in your dataset, but performs lookups against the shared objects
+# pool so it uses more CPU and can be a bit slower. Usually it's a good
+# idea.
+#
+# When object sharing is enabled (shareobjects yes) you can use
+# shareobjectspoolsize to control the size of the pool used in order to try
+# object sharing. A bigger pool size will lead to better sharing capabilities.
+# In general you want this value to be at least the double of the number of
+# very common strings you have in your dataset.
+#
+# WARNING: object sharing is experimental, don't enable this feature
+# in production before of Redis 1.0-stable. Still please try this feature in
+# your development environment so that we can test it better.
+#shareobjects no
+#shareobjectspoolsize 1024

data/spec/rack/cache/entitystore/redis_spec.rb

@@ -0,0 +1,118 @@
+require File.join(File.dirname(__FILE__), "/../../../spec_helper")
+
+class Object
+  def sha_like?
+    length == 40 && self =~ /^[0-9a-z]+$/
+  end
+end
+
+module Rack
+  module Cache
+    class EntityStore
+      # courtesy of http://github.com/rtomayko/rack-cache team
+      describe "Rack::Cache::EntityStore::Redis" do
+        before(:each) do
+          @store = Rack::Cache::EntityStore::Redis.new :host => "localhost"
+        end
+
+        # Redis store specific examples ===========================================
+
+        it "should have the class referenced by homonym constant" do
+          Rack::Cache::EntityStore::REDIS.should be(Rack::Cache::EntityStore::Redis)
+        end
+
+        it "should resolve the connection uri" do
+          cache = Rack::Cache::EntityStore::Redis.resolve(uri("redis://127.0.0.1")).cache
+          cache.should be_kind_of(::Redis::Client)
+          cache.to_s.should == "Redis Client connected to 127.0.0.1:6379 against DB 0"
+
+          cache = Rack::Cache::EntityStore::Redis.resolve(uri("redis://127.0.0.1:6380")).cache
+          cache.to_s.should == "Redis Client connected to 127.0.0.1:6380 against DB 0"
+
+          cache = Rack::Cache::EntityStore::Redis.resolve(uri("redis://127.0.0.1/13")).cache
+          cache.to_s.should == "Redis Client connected to 127.0.0.1:6379 against DB 13"
+        end
+
+        # Entity store shared examples ===========================================
+
+        it 'responds to all required messages' do
+          %w[read open write exist?].each do |message|
+            @store.should respond_to(message)
+          end
+        end
+
+        it 'stores bodies with #write' do
+          key, size = @store.write(['My wild love went riding,'])
+          key.should_not be_nil
+          key.should be_sha_like
+
+          data = @store.read(key)
+          data.should == 'My wild love went riding,'
+        end
+
+        it 'correctly determines whether cached body exists for key with #exist?' do
+          key, size = @store.write(['She rode to the devil,'])
+          @store.should be_exist(key)
+          @store.should_not be_exist('938jasddj83jasdh4438021ksdfjsdfjsdsf')
+        end
+
+        it 'can read data written with #write' do
+          key, size = @store.write(['And asked him to pay.'])
+          data = @store.read(key)
+          data.should == 'And asked him to pay.'
+        end
+
+        it 'gives a 40 character SHA1 hex digest from #write' do
+          key, size = @store.write(['she rode to the sea;'])
+          key.should_not be_nil
+          key.length.should == 40
+          key.should =~ /^[0-9a-z]+$/
+          key.should == '90a4c84d51a277f3dafc34693ca264531b9f51b6'
+        end
+
+        it 'returns the entire body as a String from #read' do
+          key, size = @store.write(['She gathered together'])
+          @store.read(key).should == 'She gathered together'
+        end
+
+        it 'returns nil from #read when key does not exist' do
+          @store.read('87fe0a1ae82a518592f6b12b0183e950b4541c62').should be_nil
+        end
+
+        it 'returns a Rack compatible body from #open' do
+          key, size = @store.write(['Some shells for her hair.'])
+          body = @store.open(key)
+          body.should respond_to(:each)
+          buf = ''
+          body.each { |part| buf << part }
+          buf.should == 'Some shells for her hair.'
+        end
+
+        it 'returns nil from #open when key does not exist' do
+          @store.open('87fe0a1ae82a518592f6b12b0183e950b4541c62').should be_nil
+        end
+
+        it 'can store largish bodies with binary data' do
+          pony = ::File.open(::File.dirname(__FILE__) + '/pony.jpg', 'rb') { |f| f.read }
+          key, size = @store.write([pony])
+          key.should == 'd0f30d8659b4d268c5c64385d9790024c2d78deb'
+          data = @store.read(key)
+          data.length.should == pony.length
+          data.hash.should == pony.hash
+        end
+
+        it 'deletes stored entries with #purge' do
+          key, size = @store.write(['My wild love went riding,'])
+          @store.purge(key).should be_nil
+          @store.read(key).should be_nil
+        end
+
+        # Helper Methods =============================================================
+
+        define_method :uri do |uri|
+          URI.parse uri
+        end
+      end
+    end
+  end
+end

data/spec/rack/cache/metastore/redis_spec.rb

@@ -0,0 +1,255 @@
+require File.join(File.dirname(__FILE__), "/../../../spec_helper")
+
+module Rack
+  module Cache
+    class MetaStore
+      # courtesy of http://github.com/rtomayko/rack-cache team
+      describe "Rack::Cache::MetaStore::Redis" do
+        before :each do
+          @store        = Rack::Cache::MetaStore::Redis.resolve uri("redis://127.0.0.1")
+          @entity_store = Rack::Cache::EntityStore::Redis.resolve uri("redis://127.0.0.1:6380")
+          @request  = mock_request('/', {})
+          @response = mock_response(200, {}, ['hello world'])
+        end
+
+        after :each do
+          @store.cache.flushall
+          @entity_store.cache.flushall
+        end
+
+        it "should have the class referenced by homonym constant" do
+          Rack::Cache::MetaStore::REDIS.should be(Rack::Cache::MetaStore::Redis)
+        end
+
+        it "should resolve the connection uri" do
+          cache = Rack::Cache::MetaStore::Redis.resolve(uri("redis://127.0.0.1")).cache
+          cache.should be_kind_of(::MarshaledRedis)
+          cache.to_s.should == "Redis Client connected to 127.0.0.1:6379 against DB 0"
+
+          cache = Rack::Cache::MetaStore::Redis.resolve(uri("redis://127.0.0.1:6380")).cache
+          cache.to_s.should == "Redis Client connected to 127.0.0.1:6380 against DB 0"
+
+          cache = Rack::Cache::MetaStore::Redis.resolve(uri("redis://127.0.0.1/13")).cache
+          cache.to_s.should == "Redis Client connected to 127.0.0.1:6379 against DB 13"
+        end
+
+        # Low-level implementation methods ===========================================
+
+        it 'writes a list of negotation tuples with #write' do
+          lambda { @store.write('/test', [[{}, {}]]) }.should_not raise_error
+        end
+
+        it 'reads a list of negotation tuples with #read' do
+          @store.write('/test', [[{},{}],[{},{}]])
+          tuples = @store.read('/test')
+          tuples.should == [ [{},{}], [{},{}] ]
+        end
+
+        it 'reads an empty list with #read when nothing cached at key' do
+          @store.read('/nothing').should be_empty
+        end
+
+        it 'removes entries for key with #purge' do
+          @store.write('/test', [[{},{}]])
+          @store.read('/test').should_not be_empty
+
+          @store.purge('/test')
+          @store.read('/test').should be_empty
+        end
+
+        it 'succeeds when purging non-existing entries' do
+          @store.read('/test').should be_empty
+          @store.purge('/test')
+        end
+
+        it 'returns nil from #purge' do
+          @store.write('/test', [[{},{}]])
+          @store.purge('/test').should be_nil
+          @store.read('/test').should == []
+        end
+
+        %w[/test http://example.com:8080/ /test?x=y /test?x=y&p=q].each do |key|
+          it "can read and write key: '#{key}'" do
+            lambda { @store.write(key, [[{},{}]]) }.should_not raise_error
+            @store.read(key).should == [[{},{}]]
+          end
+        end
+
+        it "can read and write fairly large keys" do
+          key = "b" * 4096
+          lambda { @store.write(key, [[{},{}]]) }.should_not raise_error
+          @store.read(key).should == [[{},{}]]
+        end
+
+        it "allows custom cache keys from block" do
+          request = mock_request('/test', {})
+          request.env['rack-cache.cache_key'] =
+            lambda { |request| request.path_info.reverse }
+          @store.cache_key(request).should == 'tset/'
+        end
+
+        it "allows custom cache keys from class" do
+          request = mock_request('/test', {})
+          request.env['rack-cache.cache_key'] = Class.new do
+            def self.call(request); request.path_info.reverse end
+          end
+          @store.cache_key(request).should == 'tset/'
+        end
+
+        # Abstract methods ===========================================================
+
+        # Stores an entry for the given request args, returns a url encoded cache key
+        # for the request.
+        define_method :store_simple_entry do |*request_args|
+          path, headers = request_args
+          @request = mock_request(path || '/test', headers || {})
+          @response = mock_response(200, {'Cache-Control' => 'max-age=420'}, ['test'])
+          body = @response.body
+          cache_key = @store.store(@request, @response, @entity_store)
+          @response.body.should_not equal(body)
+          cache_key
+        end
+
+        it 'stores a cache entry' do
+          cache_key = store_simple_entry
+          @store.read(cache_key).should_not be_empty
+        end
+
+        it 'sets the X-Content-Digest response header before storing' do
+          cache_key = store_simple_entry
+          req, res = @store.read(cache_key).first
+          res['X-Content-Digest'].should == 'a94a8fe5ccb19ba61c4c0873d391e987982fbbd3'
+        end
+
+        it 'finds a stored entry with #lookup' do
+          store_simple_entry
+          response = @store.lookup(@request, @entity_store)
+          response.should_not be_nil
+          response.should be_kind_of(Rack::Cache::Response)
+        end
+
+        it 'does not find an entry with #lookup when none exists' do
+          req = mock_request('/test', {'HTTP_FOO' => 'Foo', 'HTTP_BAR' => 'Bar'})
+          @store.lookup(req, @entity_store).should be_nil
+        end
+
+        it "canonizes urls for cache keys" do
+          store_simple_entry(path='/test?x=y&p=q')
+
+          hits_req = mock_request(path, {})
+          miss_req = mock_request('/test?p=x', {})
+
+          @store.lookup(hits_req, @entity_store).should_not be_nil
+          @store.lookup(miss_req, @entity_store).should be_nil
+        end
+
+        it 'does not find an entry with #lookup when the body does not exist' do
+          store_simple_entry
+          @response.headers['X-Content-Digest'].should_not be_nil
+          @entity_store.purge(@response.headers['X-Content-Digest'])
+          @store.lookup(@request, @entity_store).should be_nil
+        end
+
+        it 'restores response headers properly with #lookup' do
+          store_simple_entry
+          response = @store.lookup(@request, @entity_store)
+          response.headers.should == @response.headers.merge('Content-Length' => '4')
+        end
+
+        it 'restores response body from entity store with #lookup' do
+          store_simple_entry
+          response = @store.lookup(@request, @entity_store)
+          body = '' ; response.body.each {|p| body << p}
+          body.should == 'test'
+        end
+
+        it 'invalidates meta and entity store entries with #invalidate' do
+          store_simple_entry
+          @store.invalidate(@request, @entity_store)
+          response = @store.lookup(@request, @entity_store)
+          response.should be_kind_of(Rack::Cache::Response)
+          response.should_not be_fresh
+        end
+
+        it 'succeeds quietly when #invalidate called with no matching entries' do
+          req = mock_request('/test', {})
+          @store.invalidate(req, @entity_store)
+          @store.lookup(@request, @entity_store).should be_nil
+        end
+
+        # Vary =======================================================================
+
+        it 'does not return entries that Vary with #lookup' do
+          req1 = mock_request('/test', {'HTTP_FOO' => 'Foo', 'HTTP_BAR' => 'Bar'})
+          req2 = mock_request('/test', {'HTTP_FOO' => 'Bling', 'HTTP_BAR' => 'Bam'})
+          res = mock_response(200, {'Vary' => 'Foo Bar'}, ['test'])
+          @store.store(req1, res, @entity_store)
+
+          @store.lookup(req2, @entity_store).should be_nil
+        end
+
+        it 'stores multiple responses for each Vary combination' do
+          req1 = mock_request('/test', {'HTTP_FOO' => 'Foo',   'HTTP_BAR' => 'Bar'})
+          res1 = mock_response(200, {'Vary' => 'Foo Bar'}, ['test 1'])
+          key = @store.store(req1, res1, @entity_store)
+
+          req2 = mock_request('/test', {'HTTP_FOO' => 'Bling', 'HTTP_BAR' => 'Bam'})
+          res2 = mock_response(200, {'Vary' => 'Foo Bar'}, ['test 2'])
+          @store.store(req2, res2, @entity_store)
+
+          req3 = mock_request('/test', {'HTTP_FOO' => 'Baz',   'HTTP_BAR' => 'Boom'})
+          res3 = mock_response(200, {'Vary' => 'Foo Bar'}, ['test 3'])
+          @store.store(req3, res3, @entity_store)
+
+          slurp(@store.lookup(req3, @entity_store).body).should == 'test 3'
+          slurp(@store.lookup(req1, @entity_store).body).should == 'test 1'
+          slurp(@store.lookup(req2, @entity_store).body).should == 'test 2'
+
+          @store.read(key).length.should == 3
+        end
+
+        it 'overwrites non-varying responses with #store' do
+          req1 = mock_request('/test', {'HTTP_FOO' => 'Foo',   'HTTP_BAR' => 'Bar'})
+          res1 = mock_response(200, {'Vary' => 'Foo Bar'}, ['test 1'])
+          key = @store.store(req1, res1, @entity_store)
+          slurp(@store.lookup(req1, @entity_store).body).should == 'test 1'
+
+          req2 = mock_request('/test', {'HTTP_FOO' => 'Bling', 'HTTP_BAR' => 'Bam'})
+          res2 = mock_response(200, {'Vary' => 'Foo Bar'}, ['test 2'])
+          @store.store(req2, res2, @entity_store)
+          slurp(@store.lookup(req2, @entity_store).body).should == 'test 2'
+
+          req3 = mock_request('/test', {'HTTP_FOO' => 'Foo',   'HTTP_BAR' => 'Bar'})
+          res3 = mock_response(200, {'Vary' => 'Foo Bar'}, ['test 3'])
+          @store.store(req3, res3, @entity_store)
+          slurp(@store.lookup(req1, @entity_store).body).should == 'test 3'
+
+          @store.read(key).length.should == 2
+        end
+
+        # Helper Methods =============================================================
+
+        define_method :mock_request do |uri,opts|
+          env = Rack::MockRequest.env_for(uri, opts || {})
+          Rack::Cache::Request.new(env)
+        end
+
+        define_method :mock_response do |status,headers,body|
+          headers ||= {}
+          body = Array(body).compact
+          Rack::Cache::Response.new(status, headers, body)
+        end
+
+        define_method :slurp do |body|
+          buf = ''
+          body.each {|part| buf << part }
+          buf
+        end
+
+        define_method :uri do |uri|
+          URI.parse uri
+        end
+      end
+    end
+  end
+end