bunny 1.4.1 → 1.5.0.pre1

data/lib/bunny/session.rb

@@ -82,9 +82,8 @@ module Bunny
 
     # @return [Bunny::Transport]
     attr_reader :transport
-    attr_reader :status, :host, :port, :heartbeat, :user, :pass, :vhost, :frame_max, :channel_max, :threaded
+    attr_reader :status, :port, :heartbeat, :user, :pass, :vhost, :frame_max, :channel_max, :threaded
     attr_reader :server_capabilities, :server_properties, :server_authentication_mechanisms, :server_locales
-    attr_reader :default_channel
     attr_reader :channel_id_allocator
     # Authentication mechanism, e.g. "PLAIN" or "EXTERNAL"
     # @return [String]
@@ -99,6 +98,7 @@ module Bunny
     # @param [Hash] optz Extra options not related to connection
     #
     # @option connection_string_or_opts [String] :host ("127.0.0.1") Hostname or IP address to connect to
+    # @option connection_string_or_opts [Array<String>] :hosts (["127.0.0.1"]) list of hostname or IP addresses to select hostname from when connecting
     # @option connection_string_or_opts [Integer] :port (5672) Port RabbitMQ listens on
     # @option connection_string_or_opts [String] :username ("guest") Username
     # @option connection_string_or_opts [String] :password ("guest") Password
@@ -109,8 +109,10 @@ module Bunny
     # @option connection_string_or_opts [String] :tls_cert (nil) Path to client TLS/SSL certificate file (.pem)
     # @option connection_string_or_opts [String] :tls_key (nil) Path to client TLS/SSL private key file (.pem)
     # @option connection_string_or_opts [Array<String>] :tls_ca_certificates Array of paths to TLS/SSL CA files (.pem), by default detected from OpenSSL configuration
+    # @option connection_string_or_opts [String] :verify_peer (true) Whether TLS peer verification should be performed
     # @option connection_string_or_opts [Integer] :continuation_timeout (4000) Timeout for client operations that expect a response (e.g. {Bunny::Queue#get}), in milliseconds.
     # @option connection_string_or_opts [Integer] :connection_timeout (5) Timeout in seconds for connecting to the server.
+    # @option connection_string_or_opts [Proc] :hosts_shuffle_strategy A Proc that reorders a list of host strings, defaults to Array#shuffle
     #
     # @option optz [String] :auth_mechanism ("PLAIN") Authentication mechanism, PLAIN or EXTERNAL
     # @option optz [String] :locale ("PLAIN") Locale RabbitMQ should use
@@ -128,8 +130,12 @@ module Bunny
                connection_string_or_opts
              end.merge(optz)
 
+      @default_hosts_shuffle_strategy = Proc.new { |hosts| hosts.shuffle }
+
       @opts            = opts
-      @host            = self.hostname_from(opts)
+      @hosts           = self.hostnames_from(opts)
+      @host_index      = 0
+
       @port            = self.port_from(opts)
       @user            = self.username_from(opts)
       @pass            = self.password_from(opts)
@@ -173,6 +179,8 @@ module Bunny
       # the non-reentrant Ruby mutexes. MK.
       @transport_mutex     = @mutex_impl.new
       @status_mutex        = @mutex_impl.new
+      @host_index_mutex    = @mutex_impl.new
+
       @channels            = Hash.new
 
       @origin_thread       = Thread.current
@@ -210,6 +218,14 @@ module Bunny
       @threaded
     end
 
+    def host
+      @transport ? @transport.host : @hosts[@host_index]
+    end
+
+    def reset_host_index
+      @host_index_mutex.synchronize { @host_index = 0 }
+    end
+
     # @private
     attr_reader :mutex_impl
 
@@ -232,6 +248,7 @@ module Bunny
     # @see http://rubybunny.info/articles/connecting.html
     # @api public
     def start
+
       return self if connected?
 
       @status_mutex.synchronize { @status = :connecting }
@@ -241,27 +258,42 @@ module Bunny
       self.reset_continuations
 
       begin
-        # close existing transport if we have one,
-        # to not leak sockets
-        @transport.maybe_initialize_socket
 
-        @transport.post_initialize_socket
-        @transport.connect
+        begin
 
-        if @socket_configurator
-          @transport.configure_socket(&@socket_configurator)
-        end
+          # close existing transport if we have one,
+          # to not leak sockets
+          @transport.maybe_initialize_socket
 
-        self.init_connection
-        self.open_connection
+          @transport.post_initialize_socket
+          @transport.connect
 
-        @reader_loop = nil
-        self.start_reader_loop if threaded?
+          if @socket_configurator
+            @transport.configure_socket(&@socket_configurator)
+          end
 
-        @default_channel = self.create_channel unless @default_channel
-      rescue Exception => e
+          self.init_connection
+          self.open_connection
+
+          @reader_loop = nil
+          self.start_reader_loop if threaded?
+
+        rescue TCPConnectionFailed => e
+          self.initialize_transport
+
+          @logger.warn e.message
+          @logger.warn "Retrying connection on next host in line: #{@transport.host}:#{@transport.port}"
+
+          return self.start
+        rescue Exception
+          @status_mutex.synchronize { @status = :not_connected }
+          raise
+        end
+
+      rescue HostListDepleted
+        self.reset_host_index
         @status_mutex.synchronize { @status = :not_connected }
-        raise e
+        raise TCPConnectionFailedForAllHosts
       end
 
       self
@@ -355,40 +387,6 @@ module Bunny
       @automatically_recover
     end
 
-    #
-    # Backwards compatibility
-    #
-
-    # @private
-    def queue(*args)
-      @default_channel.queue(*args)
-    end
-
-    # @private
-    def direct(*args)
-      @default_channel.direct(*args)
-    end
-
-    # @private
-    def fanout(*args)
-      @default_channel.fanout(*args)
-    end
-
-    # @private
-    def topic(*args)
-      @default_channel.topic(*args)
-    end
-
-    # @private
-    def headers(*args)
-      @default_channel.headers(*args)
-    end
-
-    # @private
-    def exchange(*args)
-      @default_channel.exchange(*args)
-    end
-
     # Defines a callback that will be executed when RabbitMQ blocks the connection
     # because it is running low on memory or disk space (as configured via config file
     # and/or rabbitmqctl).
@@ -646,6 +644,8 @@ module Bunny
       begin
         sleep @network_recovery_interval
         @logger.debug "About to start connection recovery..."
+
+        self.reset_host_index # since we are starting a fresh try.
         self.initialize_transport
         self.start
 
@@ -654,7 +654,7 @@ module Bunny
 
           recover_channels
         end
-      rescue TCPConnectionFailed, AMQ::Protocol::EmptyResponseError => e
+      rescue TCPConnectionFailedForAllHosts, TCPConnectionFailed, AMQ::Protocol::EmptyResponseError => e
         @logger.warn "TCP connection failed, reconnecting in #{@network_recovery_interval} seconds"
         sleep @network_recovery_interval
         retry if recoverable_network_failure?(e)
@@ -663,6 +663,9 @@ module Bunny
 
     # @private
     def recover_channels
+      # default channel is reopened right after connection
+      # negotiation is completed, so make sure we do not try to open
+      # it twice. MK.
       @channels.each do |n, ch|
         ch.open
 
@@ -726,8 +729,10 @@ module Bunny
     end
 
     # @private
-    def hostname_from(options)
-      options[:host] || options[:hostname] || DEFAULT_HOST
+    def hostnames_from(options)
+      options.fetch(:hosts_shuffle_strategy, @default_hosts_shuffle_strategy).call(
+        [ options[:hosts] || options[:host] || options[:hostname] || DEFAULT_HOST ].flatten
+      )
     end
 
     # @private
@@ -923,7 +928,7 @@ module Bunny
     # @return [String]
     # @api public
     def to_s
-      "#<#{self.class.name}:#{object_id} #{@user}@#{@host}:#{@port}, vhost=#{@vhost}>"
+      "#<#{self.class.name}:#{object_id} #{@user}@#{host}:#{@port}, vhost=#{@vhost}, hosts=[#{@hosts.join(',')}]>"
     end
 
     protected
@@ -1076,7 +1081,12 @@ module Bunny
 
     # @private
     def initialize_transport
-      @transport = Transport.new(self, @host, @port, @opts.merge(:session_thread => @origin_thread))
+      if host = @hosts[ @host_index ]
+        @host_index_mutex.synchronize { @host_index += 1 }
+        @transport = Transport.new(self, host, @port, @opts.merge(:session_thread => @origin_thread))
+      else
+        raise HostListDepleted
+      end
     end
 
     # @private

data/lib/bunny/version.rb

@@ -2,5 +2,5 @@
 
 module Bunny
   # @return [String] Version of the library
-  VERSION = "1.4.1"
+  VERSION = "1.5.0.pre1"
 end

data/spec/config/enabled_plugins

@@ -0,0 +1 @@
+[rabbitmq_management, rabbitmq_consistent_hash_exchange].

data/spec/config/rabbitmq.config

@@ -0,0 +1,18 @@
+[
+
+  {rabbit, [
+    {ssl_listeners, [5671]},
+    {ssl_options, [{cacertfile,"spec/tls/cacert.pem"},
+                   {certfile,"spec/tls/server_cert.pem"},
+                   {keyfile,"spec/tls/server_key.pem"},
+                   {verify,verify_none},
+                   {fail_if_no_peer_cert,false}]} ]
+  },
+
+  {rabbitmq_management,
+    [{listener,
+      [{port, 15672}]
+    }]
+  }
+
+].

data/spec/higher_level_api/integration/basic_ack_spec.rb

@@ -20,7 +20,7 @@ describe Bunny::Channel, "#ack" do
       x.publish("bunneth", :routing_key => q.name)
       sleep 0.5
       q.message_count.should == 1
-      delivery_details, properties, content = q.pop(:ack => true)
+      delivery_details, properties, content = q.pop(:manual_ack => true)
 
       ch.ack(delivery_details.delivery_tag, true)
       q.message_count.should == 0
@@ -57,7 +57,7 @@ describe Bunny::Channel, "#ack" do
       x.publish("bunneth", :routing_key => q.name)
       sleep 0.5
       q.message_count.should == 1
-      _, _, content = q.pop(:ack => true)
+      _, _, content = q.pop(:manual_ack => true)
 
       ch.on_error do |ch, channel_close|
         @channel_close = channel_close
@@ -68,4 +68,31 @@ describe Bunny::Channel, "#ack" do
       @channel_close.reply_code.should == AMQ::Protocol::PreconditionFailed::VALUE
     end
   end
+
+  context "with a valid (known) delivery tag" do
+    it "gets a depricated message warning for using :ack" do
+      ch = connection.create_channel
+      q  = ch.queue("bunny.basic.ack.manual-acks", :exclusive => true)
+      x  = ch.default_exchange
+
+      x.publish("bunneth", :routing_key => q.name)
+      sleep 0.5
+      q.message_count.should == 1
+
+      orig_stderr = $stderr
+      $stderr = StringIO.new
+
+      delivery_details, properties, content = q.pop(:ack => true)
+
+      $stderr.rewind
+      $stderr.string.chomp.should eq("[DEPRECATION] `:ack` is deprecated.  Please use `:manual_ack` instead.\n[DEPRECATION] `:ack` is deprecated.  Please use `:manual_ack` instead.")
+
+      $stderr = orig_stderr
+
+      ch.ack(delivery_details.delivery_tag, true)
+      q.message_count.should == 0
+
+      ch.close
+    end
+  end
 end

data/spec/higher_level_api/integration/basic_consume_with_objects_spec.rb

@@ -44,7 +44,7 @@ describe Bunny::Queue, "#subscribe_with" do
       end
       t.abort_on_exception = true
 
-      q1.subscribe_with(ec, :ack => true)
+      q1.subscribe_with(ec, :manual_ack => true)
       sleep 2
       ch1.close
 

data/spec/higher_level_api/integration/basic_nack_spec.rb

@@ -23,7 +23,7 @@ describe Bunny::Channel, "#nack" do
       x.publish("bunneth", :routing_key => q.name)
       sleep(0.5)
       q.message_count.should == 1
-      delivery_info, _, content = q.pop(:ack => true)
+      delivery_info, _, content = q.pop(:manual_ack => true)
 
       subject.nack(delivery_info.delivery_tag, false, false)
       sleep(0.5)
@@ -43,9 +43,9 @@ q = subject.queue("bunny.basic.nack.with-requeue-true-multi-true", :exclusive =>
       end
       sleep(0.5)
       q.message_count.should == 3
-      _, _, _ = q.pop(:ack => true)
-      _, _, _ = q.pop(:ack => true)
-      delivery_info, _, content = q.pop(:ack => true)
+      _, _, _ = q.pop(:manual_ack => true)
+      _, _, _ = q.pop(:manual_ack => true)
+      delivery_info, _, content = q.pop(:manual_ack => true)
 
       subject.nack(delivery_info.delivery_tag, true, true)
       sleep(0.5)
@@ -64,7 +64,7 @@ q = subject.queue("bunny.basic.nack.with-requeue-true-multi-true", :exclusive =>
       x.publish("bunneth", :routing_key => q.name)
       sleep(0.25)
       q.message_count.should == 1
-      _, _, content = q.pop(:ack => true)
+      _, _, content = q.pop(:manual_ack => true)
 
       subject.on_error do |ch, channel_close|
         @channel_close = channel_close

data/spec/higher_level_api/integration/basic_reject_spec.rb

@@ -20,7 +20,7 @@ describe Bunny::Channel, "#reject" do
       x.publish("bunneth", :routing_key => q.name)
       sleep(0.5)
       q.message_count.should == 1
-      delivery_info, _, _ = q.pop(:ack => true)
+      delivery_info, _, _ = q.pop(:manual_ack => true)
 
       ch.reject(delivery_info.delivery_tag, true)
       sleep(0.5)
@@ -39,7 +39,7 @@ describe Bunny::Channel, "#reject" do
       x.publish("bunneth", :routing_key => q.name)
       sleep(0.5)
       q.message_count.should == 1
-      delivery_info, _, _ = q.pop(:ack => true)
+      delivery_info, _, _ = q.pop(:manual_ack => true)
 
       ch.reject(delivery_info.delivery_tag, false)
       sleep(0.5)
@@ -59,7 +59,7 @@ describe Bunny::Channel, "#reject" do
       x.publish("bunneth", :routing_key => q.name)
       sleep(0.25)
       q.message_count.should == 1
-      _, _, content = q.pop(:ack => true)
+      _, _, content = q.pop(:manual_ack => true)
 
       ch.on_error do |ch, channel_close|
         @channel_close = channel_close

data/spec/higher_level_api/integration/connection_recovery_spec.rb

@@ -8,7 +8,11 @@ unless ENV["CI"]
 
     def close_all_connections!
       http_client.list_connections.each do |conn_info|
-        http_client.close_connection(conn_info.name)
+        begin
+          http_client.close_connection(conn_info.name)
+        rescue Bunny::ConnectionForced
+          # This is not a problem, but the specs intermittently believe it is.
+        end
       end
     end
 
@@ -25,6 +29,29 @@ unless ENV["CI"]
       end
     end
 
+    def with_open_multi_host( c = Bunny.new( :hosts => ["127.0.0.1", "localhost"],
+                                             :network_recovery_interval => 0.2,
+                                             :recover_from_connection_close => true), &block)
+      begin
+        c.start
+        block.call(c)
+      ensure
+        c.close
+      end
+    end
+
+    def with_open_multi_broken_host( c = Bunny.new( :hosts => ["broken", "127.0.0.1", "localhost"],
+                                             :hosts_shuffle_strategy => Proc.new { |hosts| hosts }, # We do not shuffle for these tests so we always hit the broken host
+                                             :network_recovery_interval => 0.2,
+                                             :recover_from_connection_close => true), &block)
+      begin
+        c.start
+        block.call(c)
+      ensure
+        c.close
+      end
+    end
+
     def ensure_queue_recovery(ch, q)
       q.purge
       x = ch.default_exchange
@@ -66,7 +93,29 @@ unless ENV["CI"]
       end
     end
 
-    it "recovers channel" do
+    it "reconnects after grace period (with multiple hosts)" do
+      with_open_multi_host do |c|
+        close_all_connections!
+        sleep 0.1
+        c.should_not be_open
+
+        wait_for_recovery
+        c.should be_open
+      end
+    end
+
+    it "reconnects after grace period (with multiple hosts, including a broken one)" do
+      with_open_multi_broken_host do |c|
+        close_all_connections!
+        sleep 0.1
+        c.should_not be_open
+
+        wait_for_recovery
+        c.should be_open
+      end
+    end
+
+    it "recovers channels" do
       with_open do |c|
         ch1 = c.create_channel
         ch2 = c.create_channel
@@ -80,6 +129,34 @@ unless ENV["CI"]
       end
     end
 
+    it "recovers channels (with multiple hosts)" do
+      with_open_multi_host do |c|
+        ch1 = c.create_channel
+        ch2 = c.create_channel
+        close_all_connections!
+        sleep 0.1
+        c.should_not be_open
+
+        wait_for_recovery
+        ch1.should be_open
+        ch2.should be_open
+      end
+    end
+
+    it "recovers channels (with multiple hosts, including a broken one)" do
+      with_open_multi_broken_host do |c|
+        ch1 = c.create_channel
+        ch2 = c.create_channel
+        close_all_connections!
+        sleep 0.1
+        c.should_not be_open
+
+        wait_for_recovery
+        ch1.should be_open
+        ch2.should be_open
+      end
+    end
+
     it "recovers basic.qos prefetch setting" do
       with_open do |c|
         ch = c.create_channel