hutch 0.25.0.pre.rc1-java → 2.0.0-java

data/spec/hutch/cli_spec.rb

@@ -4,6 +4,19 @@ require 'tempfile'
 describe Hutch::CLI do
   let(:cli) { Hutch::CLI.new }
 
+  describe "#start_work_loop" do
+    context "connection error during setup" do
+      let(:error) { Hutch::ConnectionError.new }
+      it "gets reported using error handlers" do
+        allow(Hutch).to receive(:connect).and_raise(error)
+        Hutch::Config[:error_handlers].each do |backend|
+          expect(backend).to receive(:handle_setup_exception).with(error)
+        end
+        cli.start_work_loop
+      end
+    end
+  end
+
   describe "#parse_options" do
     context "--config" do
       context "when the config file does not exist" do
@@ -18,9 +31,10 @@ describe Hutch::CLI do
       end
 
       context "when the config file exists" do
-        let(:file) do
-          Tempfile.new("hutch-test-config.yaml").to_path
-        end
+        # Kept in a let, so the Tempfile is not garbage collected - and with it
+        # unlinked - before the CLI checks that the path exists.
+        let(:config_file) { Tempfile.new("hutch-test-config.yaml") }
+        let(:file) { config_file.to_path }
 
         it "parses the config" do
           expect(Hutch::Config).to receive(:load_from_file)
@@ -42,9 +56,10 @@ describe Hutch::CLI do
       end
 
       context "when the keyfile file exists" do
-        let(:file) do
-          Tempfile.new("hutch-test-key.pem").to_path
-        end
+        # Kept in a let, so the Tempfile is not garbage collected - and with it
+        # unlinked - before the CLI checks that the path exists.
+        let(:key_file) { Tempfile.new("hutch-test-key.pem") }
+        let(:file) { key_file.to_path }
 
         it "sets mq_tls_key to the file" do
           expect(Hutch::Config).to receive(:mq_tls_key=)
@@ -66,9 +81,10 @@ describe Hutch::CLI do
       end
 
       context "when the certfile file exists" do
-        let(:file) do
-          Tempfile.new("hutch-test-cert.pem").to_path
-        end
+        # Kept in a let, so the Tempfile is not garbage collected - and with it
+        # unlinked - before the CLI checks that the path exists.
+        let(:cert_file) { Tempfile.new("hutch-test-cert.pem") }
+        let(:file) { cert_file.to_path }
 
         it "sets mq_tls_cert to the file" do
           expect(Hutch::Config).to receive(:mq_tls_cert=)

data/spec/hutch/config_spec.rb

@@ -31,12 +31,10 @@ describe Hutch::Config do
     end
 
     context 'for invalid attributes' do
-      let(:invalid_get) do
-        -> { Hutch::Config.get(:invalid_attr) }
-      end
+      let(:invalid_get) { Hutch::Config.get(:invalid_attr) }
 
       specify do
-        expect(invalid_get).to raise_error Hutch::UnknownAttributeError
+        expect { invalid_get }.to raise_error Hutch::UnknownAttributeError
       end
     end
   end
@@ -49,15 +47,89 @@ describe Hutch::Config do
       context 'sets value in user config hash' do
         it { is_expected.to eq(new_value) }
       end
+
+      context 'type casting' do
+        context 'number attributes' do
+          before  { Hutch::Config.set(:heartbeat, new_value) }
+          subject(:value) { Hutch::Config.user_config[:heartbeat] }
+
+          let(:new_value) { "0" }
+
+
+          specify 'casts values to integers' do
+            expect(value).to eq 0
+          end
+        end
+      end
+
+      context 'boolean attributes' do
+        context 'from non-empty string' do
+          before  { Hutch::Config.set(:autoload_rails, new_value) }
+          subject(:value) { Hutch::Config.user_config[:autoload_rails] }
+
+          let(:new_value) { "t" }
+
+
+          specify 'casts values to booleans' do
+            expect(value).to eq true
+          end
+        end
+
+        context 'from empty string' do
+          before  { Hutch::Config.set(:autoload_rails, new_value) }
+          subject(:value) { Hutch::Config.user_config[:autoload_rails] }
+
+          let(:new_value) { "" }
+
+
+          specify 'casts values to booleans' do
+            expect(value).to eq false
+          end
+        end
+
+        context 'from boolean' do
+          before  { Hutch::Config.set(:autoload_rails, new_value) }
+          subject(:value) { Hutch::Config.user_config[:autoload_rails] }
+
+          let(:new_value) { true }
+
+
+          specify 'casts values to booleans' do
+            expect(value).to eq true
+          end
+        end
+
+        context 'from nil' do
+          before  { Hutch::Config.set(:autoload_rails, new_value) }
+          subject(:value) { Hutch::Config.user_config[:autoload_rails] }
+
+          let(:new_value) { nil }
+
+
+          specify 'casts values to booleans' do
+            expect(value).to eq false
+          end
+        end
+      end
+
+      context 'string attributes' do
+        before  { Hutch::Config.set(:mq_exchange_type, new_value) }
+        subject(:value) { Hutch::Config.user_config[:mq_exchange_type] }
+
+        let(:new_value) { 1 }
+
+
+        specify 'does not perform any typecasting' do
+          expect(value).to eq new_value
+        end
+      end
     end
 
     context 'for invalid attributes' do
-      let(:invalid_set) do
-        -> { Hutch::Config.set(:invalid_attr, new_value) }
-      end
+      let(:invalid_set) { Hutch::Config.set(:invalid_attr, new_value) }
 
       specify do
-        expect(invalid_set).to raise_error Hutch::UnknownAttributeError
+        expect { invalid_set }.to raise_error Hutch::UnknownAttributeError
       end
     end
   end
@@ -71,8 +143,8 @@ describe Hutch::Config do
     end
 
     context 'for an invalid attribute' do
-      let(:invalid_getter) { -> { Hutch::Config.invalid_attr } }
-      specify { expect(invalid_getter).to raise_error NoMethodError }
+      let(:invalid_getter) { Hutch::Config.invalid_attr }
+      specify { expect { invalid_getter }.to raise_error NoMethodError }
     end
 
     context 'for an ENV-overriden value attribute' do
@@ -109,8 +181,8 @@ describe Hutch::Config do
     end
 
     context 'for an invalid attribute' do
-      let(:invalid_setter) { -> { Hutch::Config.invalid_attr = new_value } }
-      specify { expect(invalid_setter).to raise_error NoMethodError }
+      let(:invalid_setter) { Hutch::Config.invalid_attr = new_value }
+      specify { expect { invalid_setter }.to raise_error NoMethodError }
     end
   end
 

data/spec/hutch/consumer_spec.rb

@@ -28,6 +28,32 @@ describe Hutch::Consumer do
     ComplexConsumer
   end
 
+  let(:consumer_using_quorum_queue) do
+    unless defined? ConsumerUsingQuorumQueue
+      class ConsumerUsingQuorumQueue
+        include Hutch::Consumer
+        consume 'hutch.test1'
+        arguments foo: :bar
+        
+        quorum_queue
+      end
+    end
+    ConsumerUsingQuorumQueue
+  end
+
+  let(:consumer_using_classic_queue) do
+    unless defined? ConsumerUsingLazyQueue
+      class ConsumerUsingLazyQueue
+        include Hutch::Consumer
+        consume 'hutch.test1'
+        arguments foo: :bar
+        lazy_queue
+        classic_queue
+      end
+    end
+    ConsumerUsingLazyQueue
+  end
+
   describe 'module inclusion' do
     it 'registers the class as a consumer' do
       expect(Hutch).to receive(:register_consumer) do |klass|
@@ -71,6 +97,54 @@ describe Hutch::Consumer do
     end
   end
 
+  describe '.without_namespace' do
+    it 'is false by default' do
+      expect(simple_consumer.without_namespace?).to eq(false)
+    end
+
+    it 'returns true after calling without_namespace' do
+      simple_consumer.without_namespace
+      expect(simple_consumer.without_namespace?).to eq(true)
+    end
+  end
+
+  describe 'default queue mode' do
+    it 'does not specify any mode by default' do
+      expect(simple_consumer.queue_mode).to eq(nil)
+      expect(simple_consumer.queue_type).to eq(nil)
+    end
+  end
+
+  describe '.lazy_queue' do
+    context 'when queue mode has been set explicitly to lazy' do
+      it 'sets queue mode to lazy' do
+        expect(consumer_using_classic_queue.queue_mode).to eq('lazy')
+      end
+    end
+  end
+
+  describe '.classic_queue' do
+    context 'when queue type has been set explicitly to classic' do
+      it 'sets queue type to classic' do
+        expect(consumer_using_classic_queue.queue_type).to eq('classic')
+      end
+    end
+  end
+
+  describe '.quorum_queue' do
+    context 'when queue type has been set explicitly to quorum' do
+      it 'sets queue type to quorum' do
+        expect(consumer_using_quorum_queue.queue_type).to eq('quorum')
+      end
+
+      it 'accepts initial group size as an option' do
+        consumer = simple_consumer
+        expect { consumer.quorum_queue(initial_group_size: 3) }
+          .to change { consumer.initial_group_size }.to(3)
+      end
+    end
+  end
+
   describe '.arguments' do
     let(:args) { { foo: :bar} }
 
@@ -82,15 +156,30 @@ describe Hutch::Consumer do
   end
 
   describe '.get_arguments' do
-
     context 'when defined' do
-      it { expect(complex_consumer.get_arguments).to eq(foo: :bar) }
+      it { expect(complex_consumer.get_arguments).to include(foo: :bar) }
     end
 
-    context 'when not defined' do
-      it { expect(simple_consumer.get_arguments).to eq({}) }
+    context 'when queue is lazy' do
+      it 'has the x-queue-mode argument set to lazy' do
+        expect(consumer_using_classic_queue.get_arguments['x-queue-mode'])
+          .to eq('lazy')
+      end
     end
 
+    context "when queue's type is quorum" do
+      let(:arguments) { consumer_using_quorum_queue.get_arguments }
+      it 'has the x-queue-type argument set to quorum' do
+        expect(arguments['x-queue-type']).to eq('quorum')
+        expect(arguments).to_not have_key('x-quorum-initial-group-size')
+      end
+
+      it 'has the x-quorum-initial-group-size argument set to quorum' do
+        consumer_using_quorum_queue.quorum_queue(initial_group_size: 5)
+        expect(arguments['x-queue-type']).to eq('quorum')
+        expect(arguments['x-quorum-initial-group-size']).to eq(5)
+      end
+    end
   end
 
   describe '.get_queue_name' do

data/spec/hutch/error_handlers/airbrake_spec.rb

@@ -1,5 +1,8 @@
 require 'spec_helper'
 
+# The airbrake gem is MRI-only, see the Gemfile
+return if defined?(JRUBY_VERSION)
+
 describe Hutch::ErrorHandlers::Airbrake do
   let(:error_handler) { Hutch::ErrorHandlers::Airbrake.new }
 
@@ -14,7 +17,7 @@ describe Hutch::ErrorHandlers::Airbrake do
 
     it "logs the error to Airbrake" do
       message_id = "1"
-      properties = OpenStruct.new(message_id: message_id)
+      properties = Struct.new(:message_id).new(message_id)
       payload = "{}"
       consumer = double
       ex = error
@@ -27,4 +30,23 @@ describe Hutch::ErrorHandlers::Airbrake do
       error_handler.handle(properties, payload, consumer, ex)
     end
   end
+
+  describe '#handle_setup_exception' do
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Airbrake" do
+      ex = error
+      message = {
+        cgi_data: ENV.to_hash,
+      }
+      expect(::Airbrake).to receive(:notify).with(ex, message)
+      error_handler.handle_setup_exception(ex)
+    end
+  end
 end

data/spec/hutch/error_handlers/bugsnag_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Hutch::ErrorHandlers::Bugsnag do
+  let(:error_handler) { described_class.new }
+
+  before do
+    Bugsnag.configure do |bugsnag|
+      bugsnag.api_key = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+      bugsnag.logger = Logger.new(File::NULL) # suppress logging
+    end
+  end
+
+  describe "#handle" do
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Bugsnag" do
+      message_id = "1"
+      properties = Struct.new(:message_id).new(message_id)
+      payload = "{}"
+      consumer = double
+      ex = error
+      message = {
+        payload: payload,
+        consumer: consumer
+      }
+
+      expect(::Bugsnag).to receive(:notify).with(ex).and_call_original
+      expect_any_instance_of(::Bugsnag::Report).to receive(:add_tab).with(:hutch, message)
+      error_handler.handle(properties, payload, consumer, ex)
+    end
+  end
+
+  describe "#handle_setup_exception" do
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Bugsnag" do
+      ex = error
+      expect(::Bugsnag).to receive(:notify).with(ex)
+      error_handler.handle_setup_exception(ex)
+    end
+  end
+end

data/spec/hutch/error_handlers/honeybadger_spec.rb

@@ -14,7 +14,7 @@ describe Hutch::ErrorHandlers::Honeybadger do
 
     it "logs the error to Honeybadger" do
       message_id = "1"
-      properties = OpenStruct.new(message_id: message_id)
+      properties = Struct.new(:message_id).new(message_id)
       payload = "{}"
       consumer = double
       ex = error
@@ -34,4 +34,25 @@ describe Hutch::ErrorHandlers::Honeybadger do
       error_handler.handle(properties, payload, consumer, ex)
     end
   end
+
+  describe '#handle_setup_exception' do
+    let(:error) do
+      begin
+        raise "Stuff went wrong during setup"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Honeybadger" do
+      ex = error
+      message = {
+        :error_class => ex.class.name,
+          :error_message => "#{ ex.class.name }: #{ ex.message }",
+          :backtrace => ex.backtrace,
+      }
+      expect(error_handler).to receive(:notify_honeybadger).with(message)
+      error_handler.handle_setup_exception(ex)
+    end
+  end
 end

data/spec/hutch/error_handlers/logger_spec.rb

@@ -4,7 +4,7 @@ describe Hutch::ErrorHandlers::Logger do
   let(:error_handler) { Hutch::ErrorHandlers::Logger.new }
 
   describe '#handle' do
-    let(:properties) { OpenStruct.new(message_id: "1") }
+    let(:properties) { Struct.new(:message_id).new("1") }
     let(:payload) { "{}" }
     let(:error) { double(message: "Stuff went wrong", class: "RuntimeError",
                        backtrace: ["line 1", "line 2"]) }
@@ -14,4 +14,15 @@ describe Hutch::ErrorHandlers::Logger do
       error_handler.handle(properties, payload, double, error)
     end
   end
+
+  describe '#handle_setup_exception' do
+    let(:error) { double(message: "Stuff went wrong during setup",
+                       class: "RuntimeError",
+                       backtrace: ["line 1", "line 2"]) }
+
+    it "logs two separate lines" do
+      expect(Hutch::Logging.logger).to receive(:error).exactly(2).times
+      error_handler.handle_setup_exception(error)
+    end
+  end
 end

data/spec/hutch/error_handlers/rollbar_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Hutch::ErrorHandlers::Rollbar do
+  let(:error_handler) { Hutch::ErrorHandlers::Rollbar.new }
+
+  describe '#handle' do
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Rollbar" do
+      message_id = "1"
+      properties = Struct.new(:message_id).new(message_id)
+      payload = "{}"
+      consumer = double
+      ex = error
+      message = {
+        payload: payload,
+        consumer: consumer
+      }
+      expect(::Rollbar).to receive(:error).with(ex, message)
+      error_handler.handle(properties, payload, consumer, ex)
+    end
+  end
+
+  describe '#handle_setup_exception' do
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Rollbar" do
+      ex = error
+      expect(::Rollbar).to receive(:error).with(ex)
+      error_handler.handle_setup_exception(ex)
+    end
+  end
+end

data/spec/hutch/error_handlers/sentry_spec.rb

@@ -3,8 +3,16 @@ require 'spec_helper'
 describe Hutch::ErrorHandlers::Sentry do
   let(:error_handler) { Hutch::ErrorHandlers::Sentry.new }
 
+  before do
+    Sentry.init do
+      # initialize Sentry so that the integration acutally works
+      # otherwise, all its methods are going to return early
+      # so it will be impossible to check if it actually works
+    end
+  end
+
   describe '#handle' do
-    let(:properties) { OpenStruct.new(message_id: "1") }
+    let(:properties) { Struct.new(:message_id).new("1") }
     let(:payload) { "{}" }
     let(:error) do
       begin
@@ -15,8 +23,25 @@ describe Hutch::ErrorHandlers::Sentry do
     end
 
     it "logs the error to Sentry" do
-      expect(Raven).to receive(:capture_exception).with(error, extra: { payload: payload })
+      expect(::Sentry).to receive(:capture_exception).with(error).and_call_original
+
       error_handler.handle(properties, payload, double, error)
     end
   end
+
+  describe '#handle_setup_exception' do
+    let(:error) do
+      begin
+        raise "Stuff went wrong during setup"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Sentry" do
+      expect(::Sentry).to receive(:capture_exception).with(error).and_call_original
+
+      error_handler.handle_setup_exception(error)
+    end
+  end
 end

data/spec/hutch/message_spec.rb

@@ -4,7 +4,7 @@ describe Hutch::Message do
   let(:delivery_info) { double('Delivery Info') }
   let(:props) { double('Properties', content_type: "application/json") }
   let(:body) {{ foo: 'bar' }.with_indifferent_access}
-  let(:json_body) { MultiJson.dump(body) }
+  let(:json_body) { JSON.generate(body) }
   subject(:message) { Hutch::Message.new(delivery_info, props, json_body, Hutch::Config[:serializer]) }
 
   describe '#body' do

data/spec/hutch/tracers/datadog_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+RSpec.describe Hutch::Tracers::Datadog do
+  ::Datadog.logger.level = Logger::FATAL # suppress logging
+  
+  describe "#handle" do
+    subject(:handle) { tracer.handle(message) }
+
+    let(:tracer) { described_class.new(klass) }
+    let(:klass)  do
+      Class.new do
+        attr_reader :message
+
+        def initialize
+          @message = nil
+        end
+
+        def class
+          Struct.new(:name).new('ClassName')
+        end
+
+        def process(message)
+          @message = message
+        end
+      end.new
+    end
+    let(:message) { double(:message) }
+
+    before do
+      allow(::Datadog::Tracing).to receive(:trace).and_call_original
+    end
+
+    it 'uses Datadog tracer' do
+      handle
+
+      expect(::Datadog::Tracing).to have_received(:trace).with('ClassName',
+        hash_including(service: 'hutch', type: 'rabbitmq'))
+    end
+
+    it 'processes the message' do
+      expect {
+        handle
+      }.to change { klass.message }.from(nil).to(message)
+    end
+  end
+end

data/spec/hutch/waiter_spec.rb

@@ -22,7 +22,7 @@ RSpec.describe Hutch::Waiter do
       end
     end
 
-    context 'a TERM signal is received' do
+    context 'a TERM signal is received', if: !defined?(JRUBY_VERSION) do
       it 'logs that hutch is stopping' do
         expect(Hutch::Logging.logger).to receive(:info)
           .with('caught SIGTERM, stopping hutch...')
@@ -32,7 +32,7 @@ RSpec.describe Hutch::Waiter do
       end
     end
 
-    context 'a INT signal is received' do
+    context 'a INT signal is received', if: !defined?(JRUBY_VERSION) do
       it 'logs that hutch is stopping' do
         expect(Hutch::Logging.logger).to receive(:info)
           .with('caught SIGINT, stopping hutch...')