hutch 0.21.0-java → 0.25.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
@@ -13,7 +26,7 @@ describe Hutch::CLI do
         it "bails" do
           expect {
             cli.parse_options(["--config=#{file}"])
-          }.to raise_error SystemExit
+          }.to raise_error SystemExit, "Config file '/path/to/nonexistant/file' not found"
         end
       end
 
@@ -37,7 +50,7 @@ describe Hutch::CLI do
         it "bails" do
           expect {
             cli.parse_options(["--mq-tls-key=#{file}"])
-          }.to raise_error SystemExit
+          }.to raise_error SystemExit, "Private key file '/path/to/nonexistant/file' not found"
         end
       end
 
@@ -61,7 +74,7 @@ describe Hutch::CLI do
         it "bails" do
           expect {
             cli.parse_options(["--mq-tls-cert=#{file}"])
-          }.to raise_error SystemExit
+          }.to raise_error SystemExit, "Certificate file '/path/to/nonexistant/file' not found"
         end
       end
 

data/spec/hutch/config_spec.rb

@@ -4,23 +4,40 @@ require 'tempfile'
 describe Hutch::Config do
   let(:new_value) { 'not-localhost' }
 
+  before do
+    Hutch::Config.instance_variable_set(:@config, nil)
+    Hutch::Config.initialize
+  end
+
+  after do
+    Hutch::Config.instance_variable_set(:@config, nil)
+  end
+
   describe '.get' do
     context 'for valid attributes' do
       subject { Hutch::Config.get(:mq_host) }
 
       context 'with no overridden value' do
-        it { is_expected.to eq('localhost') }
+        it { is_expected.to eq('127.0.0.1') }
       end
 
       context 'with an overridden value' do
-        before  { allow(Hutch::Config).to receive_messages(user_config: { mq_host: new_value }) }
+        before do
+          Hutch::Config.set(:mq_host, new_value)
+        end
+
         it { is_expected.to eq(new_value) }
       end
     end
 
     context 'for invalid attributes' do
-      let(:invalid_get) { ->{ Hutch::Config.get(:invalid_attr) } }
-      specify { expect(invalid_get).to raise_error Hutch::UnknownAttributeError }
+      let(:invalid_get) do
+        -> { Hutch::Config.get(:invalid_attr) }
+      end
+
+      specify do
+        expect(invalid_get).to raise_error Hutch::UnknownAttributeError
+      end
     end
   end
 
@@ -35,8 +52,13 @@ describe Hutch::Config do
     end
 
     context 'for invalid attributes' do
-      let(:invalid_set) { ->{ Hutch::Config.set(:invalid_attr, new_value) } }
-      specify { expect(invalid_set).to raise_error Hutch::UnknownAttributeError }
+      let(:invalid_set) do
+        -> { Hutch::Config.set(:invalid_attr, new_value) }
+      end
+
+      specify do
+        expect(invalid_set).to raise_error Hutch::UnknownAttributeError
+      end
     end
   end
 
@@ -49,9 +71,33 @@ describe Hutch::Config do
     end
 
     context 'for an invalid attribute' do
-      let(:invalid_getter) { ->{ Hutch::Config.invalid_attr } }
+      let(:invalid_getter) { -> { Hutch::Config.invalid_attr } }
       specify { expect(invalid_getter).to raise_error NoMethodError }
     end
+
+    context 'for an ENV-overriden value attribute' do
+      around do |example|
+        ENV['HUTCH_MQ_HOST'] = 'example.com'
+        ENV['HUTCH_MQ_PORT'] = '10001'
+        ENV['HUTCH_MQ_TLS'] = 'true'
+        example.run
+        ENV.delete('HUTCH_MQ_HOST')
+        ENV.delete('HUTCH_MQ_PORT')
+        ENV.delete('HUTCH_MQ_TLS')
+      end
+
+      it 'returns the override' do
+        expect(Hutch::Config.mq_host).to eq 'example.com'
+      end
+
+      it 'returns the override for integers' do
+        expect(Hutch::Config.mq_port).to eq 10_001
+      end
+
+      it 'returns the override for booleans' do
+        expect(Hutch::Config.mq_tls).to eq true
+      end
+    end
   end
 
   describe 'a magic setter' do
@@ -63,7 +109,7 @@ describe Hutch::Config do
     end
 
     context 'for an invalid attribute' do
-      let(:invalid_setter) { ->{ Hutch::Config.invalid_attr = new_value } }
+      let(:invalid_setter) { -> { Hutch::Config.invalid_attr = new_value } }
       specify { expect(invalid_setter).to raise_error NoMethodError }
     end
   end
@@ -81,9 +127,9 @@ describe Hutch::Config do
     context 'when an attribute is invalid' do
       let(:config_data) { { random_attribute: 'socks' } }
       it 'raises an error' do
-        expect {
+        expect do
           Hutch::Config.load_from_file(file)
-        }.to raise_error(NoMethodError)
+        end.to raise_error(NoMethodError)
       end
     end
 
@@ -96,26 +142,21 @@ describe Hutch::Config do
         expect(Hutch::Config.mq_username).to eq username
       end
     end
-  end
 
-  describe '.load_from_file' do
-    let(:host) { 'localhost' }
-    let(:username) { 'calvin' }
-    let(:file) do
-      Tempfile.new('configs.yaml').tap do |t|
-        t.write(config_contents)
-        t.rewind
+    context 'when using ERB' do
+      let(:host) { 'localhost' }
+      let(:file) do
+        Tempfile.new('configs.yaml').tap do |t|
+          t.write(config_contents)
+          t.rewind
+        end
       end
-    end
-
-    context 'when using ERb' do
       let(:config_contents) do
         <<-YAML
 mq_host: 'localhost'
 mq_username: '<%= "calvin" %>'
 YAML
       end
-
       it 'loads in the config data' do
         Hutch::Config.load_from_file(file)
         expect(Hutch::Config.mq_host).to eq host
@@ -123,4 +164,24 @@ YAML
       end
     end
   end
+
+  context 'developer ergonomics' do
+    it 'will accept strings and symbols as config keys' do
+      expect(Hutch::Config.get(:mq_host)).to eq '127.0.0.1'
+      expect(Hutch::Config.get('mq_host')).to eq '127.0.0.1'
+    end
+
+    describe 'it will not overwrite existing config' do
+      it 'with defaults' do
+        expect(Hutch::Config.get(:mq_host)).to eq '127.0.0.1'
+        Hutch::Config.initialize
+
+        Hutch::Config.set(:mq_host, 'example2.com')
+
+        expect(Hutch::Config.get(:mq_host)).to eq 'example2.com'
+        Hutch::Config.initialize
+        expect(Hutch::Config.get(:mq_host)).to eq 'example2.com'
+      end
+    end
+  end
 end

data/spec/hutch/error_handlers/airbrake_spec.rb

@@ -14,21 +14,36 @@ describe Hutch::ErrorHandlers::Airbrake do
 
     it "logs the error to Airbrake" do
       message_id = "1"
+      properties = OpenStruct.new(message_id: message_id)
       payload = "{}"
       consumer = double
       ex = error
       message = {
-        :error_class => ex.class.name,
-        :error_message => "#{ ex.class.name }: #{ ex.message }",
-        :backtrace => ex.backtrace,
-        :parameters => {
-          :payload => payload,
-          :consumer => consumer,
-        },
-        :cgi_data => ENV.to_hash,
+        payload: payload,
+        consumer: consumer,
+        cgi_data: ENV.to_hash,
       }
-      expect(::Airbrake).to receive(:notify_or_ignore).with(ex, message)
-      error_handler.handle(message_id, payload, consumer, ex)
+      expect(::Airbrake).to receive(:notify).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 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/honeybadger_spec.rb

@@ -14,6 +14,7 @@ describe Hutch::ErrorHandlers::Honeybadger do
 
     it "logs the error to Honeybadger" do
       message_id = "1"
+      properties = OpenStruct.new(message_id: message_id)
       payload = "{}"
       consumer = double
       ex = error
@@ -29,8 +30,29 @@ describe Hutch::ErrorHandlers::Honeybadger do
             :payload => payload
           }
       }
-      expect(::Honeybadger).to receive(:notify_or_ignore).with(message)
-      error_handler.handle(message_id, payload, consumer, ex)
+      expect(error_handler).to receive(:notify_honeybadger).with(message)
+      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,12 +4,25 @@ describe Hutch::ErrorHandlers::Logger do
   let(:error_handler) { Hutch::ErrorHandlers::Logger.new }
 
   describe '#handle' do
+    let(:properties) { OpenStruct.new(message_id: "1") }
+    let(:payload) { "{}" }
     let(:error) { double(message: "Stuff went wrong", class: "RuntimeError",
                        backtrace: ["line 1", "line 2"]) }
 
     it "logs three separate lines" do
       expect(Hutch::Logging.logger).to receive(:error).exactly(3).times
-      error_handler.handle("1", "{}", double, error)
+      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/opbeat_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Hutch::ErrorHandlers::Opbeat do
+  let(:error_handler) { Hutch::ErrorHandlers::Opbeat.new }
+
+  describe '#handle' do
+    let(:properties) { OpenStruct.new(message_id: "1") }
+    let(:payload) { "{}" }
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Opbeat" do
+      expect(Opbeat).to receive(:report).with(error, extra: { payload: payload })
+      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 Opbeat" do
+      expect(Opbeat).to receive(:report).with(error)
+      error_handler.handle_setup_exception(error)
+    end
+  end
+end

data/spec/hutch/error_handlers/sentry_spec.rb

@@ -4,6 +4,8 @@ describe Hutch::ErrorHandlers::Sentry do
   let(:error_handler) { Hutch::ErrorHandlers::Sentry.new }
 
   describe '#handle' do
+    let(:properties) { OpenStruct.new(message_id: "1") }
+    let(:payload) { "{}" }
     let(:error) do
       begin
         raise "Stuff went wrong"
@@ -12,9 +14,24 @@ describe Hutch::ErrorHandlers::Sentry do
       end
     end
 
+    it "logs the error to Sentry" do
+      expect(Raven).to receive(:capture_exception).with(error, extra: { payload: payload })
+      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(Raven).to receive(:capture_exception).with(error)
-      error_handler.handle("1", "{}", double, error)
+      error_handler.handle_setup_exception(error)
     end
   end
 end

data/spec/hutch/logger_spec.rb

@@ -3,24 +3,30 @@ require 'spec_helper'
 describe Hutch::Logging do
   let(:dummy_object) do
     class DummyObject
-      include Hutch::Logging
+      include described_class
     end
   end
 
   describe '#logger' do
+    around do |example|
+      old_logger = described_class.logger
+      described_class.setup_logger
+      example.run
+      described_class.logger = old_logger
+    end
+
     context 'with the default logger' do
-      subject { Hutch::Logging.logger }
+      subject { described_class.logger }
 
       it { is_expected.to be_instance_of(Logger) }
     end
 
     context 'with a custom logger' do
-      let(:dummy_logger) { double("Dummy logger", warn: true, info: true) }
-      after { Hutch::Logging.setup_logger }
+      let(:dummy_logger) { double("Dummy logger") }
 
       it "users the custom logger" do
-        Hutch::Logging.logger = dummy_logger
-        expect(Hutch::Logging.logger).to eq(dummy_logger)
+        described_class.logger = dummy_logger
+        expect(described_class.logger).to eq(dummy_logger)
       end
     end
   end

data/spec/hutch/waiter_spec.rb

@@ -0,0 +1,51 @@
+require 'hutch/waiter'
+
+RSpec.describe Hutch::Waiter do
+  describe '.wait_until_signaled' do
+    let(:pid) { Process.pid }
+    def start_kill_thread(signal)
+      Thread.new do
+        # sleep allows the worker time to set up the signal handling
+        # before the kill signal is sent.
+        sleep 0.001
+        Process.kill signal, pid
+      end
+    end
+
+    context 'a QUIT signal is received', if: RSpec::Support::Ruby.mri? do
+      it 'logs that hutch is stopping' do
+        expect(Hutch::Logging.logger).to receive(:info)
+          .with('caught SIGQUIT, stopping hutch...')
+
+        start_kill_thread('QUIT')
+        described_class.wait_until_signaled
+      end
+    end
+
+    context 'a TERM signal is received' do
+      it 'logs that hutch is stopping' do
+        expect(Hutch::Logging.logger).to receive(:info)
+          .with('caught SIGTERM, stopping hutch...')
+
+        start_kill_thread('TERM')
+        described_class.wait_until_signaled
+      end
+    end
+
+    context 'a INT signal is received' do
+      it 'logs that hutch is stopping' do
+        expect(Hutch::Logging.logger).to receive(:info)
+          .with('caught SIGINT, stopping hutch...')
+
+        start_kill_thread('INT')
+        described_class.wait_until_signaled
+      end
+    end
+  end
+
+  describe described_class::SHUTDOWN_SIGNALS do
+    it 'includes only things in Signal.list.keys' do
+      expect(described_class).to eq(described_class & Signal.list.keys)
+    end
+  end
+end