bunny 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f37583fb4c93085f91f358da46737f7e7e75db6a
-  data.tar.gz: 0e76e67996978dffa4c80a3b91225c494e2d2b55
+  metadata.gz: 3f58b34695f1799decb5818ead7efbf21448656d
+  data.tar.gz: 4c8db08cd4581da8eab1bdd0afd81693d4042a55
 SHA512:
-  metadata.gz: 01caa52176c8bec67e35c26964bc4e2c8aa5eaddea0503bc6c6b6b8b2b289894343baa260f68367fb00e80985accd0e48c17587916968cc75af78611e760c752
-  data.tar.gz: ad6bf5194d91d866f340cc7688ac863d4062fed845a47c67794961f746dac8cd243fd634d5c552b3add73c1845f4f66a981cc51bbb88a62c22406f1a01a9666c
+  metadata.gz: 941c64ca6a10063df82456aec1f5dd4a44d5df67c6d9e74a73cfc41821b1b3d29f2ddfe260ea31434adb0697d5136d6cbc28e5a84e8adaca2b83d8897fb8d164
+  data.tar.gz: a3056eae41a6600aeed337094851c1f5f16e0f80e7b8170e2a7a18d22ac2caabdb0cf0ce69637c1f9f0ecdee7e693d1e9cf84dbc66ebfdd866bd6602a6b84a67

data/CONTRIBUTING.md

@@ -30,8 +30,10 @@ these. TLS (x509 PEM) certificates include a hostname-specific fields,
 the tests allow for expecting hostname overriding using the `BUNNY_RABBITMQ_HOSTNAME`
 environment variables (default value is `127.0.0.1`).
 
-Server, CA and client certificates can be found under `spec/tls`. They are supposed to be
-generated with [tls-gen](github.com/michaelklishin/tls-gen) or similar in the target environment.
+Server, CA and client certificates can be found under `spec/tls`.
+The location can be overridden via the `BUNNY_CERTIFICATE_DIR` environment variable.
+It is supposed to target [tls-gen](https://github.com/michaelklishin/tls-gen)'s basic profile
+output (result) directory on the host where specs are to be executed.
 
 Next up you'll need to prepare your node for the specs (just once):
 

data/ChangeLog.md

@@ -1,8 +1,52 @@
-## Changes between Bunny 2.7.0 and 2.8.0 (unreleased)
+## Changes between Bunny 2.7.1 and 2.7.2 (unreleased)
 
 No changes yet.
 
 
+## Changes between Bunny 2.7.0 and 2.7.1 (Sep 25th, 2017)
+
+### Sensible Socket Read Timeouts When RabbitMQ is Configured to Disabled Heartbeats
+
+Bunny now correctly handles scenarios where server is configured
+to disable heartbeats (which is a terrible idea, don't do it!)
+
+GitHub issue: [#519](https://github.com/ruby-amqp/bunny/issues/519).
+
+### Bunny::Channel#basic_get Usability
+
+`Bunny::Channel#basic_get` invoked with a non-existent queue now
+throws a channel exception instead of a generic operation timeout.
+
+GitHub issue: [#518](https://github.com/ruby-amqp/bunny/issues/518).
+
+### Spec Suite Improvements
+
+`BUNNY_CERTIFICATE_DIR` environment variable now can be used
+to override local CA and client certificate/key pair directory.
+The directory is expected to be the result directory generated
+by the basic [tls-gen](http://github.com/michaelklishin/tls-gen) profile.
+
+TLSv1.0 is no longer used in tests because it's being disabled by default
+by more and more installations as it has known vulnerabilities
+and is no longer considered to be acceptable by several compliance
+standards (e.g. PCI DSS).
+
+### Improved Synchronisation for channel.close Handlers
+
+`channel.close` handler will now acquire a lock . This avoids concurrency
+hazards in some rare scenarios when a channel is closed due a protocol
+exception by the server and concurrently opened by user code
+at the same time.
+
+### More Meaningful Error Messages in Bunny::Session#create_channel
+
+Sometimes users attempt to open a channel on a connection that
+isn't connected yet because `Bunny::Session#start` was never invoked.
+
+`Bunny::Session#create_channel` will now provide a more sensible exception message
+in those cases.
+
+
 ## Changes between Bunny 2.6.0 and 2.7.0 (May 11th, 2017)
 
 ### amq-protocol Update

data/README.md

@@ -88,7 +88,7 @@ gem install bunny
 To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", ">= 2.6.5"
+gem "bunny", ">= 2.7.0"
 ```
 
 

data/lib/bunny/channel.rb

@@ -602,7 +602,12 @@ module Bunny
       # we implement them). So we return a triple of nils immediately which apps should be
       # able to handle anyway as "got no message, no need to act". MK.
       last_basic_get_response = if @connection.open?
-                                  wait_on_basic_get_continuations
+                                  begin
+                                    wait_on_basic_get_continuations
+                                  rescue Timeout::Error => e
+                                    raise_if_continuation_resulted_in_a_channel_error!
+                                    raise e
+                                  end
                                 else
                                   [nil, nil, nil]
                                 end

data/lib/bunny/session.rb

@@ -101,16 +101,18 @@ module Bunny
     # @option connection_string_or_opts [String] :username ("guest") Username
     # @option connection_string_or_opts [String] :password ("guest") Password
     # @option connection_string_or_opts [String] :vhost ("/") Virtual host to use
-    # @option connection_string_or_opts [Integer] :heartbeat (600) Heartbeat interval. 0 means no heartbeat.
+    # @option connection_string_or_opts [Integer, Symbol] :heartbeat (:server) Heartbeat interval. :server means use the default suggested by RabbitMQ. 0 means no heartbeat (not recommended).
     # @option connection_string_or_opts [Integer] :network_recovery_interval (4) Recovery interval periodic network recovery will use. This includes initial pause after network failure.
     # @option connection_string_or_opts [Boolean] :tls (false) Should TLS/SSL be used?
     # @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 [Keyword] :tls_version (negotiated) What TLS version should be used (:TLSv1, :TLSv1_1, or :TLSv1_2)
+    # @option connection_string_or_opts [Symbol] :tls_version (negotiated) What TLS version should be used (:TLSv1, :TLSv1_1, or :TLSv1_2)
     # @option connection_string_or_opts [Integer] :continuation_timeout (15000) 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 [Integer] :connection_timeout (30) Timeout in seconds for connecting to the server.
+    # @option connection_string_or_opts [Integer] :read_timeout (30) TCP socket read timeout in seconds.
+    # @option connection_string_or_opts [Integer] :write_timeout (30) TCP socket write timeout in seconds.
     # @option connection_string_or_opts [Proc] :hosts_shuffle_strategy A Proc that reorders a list of host strings, defaults to Array#shuffle
     # @option connection_string_or_opts [Logger] :logger The logger.  If missing, one is created using :log_file and :log_level.
     # @option connection_string_or_opts [IO, String] :log_file The file or path to use when creating a logger.  Defaults to STDOUT.
@@ -346,6 +348,7 @@ module Bunny
     def create_channel(n = nil, consumer_pool_size = 1, consumer_pool_abort_on_exception = false, consumer_pool_shutdown_timeout = 60)
       raise ArgumentError, "channel number 0 is reserved in the protocol and cannot be used" if 0 == n
       raise ConnectionAlreadyClosed if manually_closed?
+      raise RuntimeError, "this connection is not open. Was Bunny::Session#start invoked? Is automatic recovery enabled?" if !connected?
 
       @channel_mutex.synchronize do
         if n && (ch = @channels[n])
@@ -540,6 +543,16 @@ module Bunny
       end
     end
 
+    # @private
+    def find_channel(number)
+      @channels[number]
+    end
+
+    # @private
+    def synchronised_find_channel(number)
+      @channel_mutex.synchronize { @channels[number] }
+    end
+
     # @private
     def close_all_channels
       @channel_mutex.synchronize do
@@ -606,15 +619,20 @@ module Bunny
         @unblock_callback.call(method) if @unblock_callback
       when AMQ::Protocol::Channel::Close then
         begin
-          ch = @channels[ch_number]
+          ch = synchronised_find_channel(ch_number)
+          # this includes sending a channel.close-ok and
+          # potentially invoking a user-provided callback,
+          # avoid doing that while holding a mutex lock. MK.
           ch.handle_method(method)
         ensure
+          # synchronises on @channel_mutex under the hood
           self.unregister_channel(ch)
         end
       when AMQ::Protocol::Basic::GetEmpty then
-        @channels[ch_number].handle_basic_get_empty(method)
+        ch = find_channel(ch_number)
+        ch.handle_basic_get_empty(method)
       else
-        if ch = @channels[ch_number]
+        if ch = find_channel(ch_number)
           ch.handle_method(method)
         else
           @logger.warn "Channel #{ch_number} is not open on this connection!"
@@ -1161,11 +1179,18 @@ module Bunny
 
       # We set the read_write_timeout to twice the heartbeat value
       # This allows us to miss a single heartbeat before we time out the socket.
-      @transport.read_timeout = if heartbeat_disabled?(@client_heartbeat)
+      #
+      # Since RabbitMQ can be configured to disable heartbeats (bad idea but technically
+      # possible nonetheless), we need to take both client and server values into
+      # consideration when deciding about using the heartbeat value for read timeouts.
+      @transport.read_timeout = if heartbeat_disabled?(@client_heartbeat) || heartbeat_disabled?(@heartbeat)
+                                  @logger.debug { "Will use default socket read timeout of #{Transport::DEFAULT_READ_TIMEOUT}" }
                                   Transport::DEFAULT_READ_TIMEOUT
                                 else
                                   # pad to account for edge cases. MK.
-                                  @heartbeat * 2.2
+                                  n = @heartbeat * 2.2
+                                  @logger.debug { "Will use socket read timeout of #{n}" }
+                                  n
                                 end
 
 

data/lib/bunny/version.rb

@@ -2,5 +2,5 @@
 
 module Bunny
   # @return [String] Version of the library
-  VERSION = "2.7.0"
+  VERSION = "2.7.1"
 end

data/spec/higher_level_api/integration/basic_get_spec.rb

@@ -54,3 +54,27 @@ describe Bunny::Queue, "#pop" do
     end
   end
 end
+
+
+describe Bunny::Channel, "#basic_get" do
+  let(:connection) do
+    c = Bunny.new(username: "bunny_gem", password: "bunny_password", vhost: "bunny_testbed",
+                  automatically_recover: false, continuation_timeout: 3000)
+    c.start
+    c
+  end
+
+  after :each do
+    connection.close if connection.open?
+  end
+
+  context "with a non-existent queue" do
+    it "throws a NOT_FOUND" do
+      ch = connection.create_channel
+
+      expect do
+        ch.basic_get "non_existent_#{rand.to_s}"
+      end.to raise_error(Bunny::NotFound)
+    end
+  end
+end

data/spec/higher_level_api/integration/tls_connection_spec.rb

@@ -2,10 +2,14 @@
 require "spec_helper"
 
 unless ENV["CI"]
+  CERTIFICATE_DIR=ENV.fetch("BUNNY_CERTIFICATE_DIR", "./spec/tls")
+  puts "Will use certificates from #{CERTIFICATE_DIR}"
+
   shared_examples_for "successful TLS connection" do
     it "succeeds" do
-      expect(connection).to be_tls
-      ch = connection.create_channel
+      expect(subject).to be_tls
+      ch = subject.create_channel
+      ch.confirm_select
 
       q  = ch.queue("", exclusive: true)
       x  = ch.default_exchange
@@ -15,7 +19,7 @@ unless ENV["CI"]
         publish("xyzzy", routing_key: q.name).
         publish("xyzzy", routing_key: q.name)
 
-      sleep 0.5
+      x.wait_for_confirms
       expect(q.message_count).to eq 4
 
       i = 0
@@ -41,9 +45,9 @@ unless ENV["CI"]
         :vhost    => "bunny_testbed",
         :tls                   => true,
         :verify_peer           => verify_peer,
-        :tls_cert              => "spec/tls/client_certificate.pem",
-        :tls_key               => "spec/tls/client_key.pem",
-        :tls_ca_certificates   => ["./spec/tls/ca_certificate.pem"])
+        :tls_cert              => "#{CERTIFICATE_DIR}/client_certificate.pem",
+        :tls_key               => "#{CERTIFICATE_DIR}/client_key.pem",
+        :tls_ca_certificates   => ["#{CERTIFICATE_DIR}/ca_certificate.pem"])
     end
 
     context "peer verification is off" do
@@ -58,6 +62,10 @@ unless ENV["CI"]
         subject.start
         expect(subject.transport.socket.hostname).to_not be_empty
       end
+
+      after :each do
+        subject.close
+      end
     end
 
     context "peer verification is on" do
@@ -70,21 +78,21 @@ unless ENV["CI"]
   end
 
   describe "TLS connection to RabbitMQ with client certificates" do
-    let(:connection) do
+    let(:subject) do
       c = Bunny.new(username: "bunny_gem",
         password: "bunny_password",
         vhost: "bunny_testbed",
         tls: true,
-        tls_cert: "spec/tls/client_certificate.pem",
-        tls_key: "spec/tls/client_key.pem",
-        tls_ca_certificates: ["./spec/tls/ca_certificate.pem"],
+        tls_cert: "#{CERTIFICATE_DIR}/client_certificate.pem",
+        tls_key: "#{CERTIFICATE_DIR}/client_key.pem",
+        tls_ca_certificates: ["#{CERTIFICATE_DIR}/ca_certificate.pem"],
         verify_peer: false)
       c.start
       c
     end
 
     after :each do
-      connection.close
+      subject.close
     end
 
     include_examples "successful TLS connection"
@@ -92,19 +100,19 @@ unless ENV["CI"]
 
 
   describe "TLS connection to RabbitMQ without client certificates" do
-    let(:connection) do
+    let(:subject) do
       c = Bunny.new(username: "bunny_gem",
         password: "bunny_password",
         vhost: "bunny_testbed",
         tls: true,
-        tls_ca_certificates: ["./spec/tls/ca_certificate.pem"],
+        tls_ca_certificates: ["#{CERTIFICATE_DIR}/ca_certificate.pem"],
         verify_peer: false)
       c.start
       c
     end
 
     after :each do
-      connection.close
+      subject.close
     end
 
     include_examples "successful TLS connection"
@@ -112,18 +120,18 @@ unless ENV["CI"]
 
 
   describe "TLS connection to RabbitMQ with a connection string" do
-    let(:connection) do
+    let(:subject) do
       c = Bunny.new("amqps://bunny_gem:bunny_password@#{local_hostname}/bunny_testbed",
-        tls_cert: "spec/tls/client_certificate.pem",
-        tls_key: "spec/tls/client_key.pem",
-        tls_ca_certificates: ["./spec/tls/ca_certificate.pem"],
+        tls_cert: "#{CERTIFICATE_DIR}/client_certificate.pem",
+        tls_key: "#{CERTIFICATE_DIR}/client_key.pem",
+        tls_ca_certificates: ["#{CERTIFICATE_DIR}/ca_certificate.pem"],
         verify_peer: false)
       c.start
       c
     end
 
     after :each do
-      connection.close
+      subject.close
     end
 
     include_examples "successful TLS connection"
@@ -131,16 +139,16 @@ unless ENV["CI"]
 
 
   describe "TLS connection to RabbitMQ with a connection string and w/o client certificate and key" do
-    let(:connection) do
+    let(:subject) do
       c = Bunny.new("amqps://bunny_gem:bunny_password@#{local_hostname}/bunny_testbed",
-        tls_ca_certificates: ["./spec/tls/ca_certificate.pem"],
+        tls_ca_certificates: ["#{CERTIFICATE_DIR}/ca_certificate.pem"],
         verify_peer: verify_peer)
       c.start
       c
     end
 
     after :each do
-      connection.close
+      subject.close
     end
 
     context "peer verification is off" do
@@ -150,7 +158,7 @@ unless ENV["CI"]
 
       it "sends the SNI details" do
         # https://github.com/ruby-amqp/bunny/issues/440
-        expect(connection.transport.socket.hostname).to_not be_empty
+        expect(subject.transport.socket.hostname).to_not be_empty
       end
     end
 
@@ -161,54 +169,54 @@ unless ENV["CI"]
 
       it "sends the SNI details" do
         # https://github.com/ruby-amqp/bunny/issues/440
-        expect(connection.transport.socket.hostname).to_not be_empty
+        expect(subject.transport.socket.hostname).to_not be_empty
       end
     end
   end
 
 
   describe "TLS connection to RabbitMQ with client certificates provided inline" do
-    let(:connection) do
+    let(:subject) do
       c = Bunny.new(username: "bunny_gem",
         password: "bunny_password",
         vhost: "bunny_testbed",
         tls: true,
-        tls_cert: File.read("./spec/tls/client_certificate.pem"),
-        tls_key: File.read("./spec/tls/client_key.pem"),
-        tls_ca_certificates: ["./spec/tls/ca_certificate.pem"],
+        tls_cert: File.read("#{CERTIFICATE_DIR}/client_certificate.pem"),
+        tls_key: File.read("#{CERTIFICATE_DIR}/client_key.pem"),
+        tls_ca_certificates: ["#{CERTIFICATE_DIR}/ca_certificate.pem"],
         verify_peer: false)
       c.start
       c
     end
 
     after :each do
-      connection.close
+      subject.close
     end
 
     include_examples "successful TLS connection"
   end
 
-  describe "TLS connection to RabbitMQ with tls_version TLSv1 specified" do
-    let(:connection) do
+  describe "TLS connection to RabbitMQ with tls_version TLSv1.1 specified" do
+    let(:subject) do
       c = Bunny.new(username: "bunny_gem",
         password: "bunny_password",
         vhost: "bunny_testbed",
         tls: true,
-        tls_protocol: :TLSv1,
-        tls_ca_certificates: ["./spec/tls/ca_certificate.pem"],
+        tls_protocol: :TLSv1_1,
+        tls_ca_certificates: ["#{CERTIFICATE_DIR}/ca_certificate.pem"],
         verify_peer: false)
       c.start
       c
     end
 
     after :each do
-      connection.close
+      subject.close
     end
 
     include_examples "successful TLS connection"
 
-    it "connects using TLSv1" do
-      expect(connection.transport.socket.ssl_version).to eq "TLSv1"
+    it "connects using TLSv1.1" do
+      expect(subject.transport.socket.ssl_version).to eq "TLSv1.1"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Chris Duncan
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amq-protocol
@@ -231,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Popular easy to use Ruby client for RabbitMQ