redis_failover 0.8.3 → 0.8.4

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+tags
+

data/Changes.md

@@ -1,3 +1,9 @@
+0.8.4
+-----------
+- Lock-down gemspec to redis 2.2.x in light of upcoming redis 3.x release. Once sufficient testing
+has been done with the 3.x release, I will relax the constraint in the gemspec.
+- Add environment-scoped configuration file support (oleriesenberg)
+
 0.8.3
 -----------
 - Added a way to gracefully shutdown/reconnect a RedisFailover::Client. (#13)

data/README.md

@@ -67,6 +67,7 @@ following options:
             --znode-path PATH            Znode path override for storing redis server list
             --max-failures COUNT         Max failures before manager marks node unavailable
         -C, --config PATH                Path to YAML configuration file
+        -E, --environment ENV            Config environment to use
         -h, --help                       Display all options
 
 To start the daemon for a simple master/slave configuration, use the following:
@@ -93,6 +94,9 @@ You would then simpy start the Node Manager via the following:
 
     redis_node_manager -C config.yml
 
+You can also scope the configuration to a particular environment (e.g., staging/development). See the examples
+directory for configuration file samples.
+
 The Node Manager will automatically discover the master/slaves upon startup. Note that it is
 a good idea to run more than one instance of the Node Manager daemon in your environment. At
 any moment, a single Node Manager process will be designated to monitor the redis servers. If

data/examples/multiple_environments_config.yml

@@ -0,0 +1,15 @@
+:development:
+  :nodes:
+    - localhost:6379
+    - localhost:6389
+  :zkservers:
+    - localhost:2181
+
+:staging:
+  :nodes:
+    - redis01:6379
+    - redis02:6379
+  :zkservers:
+    - zk01:2181
+    - zk02:2181
+    - zk03:2181

data/lib/redis_failover/cli.rb

@@ -36,10 +36,14 @@ module RedisFailover
           options[:max_failures] = Integer(max)
         end
 
-        opts.on '-C', '--config PATH', "Path to YAML configuration file" do |file|
+        opts.on('-C', '--config PATH', 'Path to YAML config file') do |file|
           options[:config_file] = file
         end
 
+        opts.on('-E', '--environment ENV', 'Config environment to use') do |config_env|
+          options[:config_environment] = config_env
+        end
+
         opts.on('-h', '--help', 'Display all options') do
           puts opts
           exit
@@ -48,7 +52,7 @@ module RedisFailover
 
       parser.parse(source)
       if config_file = options[:config_file]
-        options = from_file(config_file)
+        options = from_file(config_file, options[:config_environment])
       end
 
       if required_options_missing?(options)
@@ -69,12 +73,20 @@ module RedisFailover
     # Parses options from a YAML file.
     #
     # @param [String] file the filename
+    # @params [String] env the environment
     # @return [Hash] the parsed options
-    def self.from_file(file)
+    def self.from_file(file, env = nil)
       unless File.exists?(file)
         raise ArgumentError, "File #{file} can't be found"
       end
       options = YAML.load_file(file)
+
+      if env
+        options = options.fetch(env.to_sym) do
+          raise ArgumentError, "Environment #{env} can't be found in config"
+        end
+      end
+
       options[:nodes] = options[:nodes].join(',')
       options[:zkservers] = options[:zkservers].join(',')
 
@@ -100,4 +112,4 @@ module RedisFailover
       options
     end
   end
-end
+end

data/lib/redis_failover/client.rb

@@ -1,15 +1,18 @@
 module RedisFailover
-  # Redis failover-aware client. RedisFailover::Client is a wrapper over a set of underlying redis
-  # clients, which means all normal redis operations can be performed on an instance of this class.
-  # The class only requires a set of ZooKeeper server addresses to function properly. The client
-  # will automatically retry failed operations, and handle failover to a new master. The client
-  # registers and listens for watcher events from the Node Manager. When these events are received,
-  # the client fetches the latest set of redis nodes from ZooKeeper and rebuilds its internal
-  # Redis clients appropriately. RedisFailover::Client also directs write operations to the master,
-  # and all read operations to the slaves.
+  # Redis failover-aware client. RedisFailover::Client is a wrapper over a set
+  # of underlying redis clients, which means all normal redis operations can be
+  # performed on an instance of this class. The class only requires a set of
+  # ZooKeeper server addresses to function properly. The client will automatically
+  # retry failed operations, and handle failover to a new master. The client
+  # registers and listens for watcher events from the Node Manager. When these
+  # events are received, the client fetches the latest set of redis nodes from
+  # ZooKeeper and rebuilds its internal Redis clients appropriately.
+  # RedisFailover::Client also directs write operations to the master, and all
+  # read operations to the slaves.
   #
   # @example Usage
-  #   client = RedisFailover::Client.new(:zkservers => 'localhost:2181,localhost:2182,localhost:2183')
+  #   zk_servers = 'localhost:2181,localhost:2182,localhost:2183'
+  #   client = RedisFailover::Client.new(:zkservers => zk_servers)
   #   client.set('foo', 1) # will be directed to master
   #   client.get('foo') # will be directed to a slave
   #
@@ -86,13 +89,13 @@ module RedisFailover
     # Creates a new failover redis client.
     #
     # @param [Hash] options the options used to initialize the client instance
-    # @option options [String] :zkservers comma-separated ZooKeeper host:port pairs (required)
-    # @option options [String] :znode_path znode path override for redis server list
+    # @option options [String] :zkservers comma-separated ZooKeeper host:port
+    # @option options [String] :znode_path znode path override for redis nodes
     # @option options [String] :password password for redis nodes
     # @option options [String] :db database to use for redis nodes
     # @option options [String] :namespace namespace for redis nodes
     # @option options [Logger] :logger logger override
-    # @option options [Boolean] :retry_failure indicates if failures should be retried
+    # @option options [Boolean] :retry_failure indicates if failures are retried
     # @option options [Integer] :max_retries max retries for a failure
     # @return [RedisFailover::Client]
     def initialize(options = {})
@@ -124,7 +127,7 @@ module RedisFailover
     # Determines whether or not an unknown method can be handled.
     #
     # @param [Symbol] method the method to check
-    # @param [Boolean] include_private determines if private methods should be checked
+    # @param [Boolean] include_private determines if private methods are checked
     # @return [Boolean] indicates if the method can be handled
     def respond_to_missing?(method, include_private)
       redis_operation?(method) || super
@@ -144,7 +147,7 @@ module RedisFailover
     # @option options [String] :host the host of the failover candidate
     # @option options [String] :port the port of the failover candidate
     def manual_failover(options = {})
-      Manual.failover(zk, options)
+      ManualFailover.new(zk, options).perform
       self
     end
 
@@ -295,7 +298,7 @@ module RedisFailover
 
       nodes
     rescue Zookeeper::Exceptions::InheritedConnectionError => ex
-      logger.debug { "Caught #{ex.class} '#{ex.message}' reconstructing the zk instance" }
+      logger.debug { "Caught #{ex.class} '#{ex.message}' - reopening ZK client" }
       @zk.reopen
       retry
     end
@@ -395,7 +398,7 @@ module RedisFailover
       end
     end
 
-    # Disconnects current redis clients and resets this client's view of the world.
+    # Disconnects current redis clients.
     def purge_clients
       @lock.synchronize do
         logger.info("Purging current redis clients")

data/lib/redis_failover/errors.rb

@@ -44,4 +44,4 @@ module RedisFailover
       super("Operation `#{operation}` is currently unsupported")
     end
   end
-end
+end

data/lib/redis_failover/{manual.rb → manual_failover.rb}

@@ -1,34 +1,38 @@
 module RedisFailover
   # Provides manual failover support to a new master.
-  module Manual
-    extend self
-
+  class ManualFailover
     # Path for manual failover communication.
     ZNODE_PATH = '/redis_failover_manual'.freeze
 
     # Denotes that any slave can be used as a candidate for promotion.
     ANY_SLAVE = "ANY_SLAVE".freeze
 
-    # Performs a manual failover. If options is empty, a random slave will
-    # be used as a failover candidate.
+    # Creates a new instance.
     #
     # @param [ZK] zk the ZooKeeper client
     # @param [Hash] options the options used for manual failover
     # @option options [String] :host the host of the failover candidate
     # @option options [String] :port the port of the failover candidate
-    def failover(zk, options = {})
-      create_path(zk)
-      node = options.empty? ? ANY_SLAVE : "#{options[:host]}:#{options[:port]}"
-      zk.set(ZNODE_PATH, node)
+    # @note
+    #   If options is empty, a random slave will be used
+    #   as a failover candidate.
+    def initialize(zk, options = {})
+      @zk = zk
+      @options = options
+    end
+
+    # Performs a manual failover.
+    def perform
+      create_path
+      node = @options.empty? ? ANY_SLAVE : "#{@options[:host]}:#{@options[:port]}"
+      @zk.set(ZNODE_PATH, node)
     end
 
     private
 
     # Creates the znode path used for coordinating manual failovers.
-    #
-    # @param [ZK] zk the ZooKeeper cilent
-    def create_path(zk)
-      zk.create(ZNODE_PATH)
+    def create_path
+      @zk.create(ZNODE_PATH)
     rescue ZK::Exceptions::NodeExists
       # best effort
     end

data/lib/redis_failover/node_manager.rb

@@ -23,22 +23,22 @@ module RedisFailover
     # Creates a new instance.
     #
     # @param [Hash] options the options used to initialize the manager
-    # @option options [String] :zkservers comma-separated ZooKeeper host:port pairs (required)
-    # @option options [String] :znode_path znode path override for redis server list
+    # @option options [String] :zkservers comma-separated ZK host:port pairs
+    # @option options [String] :znode_path znode path override for redis nodes
     # @option options [String] :password password for redis nodes
     # @option options [Array<String>] :nodes the nodes to manage
-    # @option options [String] :max_failures the max failures for a particular node
+    # @option options [String] :max_failures the max failures for a node
     def initialize(options)
       logger.info("Redis Node Manager v#{VERSION} starting (#{RUBY_DESCRIPTION})")
       @options = options
       @znode = @options[:znode_path] || Util::DEFAULT_ZNODE_PATH
-      @manual_znode = Manual::ZNODE_PATH
+      @manual_znode = ManualFailover::ZNODE_PATH
       @mutex = Mutex.new
     end
 
     # Starts the node manager.
     #
-    # @note This is a blocking method, it does not return until the manager terminates.
+    # @note This method does not return until the manager terminates.
     def start
       @queue = Queue.new
       @leader = false
@@ -60,8 +60,8 @@ module RedisFailover
       retry
     end
 
-    # Notifies the manager of a state change. Used primarily by {RedisFailover::NodeWatcher}
-    # to inform the manager of watched node states.
+    # Notifies the manager of a state change. Used primarily by
+    # {RedisFailover::NodeWatcher} to inform the manager of watched node states.
     #
     # @param [Node] node the node
     # @param [Symbol] state the state
@@ -202,7 +202,7 @@ module RedisFailover
       # make a specific node or slave the new master
       candidate = node || @slaves.pop
       unless candidate
-        logger.error('Failed to promote a new master since no candidate available.')
+        logger.error('Failed to promote a new master, no candidate available.')
         return
       end
 
@@ -338,7 +338,7 @@ module RedisFailover
       new_master = @zk.get(@manual_znode, :watch => true).first
       logger.info("Received manual failover request for: #{new_master}")
 
-      node = if new_master == Manual::ANY_SLAVE
+      node = if new_master == ManualFailover::ANY_SLAVE
         @slaves.sample
       else
         host, port = new_master.split(':', 2)

data/lib/redis_failover/util.rb

@@ -5,7 +5,7 @@ module RedisFailover
   module Util
     extend self
 
-    # Default node in ZooKeeper that contains the current list of available redis nodes.
+    # Default node in ZK that contains the current list of available redis nodes.
     DEFAULT_ZNODE_PATH = '/redis_failover_nodes'.freeze
 
     # Connectivity errors that the redis client raises.

data/lib/redis_failover/version.rb

@@ -1,3 +1,3 @@
 module RedisFailover
-  VERSION = "0.8.3"
+  VERSION = '0.8.4'
 end

data/lib/redis_failover.rb

@@ -15,7 +15,8 @@ require 'redis_failover/node'
 require 'redis_failover/errors'
 require 'redis_failover/client'
 require 'redis_failover/runner'
-require 'redis_failover/manual'
 require 'redis_failover/version'
 require 'redis_failover/node_manager'
 require 'redis_failover/node_watcher'
+require 'redis_failover/manual_failover'
+

data/redis_failover.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = RedisFailover::VERSION
 
-  gem.add_dependency('redis')
+  gem.add_dependency('redis', '~> 2.2')
   gem.add_dependency('redis-namespace')
   gem.add_dependency('multi_json', '~> 1')
   gem.add_dependency('zk', '~> 1.4')

data/spec/cli_spec.rb

@@ -35,6 +35,17 @@ module RedisFailover
           '1'])
         opts[:max_failures].should == 1
       end
+
+      it 'properly parses the config file' do
+        opts = CLI.parse(['-C', "#{File.dirname(__FILE__)}/support/config/single_environment.yml"])
+        opts[:zkservers].should == 'zk01:2181,zk02:2181,zk03:2181'
+
+        opts = CLI.parse(['-C', "#{File.dirname(__FILE__)}/support/config/multiple_environments.yml", '-E', 'development'])
+        opts[:zkservers].should == 'localhost:2181'
+
+        opts = CLI.parse(['-C', "#{File.dirname(__FILE__)}/support/config/multiple_environments.yml", '-E', 'staging'])
+        opts[:zkservers].should == 'zk01:2181,zk02:2181,zk03:2181'
+      end
     end
   end
 end

data/spec/support/config/multiple_environments.yml

@@ -0,0 +1,15 @@
+:development:
+  :nodes:
+    - localhost:6379
+    - localhost:6389
+  :zkservers:
+    - localhost:2181
+
+:staging:
+  :nodes:
+    - redis01:6379
+    - redis02:6379
+  :zkservers:
+    - zk01:2181
+    - zk02:2181
+    - zk03:2181

data/spec/support/config/single_environment.yml

@@ -0,0 +1,7 @@
+:nodes:
+  - redis01:6379
+  - redis02:6379
+:zkservers:
+  - zk01:2181
+  - zk02:2181
+  - zk03:2181

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_failover
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-11 00:00:00.000000000 Z
+date: 2012-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
@@ -142,11 +142,12 @@ files:
 - Rakefile
 - bin/redis_node_manager
 - examples/config.yml
+- examples/multiple_environments_config.yml
 - lib/redis_failover.rb
 - lib/redis_failover/cli.rb
 - lib/redis_failover/client.rb
 - lib/redis_failover/errors.rb
-- lib/redis_failover/manual.rb
+- lib/redis_failover/manual_failover.rb
 - lib/redis_failover/node.rb
 - lib/redis_failover/node_manager.rb
 - lib/redis_failover/node_watcher.rb
@@ -160,6 +161,8 @@ files:
 - spec/node_spec.rb
 - spec/node_watcher_spec.rb
 - spec/spec_helper.rb
+- spec/support/config/multiple_environments.yml
+- spec/support/config/single_environment.yml
 - spec/support/node_manager_stub.rb
 - spec/support/redis_stub.rb
 - spec/util_spec.rb
@@ -177,7 +180,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -651053748036205721
+      hash: 2968723262927828498
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -186,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -651053748036205721
+      hash: 2968723262927828498
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -201,6 +204,8 @@ test_files:
 - spec/node_spec.rb
 - spec/node_watcher_spec.rb
 - spec/spec_helper.rb
+- spec/support/config/multiple_environments.yml
+- spec/support/config/single_environment.yml
 - spec/support/node_manager_stub.rb
 - spec/support/redis_stub.rb
 - spec/util_spec.rb