message-driver 0.3.0 → 0.4.0

data/features/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.4.0 - 2014-07-03
+
+* require bunny 1.2.2 or later
+* add support for publish confirmations
+
 ## 0.3.0 - 2014-02-26
 
 * Support for handling multiple broker connections

data/features/message_consumers/transactional_ack_consumers.feature

@@ -32,6 +32,7 @@ Feature: Transactional Consumers
       | Test Message 1 |
       | Test Message 2 |
 
+  @no_ci
   Scenario: When an error occurs
     Given I have a message consumer
     """ruby

data/features/rabbitmq_specific_features/publisher_acknowledgements.feature

@@ -0,0 +1,51 @@
+@bunny
+Feature: Publisher Acknowledgements
+
+  RabbitMQ supports confirmation of published messages
+  See http://www.rabbitmq.com/confirms.html for details.
+
+  Verifying the publish of a single message and of a group of messages is
+  supported as described below.
+
+  Background:
+    Given I am connected to the broker
+    And I have a destination :publish_ack with no messages on it
+
+  Scenario: Publishing a single message with confirmations turned on
+    When I execute the following code
+    """"ruby
+    publish(:publish_ack, "Test Message", {}, confirm: true)
+    """
+
+    Then I expect all the publishes to have been acknowledged
+    And I expect to find the following message on :publish_ack
+      | body         |
+      | Test Message |
+
+
+  Scenario: Publishing a single message where confirmations are turned on by the destination
+    When I execute the following code
+    """"ruby
+    my_new_destination = MessageDriver::Client.dynamic_destination(:publish_ack, {}, {confirm: true})
+    my_new_destination.publish("Test Message")
+    """
+
+    Then I expect all the publishes to have been acknowledged
+    And I expect to find the following message on :publish_ack
+      | body         |
+      | Test Message |
+
+
+  Scenario: Publishing a batch of messages with confirmations turned on
+    When I execute the following code
+    """"ruby
+    with_message_transaction(type: :confirm_and_wait) do
+      50.times do |i|
+        publish(:publish_ack, "Test Message #{i}")
+      end
+    end
+    """
+
+    Then I expect all the publishes to have been acknowledged
+    And I expect that we are not in transaction mode
+    And I expect to find 50 messages on :publish_ack

data/features/step_definitions/error_handling_steps.rb

@@ -1,9 +1,9 @@
-When "the broker goes down" do
+When 'the broker goes down' do
   block_broker_port
   sleep 2
 end
 
-When "the broker comes up" do
+When 'the broker comes up' do
   unblock_broker_port
   sleep 20
 end

data/features/step_definitions/logging_steps.rb

@@ -1,22 +1,22 @@
 require 'logger'
 
-LOG_FILE_NAME = "cucumber_log_file.log"
+LOG_FILE_NAME = 'cucumber_log_file.log'
 
 Given(/^I am logging to a log file(?: at the (#{STRING_OR_SYM}) level)?$/) do |level|
   step "an empty file named \"#{LOG_FILE_NAME}\""
   in_current_dir do
     @logger = Logger.new(LOG_FILE_NAME)
   end
-  step "I set the log level to #{level || "info"}"
+  step "I set the log level to #{level || 'info'}"
   @orig_logger, MessageDriver.logger = MessageDriver.logger, @logger
 end
 
 Given(/^I set the log level to (#{STRING_OR_SYM})$/) do |level|
-  level = level ? level.to_s.upcase : "INFO"
+  level = level ? level.to_s.upcase : 'INFO'
   @logger.level = Logger::SEV_LABEL.find_index(level)
 end
 
-Then "the log file should contain:" do |string|
+Then 'the log file should contain:' do |string|
   step "the file \"#{LOG_FILE_NAME}\" should contain:", string
 end
 

data/features/step_definitions/message_consumers_steps.rb

@@ -1,4 +1,4 @@
-Given "I have a message consumer" do |src|
+Given 'I have a message consumer' do |src|
   test_runner.run_config_code(src)
   expect(test_runner).to have_no_errors
 end
@@ -7,18 +7,18 @@ Given(/^I subscribe to (#{STRING_OR_SYM}) with (#{STRING_OR_SYM})$/) do |destina
   MessageDriver::Client[test_runner.broker_name].subscribe(destination, consumer)
 end
 
-Given "I create a subscription" do |src|
+Given 'I create a subscription' do |src|
   test_runner.run_test_code("@subscription = #{src}")
   expect(test_runner).to have_no_errors
 end
 
-When "I cancel the subscription" do
-  test_runner.run_test_code("@subscription.unsubscribe")
-  step "I allow for processing"
+When 'I cancel the subscription' do
+  test_runner.run_test_code('@subscription.unsubscribe')
+  step 'I allow for processing'
 end
 
-When "I let the subscription process" do
-  step "I allow for processing"
-  step "I cancel the subscription"
+When 'I let the subscription process' do
+  step 'I allow for processing'
+  step 'I cancel the subscription'
   expect(test_runner).to have_no_errors
 end

data/features/step_definitions/rabbitmq_specific_steps.rb

@@ -0,0 +1,10 @@
+Then 'I expect all the publishes to have been acknowledged' do
+  ctx = test_runner.fetch_current_adapter_context
+  expect(ctx.channel).to be_using_publisher_confirms
+  expect(ctx.channel.unconfirmed_set).to be_empty
+end
+
+Then 'I expect that we are not in transaction mode' do
+  ctx = test_runner.fetch_current_adapter_context
+  expect(ctx).not_to be_transactional
+end

data/features/step_definitions/steps.rb

@@ -1,18 +1,18 @@
-Given "I am connected to the broker" do
+Given 'I am connected to the broker' do
   MessageDriver::Broker.configure(test_runner.broker_name, broker_config)
 end
 
 Given(/^I am connected to a broker named (#{STRING_OR_SYM})$/) do |broker_name|
   test_runner.broker_name = broker_name
-  step "I am connected to the broker"
+  step 'I am connected to the broker'
 end
 
-Given "the following broker configuration" do |src|
-  step "I am connected to the broker"
+Given 'the following broker configuration' do |src|
+  step 'I am connected to the broker'
   test_runner.run_config_code(src)
 end
 
-Given "I configure my broker as follows" do |src|
+Given 'I configure my broker as follows' do |src|
   test_runner.run_config_code(src)
 end
 
@@ -23,14 +23,14 @@ Given(/^I have a destination (#{STRING_OR_SYM})$/) do |destination|
 end
 
 Given(/^I have a destination (#{STRING_OR_SYM}) with no messages on it$/) do |destination|
-  dest = destination.kind_of?(Symbol) ? destination.inspect : destination.to_s
+  dest = destination.is_a?(Symbol) ? destination.inspect : destination.to_s
   step "I have a destination #{dest}"
   test_runner.purge_destination(destination)
 end
 
 Given(/^I have the following messages? on (#{STRING_OR_SYM})$/) do |destination, table|
   test_runner.purge_destination(destination)
-  dest = destination.kind_of?(Symbol) ? destination.inspect : destination.to_s
+  dest = destination.is_a?(Symbol) ? destination.inspect : destination.to_s
   step "I send the following messages to #{dest}", table
 end
 
@@ -44,15 +44,15 @@ When(/^I send the following messages? to (#{STRING_OR_SYM})$/) do |destination,
   end
 end
 
-When "I execute the following code" do |src|
+When 'I execute the following code' do |src|
   test_runner.run_test_code(src)
 end
 
-When "I reset the context" do
+When 'I reset the context' do
   MessageDriver::Client[test_runner.broker_name].current_adapter_context.invalidate
 end
 
-When "I allow for processing" do
+When 'I allow for processing' do
   test_runner.pause_if_needed
 end
 
@@ -70,7 +70,7 @@ Then(/^I expect to find the following (#{NUMBER}) messages? on (#{STRING_OR_SYM}
 end
 
 Then(/^I expect to find the following message on (#{STRING_OR_SYM})$/) do |destination, table|
-  dest = destination.kind_of?(Symbol) ? destination.inspect : destination.to_s
+  dest = destination.is_a?(Symbol) ? destination.inspect : destination.to_s
   step "I expect to find the following 1 message on #{dest}", table
 end
 
@@ -87,13 +87,13 @@ Then(/^I expect it to raise a (.*?) error$/) do |error_type|
   test_runner.raised_error = nil
 end
 
-Then "I expect to have no errors" do
+Then 'I expect to have no errors' do
   expect(test_runner).to have_no_errors
 end
 
-Then "I expect the following check to pass" do |src|
-  step "I execute the following code", src
-  step "I expect to have no errors"
+Then 'I expect the following check to pass' do |src|
+  step 'I execute the following code', src
+  step 'I expect to have no errors'
 end
 
 Before do |current_scenario|

data/features/support/env.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require File.join(File.dirname(__FILE__), '..', '..', 'test_lib', 'broker_config')
 
 require 'aruba/cucumber'

data/features/support/firewall_helper.rb

@@ -1,5 +1,4 @@
 module FirewallHelper
-
   def self.port
     BrokerConfig.current_adapter_port
   end
@@ -7,18 +6,18 @@ module FirewallHelper
   COMMANDS = {
     darwin: {
       setup: [
-        "lunchy stop rabbit"
+        'lunchy stop rabbit'
       ],
       teardown: [
-        "lunchy start rabbit"
+        'lunchy start rabbit'
       ]
     },
     linux: {
       setup: [
-        "sudo service rabbitmq-server stop"
+        'sudo service rabbitmq-server stop'
       ],
       teardown: [
-        "sudo service rabbitmq-server start"
+        'sudo service rabbitmq-server start'
       ]
     }
   }
@@ -49,7 +48,7 @@ module FirewallHelper
   end
 
   def darwin?
-    system("uname | grep Darwin")
+    system('uname | grep Darwin')
   end
 end
 

data/features/support/message_table_matcher.rb

@@ -4,10 +4,9 @@ RSpec::Matchers.define :match_message_table do |expected_tbl|
   end
 
   define_method :messages_to_hash do |messages|
-    messages.collect do |msg|
-      expected_tbl.headers.inject({ }) do |memo, obj|
-        memo[obj] = msg.send(obj)
-        memo
+    messages.map do |msg|
+      expected_tbl.headers.each_with_object({}) do |method, hash|
+        hash[method] = msg.send(method)
       end
     end
   end

data/features/support/no_error_matcher.rb

@@ -1,13 +1,13 @@
 RSpec::Matchers.define :have_no_errors do
   match do |test_runner|
-    test_runner.raised_error == nil
+    test_runner.raised_error.nil?
   end
 
   failure_message_for_should do |test_runner|
     err = test_runner.raised_error
     filtered = (err.backtrace || []).reject do |line|
-      Cucumber::Ast::StepInvocation::BACKTRACE_FILTER_PATTERNS.detect { |p| line =~ p }
+      Cucumber::Ast::StepInvocation::BACKTRACE_FILTER_PATTERNS.find { |p| line =~ p }
     end
-    (["#{err.class}: #{err.to_s}"]+filtered).join("\n  ")
+    (["#{err.class}: #{err}"]+filtered).join("\n  ")
   end
 end

data/features/support/test_runner.rb

@@ -26,10 +26,14 @@ class TestRunner
     destination = fetch_destination(destination_name)
     pause_if_needed
     result = []
-    begin
+    loop do
       msg = destination.pop_message
-      result << msg unless msg.nil?
-    end until msg.nil?
+      if msg.nil?
+        break
+      else
+        result << msg
+      end
+    end
     result
   end
 
@@ -53,6 +57,10 @@ class TestRunner
     end
   end
 
+  def fetch_current_adapter_context
+    MessageDriver::Client[self.broker_name].current_adapter_context
+  end
+
   def publish_table_to_destination(destination, table)
     table.hashes.each do |msg|
       destination.publish(msg[:body], msg[:headers]||{}, msg[:properties]||{})

data/features/support/transforms.rb

@@ -1,6 +1,6 @@
 NUMBER = Transform(/^\d+|no$/) do |num|
   case num
-  when "no"
+  when 'no'
     0
   else
     num.to_i

data/lib/message-driver.rb

@@ -1 +1 @@
-require "message_driver"
+require 'message_driver'

data/lib/message_driver.rb

@@ -23,5 +23,4 @@ module MessageDriver
   def logger=(logger)
     @__logger = logger
   end
-
 end

data/lib/message_driver/adapters/base.rb

@@ -9,8 +9,8 @@ module MessageDriver
         @contexts ||= []
       end
 
-      def initialize(broker, configuration)
-        raise "Must be implemented in subclass"
+      def initialize(_broker, _configuration)
+        raise 'Must be implemented in subclass'
       end
 
       def new_context
@@ -20,7 +20,7 @@ module MessageDriver
       end
 
       def build_context
-        raise "Must be implemented in subclass"
+        raise 'Must be implemented in subclass'
       end
 
       def reset_after_tests
@@ -47,20 +47,20 @@ module MessageDriver
         @valid = true
       end
 
-      def publish(destination, body, headers={}, properties={})
-        raise "Must be implemented in subclass"
+      def publish(_destination, _body, _headers={}, _properties={})
+        raise 'Must be implemented in subclass'
       end
 
-      def pop_message(destination, options={})
-        raise "Must be implemented in subclass"
+      def pop_message(_destination, _options={})
+        raise 'Must be implemented in subclass'
       end
 
-      def subscribe(destination, options={}, &consumer)
+      def subscribe(_destination, _options={}, &_consumer)
         raise "#subscribe is not supported by #{adapter.class}"
       end
 
-      def create_destination(name, dest_options={}, message_props={})
-        raise "Must be implemented in subclass"
+      def create_destination(_name, _dest_options={}, _message_props={})
+        raise 'Must be implemented in subclass'
       end
 
       def valid?

data/lib/message_driver/adapters/bunny_adapter.rb

@@ -46,13 +46,13 @@ module MessageDriver
 
       class QueueDestination < Destination
         def after_initialize(adapter_context)
-          unless @dest_options[:no_declare]
+          if @dest_options[:no_declare]
+            raise MessageDriver::Error, 'server-named queues must be declared, but you provided :no_declare => true' if @name.empty?
+            raise MessageDriver::Error, 'queues with bindings must be declared, but you provided :no_declare => true' if @dest_options[:bindings]
+          else
             adapter_context.with_channel(false) do |ch|
               bunny_queue(ch, true)
             end
-          else
-            raise MessageDriver::Error, "server-named queues must be declared, but you provided :no_declare => true" if @name.empty?
-            raise MessageDriver::Error, "queues with bindings must be declared, but you provided :no_declare => true" if @dest_options[:bindings]
           end
         end
 
@@ -60,7 +60,7 @@ module MessageDriver
           queue = channel.queue(@name, @dest_options)
           if initialize
             @name = queue.name
-            if bindings = @dest_options[:bindings]
+            if (bindings = @dest_options[:bindings])
               bindings.each do |bnd|
                 raise MessageDriver::Error, "binding #{bnd.inspect} must provide a source!" unless bnd[:source]
                 queue.bind(bnd[:source], bnd[:args]||{})
@@ -71,10 +71,10 @@ module MessageDriver
         end
 
         def exchange_name
-          ""
+          ''
         end
 
-        def routing_key(properties)
+        def routing_key(_properties)
           @name
         end
 
@@ -93,14 +93,14 @@ module MessageDriver
 
       class ExchangeDestination < Destination
         def after_initialize(adapter_context)
-          if declare = @dest_options[:declare]
+          if (declare = @dest_options[:declare])
             adapter_context.with_channel(false) do |ch|
               type = declare.delete(:type)
-              raise MessageDriver::Error, "you must provide a valid exchange type" unless type
+              raise MessageDriver::Error, 'you must provide a valid exchange type' unless type
               ch.exchange_declare(@name, type, declare)
             end
           end
-          if bindings = @dest_options[:bindings]
+          if (bindings = @dest_options[:bindings])
             adapter_context.with_channel(false) do |ch|
               bindings.each do |bnd|
                 raise MessageDriver::Error, "binding #{bnd.inspect} must provide a source!" unless bnd[:source]
@@ -113,7 +113,7 @@ module MessageDriver
 
       class Subscription < Subscription::Base
         def start
-          raise MessageDriver::Error, "subscriptions are only supported with QueueDestinations" unless destination.is_a? QueueDestination
+          raise MessageDriver::Error, 'subscriptions are only supported with QueueDestinations' unless destination.is_a? QueueDestination
           @sub_ctx = adapter.new_subscription_context(self)
           @error_handler = options[:error_handler]
           @ack_mode = case options[:ack]
@@ -141,10 +141,11 @@ module MessageDriver
         end
 
         private
+
         def start_subscription
           @sub_ctx.with_channel do |ch|
             queue = destination.bunny_queue(@sub_ctx.channel)
-            if options.has_key? :prefetch_size
+            if options.key? :prefetch_size
               ch.prefetch(options[:prefetch_size])
             end
             @bunny_consumer = queue.subscribe(options.merge(manual_ack: true)) do |delivery_info, properties, payload|
@@ -213,7 +214,7 @@ module MessageDriver
       def stop
         begin
           super
-          @connection.close if !@connection.nil?
+          @connection.close unless @connection.nil?
         rescue => e
           logger.error "error while attempting connection close\n#{exception_to_str(e)}"
         ensure
@@ -263,34 +264,48 @@ module MessageDriver
         def begin_transaction(options={})
           raise MessageDriver::TransactionError, "you can't begin another transaction, you are already in one!" if in_transaction?
           @in_transaction = true
+          @in_confirms_transaction = true if options[:type] == :confirm_and_wait
         end
 
         def commit_transaction(channel_commit=false)
           raise MessageDriver::TransactionError, "you can't finish the transaction unless you already in one!" if !in_transaction? && !channel_commit
           begin
-            if is_transactional? && valid? && !@need_channel_reset
-              handle_errors do
-                if @rollback_only
-                  @channel.tx_rollback
-                else
-                  @channel.tx_commit
+            if @in_confirms_transaction
+              wait_for_confirms(@channel) unless @rollback_only
+            else
+              if is_transactional? && valid? && !@need_channel_reset
+                handle_errors do
+                  if @rollback_only
+                    @channel.tx_rollback
+                  else
+                    @channel.tx_commit
+                  end
                 end
               end
             end
           ensure
             @rollback_only = false
             @in_transaction = false
+            @in_confirms_transaction = false
+          end
+        end
+
+        def wait_for_confirms(channel)
+          until channel.unconfirmed_set.empty?
+            channel.wait_for_confirms
           end
         end
+        private :wait_for_confirms
 
         def rollback_transaction
           @rollback_only = true
           commit_transaction
         end
 
-        def is_transactional?
+        def transactional?
           @is_transactional
         end
+        alias_method :is_transactional?, :transactional?
 
         def in_transaction?
           @in_transaction
@@ -298,8 +313,14 @@ module MessageDriver
 
         def publish(destination, body, headers={}, properties={})
           exchange, routing_key, props = *destination.publish_params(headers, properties)
+          confirm = props.delete(:confirm)
+          confirm = false if confirm.nil?
           with_channel(true) do |ch|
+            if confirm == true
+              ch.confirm_select unless ch.using_publisher_confirms?
+            end
             ch.basic_publish(body, exchange, routing_key, props)
+            ch.wait_for_confirms if confirm == true
           end
         end
 
@@ -309,7 +330,7 @@ module MessageDriver
           with_channel(false) do |ch|
             queue = ch.queue(destination.name, passive: true)
 
-            message = queue.pop(ack: !!options[:client_ack])
+            message = queue.pop(ack: options.fetch(:client_ack, false))
             if message.nil? || message[0].nil?
               nil
             else
@@ -322,14 +343,14 @@ module MessageDriver
           true
         end
 
-        def ack_message(message, options={})
+        def ack_message(message, _options={})
           with_channel(true) do |ch|
             ch.ack(message.delivery_tag)
           end
         end
 
         def nack_message(message, options={})
-          requeue = options[:requeue].kind_of?(FalseClass) ? false : true
+          requeue = options[:requeue].is_a?(FalseClass) ? false : true
           with_channel(true) do |ch|
             ch.reject(message.delivery_tag, requeue)
           end
@@ -371,7 +392,7 @@ module MessageDriver
           rescue Bunny::ChannelLevelException => e
             @need_channel_reset = true
             @rollback_only = true if in_transaction?
-            if e.kind_of? Bunny::NotFound
+            if e.is_a? Bunny::NotFound
               raise MessageDriver::QueueNotFound.new(e.to_s, e)
             else
               raise MessageDriver::WrappedError.new(e.to_s, e)
@@ -389,12 +410,18 @@ module MessageDriver
 
         def with_channel(require_commit=true)
           raise MessageDriver::TransactionRollbackOnly if @rollback_only
-          raise MessageDriver::Error, "this adapter context is not valid!" if !valid?
+          raise MessageDriver::Error, 'this adapter context is not valid!' unless valid?
           @channel = adapter.connection.create_channel if @channel.nil?
           reset_channel if @need_channel_reset
-          if in_transaction? && !is_transactional?
-            @channel.tx_select
-            @is_transactional = true
+          if in_transaction?
+            if @in_confirms_transaction
+              @channel.confirm_select unless @channel.using_publisher_confirmations?
+            else
+              unless is_transactional?
+                @channel.tx_select
+                @is_transactional = true
+              end
+            end
           end
           handle_errors do
             result = yield @channel
@@ -430,10 +457,10 @@ module MessageDriver
       end
 
       def validate_bunny_version
-        required = Gem::Requirement.create('>= 1.1.3')
+        required = Gem::Requirement.create('>= 1.2.2')
         current = Gem::Version.create(Bunny::VERSION)
         unless required.satisfied_by? current
-          raise MessageDriver::Error, "bunny 1.1.3 or later is required for the bunny adapter"
+          raise MessageDriver::Error, 'bunny 1.2.2 or later is required for the bunny adapter'
         end
       end
     end