Merge pull request #3 from flipp-oss/exit-on-signal

#1: Rather than raising a `SignalException`, sigurd will now call `ex…

.gitignore

@@ -37,3 +37,5 @@
 .rvmrc
 
 .idea
+
+Gemfile.lock

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+## [0.1.0] - 2022-07-20
+- Added `exit_on_signal` to exit instead of raising a `SignalException`. Fixes #1.
+
 ## [0.0.3] - 2020-11-25
 - Allow to access the executor from outside the signal handler.
 - Use `require "sigurd"` without having to require files individually.

README.md

@@ -81,6 +81,13 @@ backoff to wait before restarting it. You can instead use the `sleep_seconds`
 setting to always sleep a fixed amount of time before retrying. There
 is no limit to retries.
 
+## Configuration
+
+By default, sigurd will exit the process when a TERM, KILL or QUIT signal is received. You can change this 
+behavior to instead raise the original `SignalException` by setting
+
+    Sigurd.exit_on_signal = true
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/flipp-oss/sigurd .

lib/sigurd.rb

@@ -6,4 +6,9 @@
 
 # :nodoc:
 module Sigurd
+
+  class << self
+    attr_accessor :exit_on_signal
+  end
+
 end

lib/sigurd/signal_handler.rb

@@ -21,10 +21,15 @@ def run!
       @runner.start
 
       loop do
-        case signal_queue.pop
+        signal = signal_queue.pop
+        case signal
         when *SIGNALS
           @runner.stop
-          break
+          if Sigurd.exit_on_signal
+            exit 0
+          else
+            raise(SignalException, signal)
+          end
         else
           ready = IO.select([reader, writer])
 
@@ -41,9 +46,8 @@ def run!
     # https://stackoverflow.com/questions/29568298/run-code-when-signal-is-sent-but-do-not-trap-the-signal-in-ruby
     def prepend_handler(signal)
       previous = Signal.trap(signal) do
-        previous = -> { raise SignalException, signal } unless previous.respond_to?(:call)
         yield
-        previous.call
+        previous.call if previous&.respond_to?(:call)
       end
     end
 

lib/sigurd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sigurd
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

spec/signal_handler_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'sigurd/signal_handler'
+require 'sigurd'
 
 RSpec.describe Sigurd::SignalHandler do
   describe '#run!' do
@@ -11,8 +11,22 @@
       expect(runner).to receive(:stop)
 
       signal_handler = described_class.new(runner)
-      signal_handler.send(:unblock, described_class::SIGNALS.first)
-      signal_handler.run!
+      Thread.new { sleep 1; Process.kill('TERM', 0) }
+      expect { signal_handler.run! }.to raise_error(SignalException)
     end
+
+    context 'when exit_on_signal is true' do
+      it 'should raise a SignalException' do
+        Sigurd.exit_on_signal = true
+        runner = TestRunners::TestRunner.new
+        expect(runner).to receive(:start)
+        expect(runner).to receive(:stop)
+
+        signal_handler = described_class.new(runner)
+        Thread.new { sleep 1; Process.kill('TERM', 0) }
+        expect { signal_handler.run! }.to raise_error(SystemExit)
+      end
+    end
+
   end
 end

spec/spec_helper.rb

@@ -55,4 +55,8 @@ def stop
     mocks.yield_receiver_to_any_instance_implementation_blocks = true
     mocks.verify_partial_doubles = true
   end
+
+  config.before(:each) do
+    Sigurd.exit_on_signal = false
+  end
 end