pwwka 0.8.0 → 0.9.0.RC1

data/spec/{handling_spec.rb → legacy/handling_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Pwwka::Handling do
+describe Pwwka::Handling, :legacy do
 
   class HKlass
     include Pwwka::Handling

data/spec/{receiver_spec.rb → legacy/receiver_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper.rb'
 
-describe Pwwka::Receiver do
+describe Pwwka::Receiver, :legacy do
 
   class HandyHandler
     def self.handle!(delivery_info, properties, payload)
@@ -18,6 +18,7 @@ describe Pwwka::Receiver do
     before(:each) do
       @original_logger = Pwwka.configuration.logger
       Pwwka.configuration.logger = logger
+      Pwwka.configuration.requeue_on_error = false
       allow(logger).to receive(:info)
       allow(logger).to receive(:error)
       @receiver = Pwwka::Receiver.subscribe(HandyHandler, "receiver_test", block: false)

data/spec/{send_message_async_job_spec.rb → legacy/send_message_async_job_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper.rb'
 
-describe Pwwka::SendMessageAsyncJob do
+describe Pwwka::SendMessageAsyncJob, :legacy do
 
   let(:payload) { Hash[:this, "that"] }
   let(:routing_key) { "this.that.and.theother" }

data/spec/{transmitter_spec.rb → legacy/transmitter_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper.rb'
 
-describe Pwwka::Transmitter do
+describe Pwwka::Transmitter, :legacy do
 
   before(:all) do
     @test_handler = Pwwka::TestHandler.new

data/spec/spec_helper.rb

@@ -1,22 +1,48 @@
 GEM_ROOT = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+
 ENV['RAILS_ENV']  ||= 'test'
+
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
 require 'pwwka'
 require 'pwwka/test_handler'
-Dir["#{GEM_ROOT}/spec/support/**/*.rb"].sort.each {|f| require f}
+require 'active_support/core_ext/hash'
+
+# These are required in pwwka proper, but they are guarded to not cause
+# an error if missing.  Requiring here so their absence will fail the tests
+require 'resque'
+require 'resque-retry'
+
+require 'support/test_configuration'
+
+test_configuration = TestConfiguration.new(File.join(GEM_ROOT,"docker-compose.yml"))
 
 RSpec.configure do |config|
 
   config.expect_with :rspec do |c|
-    c.syntax = :expect
+    c.syntax = [:should,:expect] # should is needed to make a resque helper 
+                                 # from resqutils work
   end
 
-  config.before(:all) do
+  config.before(:suite) do
     Pwwka.configure do |c|
-      c.topic_exchange_name     = "topics-test"
-      c.logger                  = MonoLogger.new("/dev/null")
-      c.options[:allow_delayed] = true
+      c.topic_exchange_name        = "topics-test"
+      c.options[:allow_delayed]    = true
+      c.requeue_on_error           = false
+      c.rabbit_mq_host             = "amqp://guest:guest@localhost:#{test_configuration.rabbit_port}"
+
+      unless ENV["SHOW_PWWKA_LOG"] == "true"
+        c.logger = MonoLogger.new("/dev/null")
+      end
     end
+    Resque.redis = Redis.new(port: test_configuration.resque_redis_port)
   end
 
+  config.order = :random
+  config.filter_run_excluding :legacy
 end
 

data/spec/support/test_configuration.rb

@@ -0,0 +1,10 @@
+require 'yaml'
+class TestConfiguration
+  attr_reader :resque_redis_port, :rabbit_port
+  def initialize(docker_compose_file)
+    yaml = YAML.load_file(docker_compose_file)
+
+    @resque_redis_port = (ENV["PWWKA_RESQUE_REDIS_PORT"] || yaml["services"]["resque"]["ports"].first.split(/:/)[0]).to_i
+    @rabbit_port       = (ENV["PWWKA_RABBIT_PORT"]       || yaml["services"]["rabbit"]["ports"].first.split(/:/)[0]).to_i
+  end
+end

data/spec/unit/channel_connector_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper.rb'
+
+# Most of this class is just interacting with Rabbit so it's covered
+# by the integration tests.
+describe Pwwka::ChannelConnector do
+  let(:bunny_session) { instance_double(Bunny::Session) }
+
+  before do
+    allow(Bunny).to receive(:new).and_return(bunny_session)
+    allow(bunny_session).to receive(:start)
+    allow(bunny_session).to receive(:create_channel)
+    @default_allow_delayed = Pwwka.configuration.options[:allow_delayed]
+  end
+
+  after do
+    Pwwka.configuration.options[:allow_delayed] = @default_allow_delayed
+  end
+
+  subject(:channel_connector) { described_class.new }
+
+  describe "raise_if_delayed_not_allowed" do
+    context "delayed is configured" do
+      it "does not blow up" do
+        Pwwka.configuration.options[:allow_delayed] = true
+        expect {
+          channel_connector.raise_if_delayed_not_allowed
+        }.not_to raise_error
+      end
+    end
+    context "delayed is not configured" do
+      it "blows up" do
+        Pwwka.configuration.options[:allow_delayed] = false
+        expect {
+          channel_connector.raise_if_delayed_not_allowed
+        }.to raise_error(Pwwka::ConfigurationError)
+      end
+    end
+  end
+
+end

data/spec/{message_queuer_spec.rb → unit/message_queuer_spec.rb}

@@ -33,8 +33,8 @@ describe Pwwka::MessageQueuer do
   describe "#send_messages_safely" do
 
     it "should send the queued messages" do
-      expect(message_queuer_with_messages).to receive(:send_message_safely).with(payload1, routing_key1).and_call_original
-      expect(message_queuer_with_messages).to receive(:send_message_safely).with(payload2, routing_key2, delayed: true, delay_by: 3500).and_call_original
+      expect(message_queuer_with_messages).to receive(:send_message_safely).with(payload1, routing_key1)
+      expect(message_queuer_with_messages).to receive(:send_message_safely).with(payload2, routing_key2, delayed: true, delay_by: 3500)
       message_queuer_with_messages.send_messages_safely
       expect(message_queuer_with_messages.message_queue).to eq([])
     end
@@ -44,8 +44,8 @@ describe Pwwka::MessageQueuer do
   describe "#send_messages!" do
 
     it "should send the queued messages" do
-      expect(message_queuer_with_messages).to receive(:send_message!).with(payload1, routing_key1).and_call_original
-      expect(message_queuer_with_messages).to receive(:send_message!).with(payload2, routing_key2, delayed: true, delay_by: 3500).and_call_original
+      expect(message_queuer_with_messages).to receive(:send_message!).with(payload1, routing_key1)
+      expect(message_queuer_with_messages).to receive(:send_message!).with(payload2, routing_key2, delayed: true, delay_by: 3500)
       message_queuer_with_messages.send_messages!
       expect(message_queuer_with_messages.message_queue).to eq([])
     end

data/spec/unit/test_handler_message_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Pwwka::TestHandler::Message do
+  let(:delivery_info) { double("delivery info") }
+  let(:properties) { double("properties") }
+  let(:payload) { { foo: "bar" }.to_json }
+
+  subject(:message) { described_class.new(delivery_info,properties,payload) }
+
+  describe "attributes" do
+    specify { expect(message.delivery_info).to eq(delivery_info) }
+    specify { expect(message.properties).to    eq(properties) }
+    specify { expect(message.payload).to       eq(JSON.parse(payload)) }
+  end
+
+  describe "splatting" do
+    it "extracts pieces during a splat" do
+      extracted_delivery_info,extracted_payload,extracted_properties,extracted_raw_payload = message
+      expect(extracted_delivery_info).to  eq(delivery_info)
+      expect(extracted_properties).to     eq(properties)
+      expect(extracted_payload).to        eq(JSON.parse(payload))
+      expect(extracted_raw_payload).to    eq(payload)
+    end
+  end
+
+end

data/spec/unit/transmitter_spec.rb

@@ -0,0 +1,229 @@
+require 'spec_helper.rb'
+
+describe Pwwka::Transmitter do
+  let(:topic_exchange) { double("topic exchange") }
+  let(:delayed_exchange) { double("delayed exchange") }
+  let(:channel_connector) { instance_double(Pwwka::ChannelConnector, topic_exchange: topic_exchange, delayed_exchange: delayed_exchange) }
+  let(:logger) { double(Logger) }
+  let(:payload) {
+    {
+      foo: { bar: "blah" },
+      crud: 12,
+    }
+  }
+  let(:routing_key) { "sf.foo.bar" }
+
+
+  before do
+    @original_logger = Pwwka.configuration.logger
+    Pwwka.configuration.logger = logger
+    allow(logger).to receive(:info)
+    allow(logger).to receive(:warn)
+    allow(logger).to receive(:error)
+    allow(Pwwka::ChannelConnector).to receive(:new).and_return(channel_connector)
+    allow(channel_connector).to receive(:connection_close)
+    allow(topic_exchange).to receive(:publish)
+    allow(delayed_exchange).to receive(:publish)
+  end
+
+  after do
+    Pwwka.configuration.logger = @original_logger
+  end
+
+  subject(:transmitter) { described_class.new }
+
+  describe ".send_message_async" do
+    before do
+      allow(Resque).to receive(:enqueue_in)
+    end
+
+    it "queues a Resque job" do
+      delay_by_ms = 3_000
+      described_class.send_message_async(payload,routing_key,delay_by_ms: delay_by_ms)
+      expect(Resque).to have_received(:enqueue_in).with(delay_by_ms/1_000,Pwwka::SendMessageAsyncJob,payload,routing_key)
+    end
+  end
+
+  shared_examples "it passes through to an instance" do
+    context "not using delayed flag" do
+      it "calls through to send_message!" do
+        expect_any_instance_of(described_class).to receive(:send_message!).with(payload,routing_key)
+        described_class.send(method,payload,routing_key)
+      end
+      it "logs after sending" do
+        described_class.send(method,payload,routing_key)
+        expect(logger).to have_received(:info).with(/AFTER Transmitting Message on #{routing_key} ->/)
+      end
+    end
+    context "using delayed flag" do
+
+      it "logs after sending" do
+        allow_any_instance_of(described_class).to receive(:send_delayed_message!)
+        described_class.send(method,payload,routing_key, delayed: true)
+        expect(logger).to have_received(:info).with(/AFTER Transmitting Message on #{routing_key} ->/)
+      end
+
+      context "explicitly setting delay time" do
+        it "calls through to send_delayed_message! using the given delay time" do
+          delay_by = 1_000
+          expect_any_instance_of(described_class).to receive(:send_delayed_message!).with(payload,routing_key,delay_by)
+          described_class.send(method,payload,routing_key,delayed: true, delay_by: delay_by)
+        end
+      end
+      context "using the default delay time" do
+        it "calls through to send_delayed_message! using its default delay time" do
+          expect_any_instance_of(described_class).to receive(:send_delayed_message!).with(payload,routing_key)
+          described_class.send(method,payload,routing_key,delayed: true)
+        end
+      end
+    end
+  end
+
+  describe ".send_message!" do
+    context "no errors" do
+      it_behaves_like "it passes through to an instance" do
+        let(:method) { :send_message! }
+      end
+    end
+    context "when there's an error" do
+      before do
+        allow_any_instance_of(described_class).to receive(:send_message!).and_raise("OH NOES")
+      end
+      it "logs the error" do
+        begin
+          described_class.send_message!(payload,routing_key)
+        rescue => ex
+        end
+        expect(logger).to have_received(:error).with(/ERROR Transmitting Message on #{routing_key} ->/)
+      end
+      context "on_error: :ignore" do
+        it "ignores the error" do
+          expect {
+            described_class.send_message!(payload,routing_key, on_error: :ignore)
+          }.not_to raise_error
+        end
+      end
+      context "on_error: :raise" do
+        it "raises the error" do
+          expect {
+            described_class.send_message!(payload,routing_key, on_error: :raise)
+          }.to raise_error(/OH NOES/)
+        end
+      end
+      context "on_error: :resque" do
+        it "queues a Resque job" do
+          allow(Resque).to receive(:enqueue_in)
+          described_class.send_message!(payload,routing_key, on_error: :resque)
+          expect(Resque).to have_received(:enqueue_in).with(0,Pwwka::SendMessageAsyncJob,payload,routing_key)
+        end
+        context "when there is a problem queueing the resque job" do
+          it "raises the original exception job" do
+            allow(Resque).to receive(:enqueue_in).and_raise("NOPE")
+            expect {
+              described_class.send_message!(payload,routing_key, on_error: :resque)
+            }.to raise_error(/OH NOES/)
+          end
+          it "logs the Resque error as a warning" do
+            allow(Resque).to receive(:enqueue_in).and_raise("NOPE")
+            begin
+              described_class.send_message!(payload,routing_key, on_error: :resque)
+            rescue => ex
+            end
+            expect(logger).to have_received(:warn).with(/NOPE/)
+          end
+        end
+      end
+    end
+  end
+  describe ".send_message_safely" do
+    context "no errors" do
+      it_behaves_like "it passes through to an instance" do
+        let(:method) { :send_message_safely }
+      end
+    end
+    context "when there's an error" do
+      before do
+        allow_any_instance_of(described_class).to receive(:send_message!).and_raise("OH NOES")
+      end
+      it "logs the error" do
+        begin
+          described_class.send_message_safely(payload,routing_key)
+        rescue => ex
+        end
+        expect(logger).to have_received(:error).with(/ERROR Transmitting Message on #{routing_key} ->/)
+      end
+      it "ignores the error" do
+        expect {
+          described_class.send_message_safely(payload,routing_key)
+        }.not_to raise_error
+      end
+    end
+  end
+
+  describe "#send_message!" do
+    it "returns true" do
+      expect(transmitter.send_message!(payload,routing_key)).to eq(true)
+    end
+
+    it "publishes the message" do
+      transmitter.send_message!(payload,routing_key)
+      expect(topic_exchange).to have_received(:publish).with(payload.to_json,routing_key: routing_key, persistent: true)
+    end
+
+    it "logs the start and end of the transmission" do
+      transmitter.send_message!(payload,routing_key)
+      expect(logger).to have_received(:info).with(/START Transmitting Message on #{routing_key} ->/)
+      expect(logger).to have_received(:info).with(/END Transmitting Message on #{routing_key} ->/)
+    end
+
+    it "closes the channel connector" do
+      transmitter.send_message!(payload,routing_key)
+      expect(channel_connector).to have_received(:connection_close)
+    end
+  end
+
+  describe "#send_delayed_message!" do
+    context "delayed queue properly configured" do
+      before do
+        allow(channel_connector).to receive(:raise_if_delayed_not_allowed)
+        allow(channel_connector).to receive(:create_delayed_queue)
+      end
+
+      it "returns true" do
+        expect(transmitter.send_delayed_message!(payload,routing_key)).to eq(true)
+      end
+
+      it "creates the delayed queue" do
+        transmitter.send_delayed_message!(payload,routing_key)
+        expect(channel_connector).to have_received(:create_delayed_queue)
+      end
+
+      it "publishes the message to the delayed exchange" do
+        delay_by = 12345
+        transmitter.send_delayed_message!(payload,routing_key, delay_by)
+        expect(delayed_exchange).to have_received(:publish).with(payload.to_json,routing_key: routing_key, expiration: delay_by, persistent: true)
+      end
+
+      it "logs the start and end of the transmission" do
+        transmitter.send_delayed_message!(payload,routing_key)
+        expect(logger).to have_received(:info).with(/START Transmitting Delayed Message on #{routing_key} ->/)
+        expect(logger).to have_received(:info).with(/END Transmitting Delayed Message on #{routing_key} ->/)
+      end
+      it "closes the channel connector" do
+        transmitter.send_delayed_message!(payload,routing_key)
+        expect(channel_connector).to have_received(:connection_close)
+      end
+    end
+    context "delayed queue not configured" do
+      before do
+        allow(channel_connector).to receive(:raise_if_delayed_not_allowed).and_raise("NOPE")
+      end
+      it "blows up" do
+        expect {
+          transmitter.send_delayed_message!(payload,routing_key)
+        }.to raise_error(/NOPE/)
+      end
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pwwka
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0.RC1
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-16 00:00:00.000000000 Z
+date: 2017-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -115,6 +115,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resqutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   The purpose of this gem is to normalise the sending and
     receiving of messages between Rails apps using the shared RabbitMQ
@@ -143,6 +185,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docker-compose.yml
 - docs/images/RabbitMQ_Management-2.png
 - docs/images/RabbitMQ_Management-3.png
 - docs/images/RabbitMQ_Management.png
@@ -160,14 +203,25 @@ files:
 - lib/pwwka/transmitter.rb
 - lib/pwwka/version.rb
 - pwwka.gemspec
-- spec/handling_spec.rb
-- spec/logging_spec.rb
-- spec/message_queuer_spec.rb
-- spec/queue_resque_job_handler_spec.rb
-- spec/receiver_spec.rb
-- spec/send_message_async_job_spec.rb
+- spec/integration/interrupted_receivers_spec.rb
+- spec/integration/send_and_receive_spec.rb
+- spec/integration/support/integration_test_helpers.rb
+- spec/integration/support/integration_test_setup.rb
+- spec/integration/support/logging_receiver.rb
+- spec/integration/test_handler_spec.rb
+- spec/integration/unhandled_errors_in_receivers_spec.rb
+- spec/legacy/handling_spec.rb
+- spec/legacy/receiver_spec.rb
+- spec/legacy/send_message_async_job_spec.rb
+- spec/legacy/transmitter_spec.rb
 - spec/spec_helper.rb
-- spec/transmitter_spec.rb
+- spec/support/test_configuration.rb
+- spec/unit/channel_connector_spec.rb
+- spec/unit/logging_spec.rb
+- spec/unit/message_queuer_spec.rb
+- spec/unit/queue_resque_job_handler_spec.rb
+- spec/unit/test_handler_message_spec.rb
+- spec/unit/transmitter_spec.rb
 homepage: https://github.com/stitchfix/pwwka
 licenses:
 - MIT
@@ -183,9 +237,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1
@@ -193,11 +247,22 @@ signing_key:
 specification_version: 4
 summary: Send and receive messages via RabbitMQ
 test_files:
-- spec/handling_spec.rb
-- spec/logging_spec.rb
-- spec/message_queuer_spec.rb
-- spec/queue_resque_job_handler_spec.rb
-- spec/receiver_spec.rb
-- spec/send_message_async_job_spec.rb
+- spec/integration/interrupted_receivers_spec.rb
+- spec/integration/send_and_receive_spec.rb
+- spec/integration/support/integration_test_helpers.rb
+- spec/integration/support/integration_test_setup.rb
+- spec/integration/support/logging_receiver.rb
+- spec/integration/test_handler_spec.rb
+- spec/integration/unhandled_errors_in_receivers_spec.rb
+- spec/legacy/handling_spec.rb
+- spec/legacy/receiver_spec.rb
+- spec/legacy/send_message_async_job_spec.rb
+- spec/legacy/transmitter_spec.rb
 - spec/spec_helper.rb
-- spec/transmitter_spec.rb
+- spec/support/test_configuration.rb
+- spec/unit/channel_connector_spec.rb
+- spec/unit/logging_spec.rb
+- spec/unit/message_queuer_spec.rb
+- spec/unit/queue_resque_job_handler_spec.rb
+- spec/unit/test_handler_message_spec.rb
+- spec/unit/transmitter_spec.rb