runaway 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2394ae85e1bcf9ff2046d3892f33ece782e2e22
+  data.tar.gz: 4838053519c1500f34bef114eb374a2b05af9833
+SHA512:
+  metadata.gz: 50c6402a8d00358139c9e93e37a02a4d34819e63ea6c7f00b27e6b544107af71d1a60b14671c2115c6d04565fe0d3a4f0310c2c79a3f100c453436f61b2e0a24
+  data.tar.gz: 8555a4a081a964299e1866ee00bb0728984a87303add7f89b708a26429006f28721064d21bbe7e95dfd5f0a4106590de288a491e68e0796eb5170f87bad65f9a

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 3.2", '< 3.3'
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 WeTransfer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# runaway
+
+Spin off work into child processes and terminate it on time
+
+To simply ensure the process keeps responding (the Ruby runtime still can do context-switching
+and can respond to Unix signals):
+
+    Runaway.spin do
+      ActiveRAMGobbler.load_many_things(num_things: 10_000_000)
+    end
+
+If you need the process to be done within a certain time period (and if it takes longer
+it probably is hanging):
+
+    Runaway.spin(must_quite_within: 15) do # ensures termination within 15 seconds
+      `/bin/proprietary_render_server/bin/render --put-server-on-fire=yes`
+    end
+
+If the child process quits with the exit code of 0 it is considered a "clean" termination.
+Anything else (any non-zero exit status) is considered a failure in the child process and
+will cause an exception to be raised in the master.
+
+The `spin` method in the master blocks until the child process terminates.
+
+## Contributing to runaway
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2016 Julik Tarkhanov. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require_relative 'lib/runaway'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.version = Runaway::VERSION
+  gem.name = "runaway"
+  gem.homepage = "https://github.com/WeTransfer/runaway"
+  gem.license = "MIT"
+  gem.description = %Q{Spin off blocks in child processes and make sure they terminate on time}
+  gem.summary = %Q{Strict control over child processes}
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/runaway.rb

@@ -0,0 +1,95 @@
+require 'securerandom'
+
+module Runaway
+  VERSION = '1.0.0'
+  
+  UncleanExit = Class.new(StandardError)
+  Child = Class.new(StandardError)
+  HeartbeatTimeout = Class.new(Child)
+  RuntimeExceeded = Class.new(Child)
+  
+  DEFAULT_HEARTBEAT_INTERVAL = 2
+  TERM = 'TERM'.freeze
+  KILL = 'KILL'.freeze
+  USR2 = 'USR2'.freeze
+  DEFAULT = "DEFAULT".freeze
+  INF = (1.0 / 0.0)
+  
+  # Acts as a substitute for a Logger
+  module NullLogger; def self.warn(*); end; end
+  
+  def self.spin(must_quit_within: INF, heartbeat_interval: DEFAULT_HEARTBEAT_INTERVAL, 
+    logger: NullLogger, &block_to_run_in_child)
+    cookie = SecureRandom.hex(1)
+    r, w = IO.pipe
+    child_pid = fork do
+      r.close_read
+      # Remove anything that was there from the parent
+      [USR2, TERM, KILL].each { |reset_sig| trap(reset_sig, DEFAULT) }
+      
+      # When the parent asks us for a heartbeat, send the cookie back
+      trap(USR2) { w.write(cookie); w.flush }
+      block_to_run_in_child.call
+    end
+    w.close_write
+    
+    started_at = Time.now
+    
+    has_quit = false
+    unclean_exit_error = nil
+    waiter_t = Thread.new do
+      has_quit, status = Process.wait2(child_pid)
+      unless status.exitstatus && status.exitstatus.zero?
+        unclean_exit_error = UncleanExit.new("#{child_pid} exited uncleanly: #{status.inspect}")
+      end
+    end
+    waiter_t.abort_on_exception = true
+    
+    soft_signal = ->(sig) {
+      (Process.kill(sig, child_pid) rescue Errno::ESRCH) if !has_quit
+    }
+    
+    begin
+      loop do
+        sleep heartbeat_interval
+        
+        # First check if it has exceeded it's wall clock time allowance
+        running_for = Time.now - started_at
+        if running_for > must_quit_within
+          raise RuntimeExceeded.new('%d did not terminate after %d secs (limited to %d secs)' % [
+            child_pid, running_for, must_quit_within])
+        end
+        
+        # Then send it the USR2 as a "ping", and expect a "pong" in
+        # the form of a pipe write. If the pipe is still not readable
+        # after a certain time, we assume the process has hung.
+        Process.kill(USR2, child_pid)
+        select_timeout = (heartbeat_interval * 2)
+        ready_read = IO.select([r], [], [], select_timeout)
+        if ready_read.nil?
+          raise HeartbeatTimeout.new('%d did not reply to heartbeat after %d secs' % [child_pid, select_timeout])
+        end
+        r.read(cookie.bytesize)
+      end
+    rescue Runaway => terminating_error
+      logger.error "Terminating %d - %s: %s" % [child_pid, terminating_error.class, terminating_error.message]
+      soft_signal[TERM]
+      sleep 5
+      soft_signal[KILL]
+      
+      raise terminating_error
+    rescue Errno::EBADF, Errno::ESRCH, Errno::EPIPE
+      # Could not read from the pipe - the child quit, or could not send signal
+    end
+    
+    # If the loop has terminated the process has certainly quit, and we can join the waiter thread
+    waiter_t.join
+    
+    # If the process exited uncleanly (not with status 0) raise an exception in the parent
+    raise unclean_exit_error if unclean_exit_error
+    
+    :done
+  ensure
+    r.close_read
+  end
+end

data/runaway.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: runaway 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "runaway"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Julik Tarkhanov"]
+  s.date = "2016-02-26"
+  s.description = "Spin off blocks in child processes and make sure they terminate on time"
+  s.email = "me@julik.nl"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "lib/runaway.rb",
+    "runaway.gemspec",
+    "spec/runaway_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "https://github.com/WeTransfer/runaway"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "Strict control over child processes"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["< 3.3", "~> 3.2"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["< 3.3", "~> 3.2"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["< 3.3", "~> 3.2"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/spec/runaway_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'tempfile'
+
+describe "Runaway" do
+  
+  it 'supports all the options' do
+    require 'logger'
+    Runaway.spin(must_quit_within: 2, heartbeat_interval: 0.3, logger: Logger.new($stdout)) {} # just do nothing
+  end
+  
+  context 'with a process that quits cleanly' do
+    it 'executes the block' do
+      tf = Tempfile.new('signal')
+      Runaway.spin { sleep(3); tf << 'written' }
+      tf.rewind
+      expect(tf.read).to eq('written')
+    end
+  end
+  
+  context 'with a process that sleeps for too long' do
+    it 'terminates the process' do
+      expect {
+        Runaway.spin(must_quit_within: 3) do
+          sleep 4
+        end
+      }.to raise_error {|err|
+        expect(err).to be_kind_of(Runaway::RuntimeExceeded)
+        expect(err.message).to match(/\d+ did not terminate after 4 secs \(limited to 3 secs\)/)
+      }
+    end
+  end
+  
+  context 'with a process that exits with a non-0 status' do
+    it 'raises an unclean termination error' do
+      expect {
+        Runaway.spin { exit 1 }
+      }.to raise_error {|err|
+        expect(err).to be_kind_of(Runaway::UncleanExit)
+        expect(err.message).to match(/\d+ exited uncleanly/)
+      }
+    end
+  end
+  
+  context 'when a process stops responding to heartbeats' do
+    it 'raises an error' do
+      expect {
+        Runaway.spin { trap('USR2', 'DEFAULT'); trap('USR2') {}; sleep 7 }
+      }.to raise_error {|err|
+        expect(err).to be_kind_of(Runaway::HeartbeatTimeout)
+        expect(err.message).to match(/\d+ did not reply to heartbeat after 4 secs/)
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'runaway'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: runaway
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !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'
+description: Spin off blocks in child processes and make sure they terminate on time
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/runaway.rb
+- runaway.gemspec
+- spec/runaway_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/WeTransfer/runaway
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Strict control over child processes
+test_files: []