sigurd 0.0.1

data/lib/sigurd/signal_handler.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Sigurd
+  # Class that takes any object with a "start" and "stop" method and catches
+  # signals to ask them to stop nicely.
+  class SignalHandler
+    SIGNALS = %i(INT TERM QUIT).freeze
+
+    # Takes any object that responds to the `start` and `stop` methods.
+    # @param runner[#start, #stop]
+    def initialize(runner)
+      @signal_queue = []
+      @reader, @writer = IO.pipe
+      @runner = runner
+    end
+
+    # Run the runner.
+    def run!
+      setup_signals
+      @runner.start
+
+      loop do
+        case signal_queue.pop
+        when *SIGNALS
+          @runner.stop
+          break
+        else
+          ready = IO.select([reader, writer])
+
+          # drain the self-pipe so it won't be returned again next time
+          reader.read_nonblock(1) if ready[0].include?(reader)
+        end
+      end
+    end
+
+  private
+
+    attr_reader :reader, :writer, :signal_queue, :executor
+
+    # 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
+      end
+    end
+
+    # Trap signals using the self-pipe trick.
+    def setup_signals
+      at_exit { @runner&.stop }
+      SIGNALS.each do |signal|
+        prepend_handler(signal) do
+          unblock(signal)
+        end
+      end
+    end
+
+    # Save the signal to the queue and continue on.
+    # @param signal [Symbol]
+    def unblock(signal)
+      writer.write_nonblock('.')
+      signal_queue << signal
+    end
+  end
+end

data/lib/sigurd/version.rb

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

data/sigurd.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sigurd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sigurd'
+  spec.version       = Sigurd::VERSION
+  spec.authors       = ['Daniel Orner']
+  spec.email         = ['daniel.orner@flipp.com']
+  spec.summary       = 'Small gem to manage executing looping processes and signal handling.'
+  spec.homepage      = ''
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency('concurrent-ruby', '~> 1')
+  spec.add_runtime_dependency('exponential-backoff')
+
+  spec.add_development_dependency('guard', '~> 2')
+  spec.add_development_dependency('guard-rspec', '~> 4')
+  spec.add_development_dependency('guard-rubocop', '~> 1')
+  spec.add_development_dependency('rspec', '~> 3')
+  spec.add_development_dependency('rspec_junit_formatter', '~>0.3')
+  spec.add_development_dependency('rubocop', '~> 0.72')
+  spec.add_development_dependency('rubocop-rspec', '~> 1.27')
+end

data/spec/executor_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'sigurd/executor'
+
+RSpec.describe Sigurd::Executor do
+
+  let(:executor) { described_class.new(runners) }
+  let(:runners) { (1..2).map { |i| TestRunners::TestRunner.new(i) } }
+
+  it 'starts and stops configured runners' do
+    runners.each do |r|
+      expect(r.started).to be_falsey
+      expect(r.stopped).to be_falsey
+    end
+    executor.start
+    wait_for do
+      runners.each do |r|
+        expect(r.started).to be_truthy
+        expect(r.stopped).to be_falsey
+      end
+      executor.stop
+      runners.each do |r|
+        expect(r.started).to be_truthy
+        expect(r.stopped).to be_truthy
+      end
+    end
+  end
+
+  it 'sleeps X seconds' do
+    executor = described_class.new(runners, sleep_seconds: 5)
+    allow(executor).to receive(:handle_crashed_runner).and_call_original
+    expect(executor).to receive(:sleep).with(5).twice
+    runners.each { |r| r.should_error = true }
+    executor.start
+    wait_for do
+      runners.each { |r| expect(r.started).to be_truthy }
+      executor.stop
+    end
+  end
+
+  it 'reconnects crashed runners' do
+    allow(executor).to receive(:handle_crashed_runner).and_call_original
+    runners.each { |r| r.should_error = true }
+    executor.start
+    wait_for do
+      expect(executor).to have_received(:handle_crashed_runner).with(runners[0], anything, 0).once
+      expect(executor).to have_received(:handle_crashed_runner).with(runners[1], anything, 0).once
+      runners.each { |r| expect(r.started).to be_truthy }
+      executor.stop
+    end
+  end
+
+end

data/spec/signal_handler_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'sigurd/signal_handler'
+
+RSpec.describe Sigurd::SignalHandler do
+  describe '#run!' do
+
+    it 'starts and stops the runner' do
+      runner = TestRunners::TestRunner.new
+      expect(runner).to receive(:start)
+      expect(runner).to receive(:stop)
+
+      signal_handler = described_class.new(runner)
+      signal_handler.send(:unblock, described_class::SIGNALS.first)
+      signal_handler.run!
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Helpers for Executor/DbProducer
+module TestRunners
+  # Execute a block until it stops failing. This is helpful for testing threads
+  # where we need to wait for them to continue but don't want to rely on
+  # sleeping for X seconds, which is crazy brittle and slow.
+  def wait_for
+    start_time = Time.now
+    begin
+      yield
+    rescue Exception # rubocop:disable Lint/RescueException
+      raise if Time.now - start_time > 2 # 2 seconds is probably plenty of time! <_<
+
+      sleep(0.1)
+      retry
+    end
+  end
+
+  # Test runner
+  class TestRunner
+    attr_accessor :id, :started, :stopped, :should_error
+
+    # :nodoc:
+    def initialize(id=nil)
+      @id = id
+    end
+
+    # :nodoc:
+    def start
+      if @should_error
+        @should_error = false
+        raise 'OH NOES'
+      end
+      @started = true
+    end
+
+    # :nodoc:
+    def stop
+      @stopped = true
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include TestRunners
+  config.full_backtrace = true
+
+  # true by default for RSpec 4.0
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.mock_with(:rspec) do |mocks|
+    mocks.yield_receiver_to_any_instance_implementation_blocks = true
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: sigurd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Orner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: exponential-backoff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.72'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.72'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+description: 
+email:
+- daniel.orner@flipp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.md
+- README.md
+- lib/sigurd.rb
+- lib/sigurd/executor.rb
+- lib/sigurd/signal_handler.rb
+- lib/sigurd/version.rb
+- sigurd.gemspec
+- spec/executor_spec.rb
+- spec/signal_handler_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Small gem to manage executing looping processes and signal handling.
+test_files:
+- spec/executor_spec.rb
+- spec/signal_handler_spec.rb
+- spec/spec_helper.rb