spawn_server 1.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeff Moss
+
+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.rdoc

@@ -0,0 +1,18 @@
+= spawn_server
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jeff Moss. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "spawn_server"
+    gem.summary = %Q{TODO: one-line summary of your gem}
+    gem.description = %Q{TODO: longer description of your gem}
+    gem.email = "jeff.moss@matchbin.com"
+    gem.homepage = "http://github.com/zardinuk/spawn_server"
+    gem.authors = ["Jeff Moss"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency "spawn"
+    gem.add_dependency "log4r"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "spawn_server #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/spawn/server.rb

@@ -0,0 +1,210 @@
+require 'logger'
+require 'spawn/task'
+
+module Spawn
+  class Server
+    POLLING_INTERVAL = 60
+
+    attr_accessor :pids
+    attr_accessor :tasks
+    attr_accessor :interval
+    attr_accessor :start_times
+
+    def initialize(tasks, interval=POLLING_INTERVAL)
+      puts "Initializing spawn server"
+
+      self.pids = {}
+      self.start_times = {}
+      self.tasks = tasks
+      self.interval = interval
+
+      # trap INT for debugging, in production we want to leave children active
+      Signal.trap('INT') do
+        process_list = self.pids.map{|k,v| "#{k} (#{v})" }.join(', ')
+        print " *** Interrupt received, killing #{process_list} ***\n"
+        Process.kill('INT', *self.pids.values.map{|h| h.keys }.flatten )
+        exit(1)
+      end
+
+      start_tasks
+    end
+
+    def logger
+      if instance_variables.include?(:@logger)
+        @logger
+      else
+        @logger = Logger.new(File.open('log/spawn_server.log', 'w'))
+        @logger.level = Logger::DEBUG
+        @logger
+      end
+    end
+
+    def start_tasks
+      puts self.tasks.inspect
+
+      # first load in pid files
+      self.tasks.each do |id, params|
+        self.pids[id] = {}
+
+        params[:max_threads].times do |thread_num|
+          thread_pid_file = pid_file(id, thread_num+1)
+
+          puts thread_pid_file
+
+          if File.exists?(thread_pid_file)
+            pid = File.open(thread_pid_file).read.to_i
+            if (Process.kill(0, pid) rescue false)
+              self.pids[id][pid] = File.stat(thread_pid_file).mtime
+            else
+              File.unlink(thread_pid_file) rescue nil
+            end
+          end
+        end
+
+        if params[:reload]
+          case params[:reload]
+          when :all
+            self.pids[id].each do |pid,mtime|
+              process_stop(id, pid, true)
+            end
+          when :parent
+            self.pids[id].each do |pid,mtime|
+              process_stop(id, pid, false)
+            end
+          else
+            puts "Unrecognized value for :reload parameter in #{id}: #{params[:reload]}"
+          end
+        end
+      end
+
+      loop do
+        Thread.new do
+          self.tasks.each do |id, params|
+            puts "Checking if #{id} is running"
+
+            if (!process_running?(id, params[:max_threads]))
+              puts "It's not, starting..."
+              # not running, or not enough running, start it...
+              process_start(id, params) do
+                if params[:task].is_a?(String)
+                  Rake::Task[params[:task]].invoke
+                elsif params[:task].is_a?(Proc)
+                  puts "Initializing task #{id}"
+                  params[:task].call
+                end
+                exit
+              end
+            end
+
+            # check if the processes are running too long, this needs to be done after "process_running" is called so that the pid list is cleared, it's not optimal this way but good enough for now
+            self.pids[id].each do |pid,mtime|
+              if params[:max_life] && params[:max_life] < time_running(id,pid)
+                puts "Before process stop (#{pid}):\n#{process_list}"
+                process_stop(id,pid)
+                puts "After process stop (#{pid}):\n#{process_list}"
+
+                # BackgroundCheck.deliver_process_max_life(id, time_running(id,pid), params[:max_life]) rescue nil
+              end
+            end
+          end
+        end
+
+        # Run the above code in a thread so that the interval is more consistent
+        sleep(self.interval)
+      end
+    end
+
+    def process_list
+      `ps uxf`
+    end
+
+    def time_running(id, pid)
+      if self.pids[id][pid]
+        Time.now - self.pids[id][pid]
+      end
+    end
+
+    def pid_file(id, num=1)
+      "tmp/#{id}.#{num}.pid"
+    end
+
+    def process_running?(id, quota=1)
+      running = 0
+      process_list = self.pids[id]
+      if process_list && process_list.is_a?(Hash)
+        process_list.each do |pid,mtime|
+          # do this first to wipe the defunct children, won't block
+          # Process.wait(pid, Process::WNOHANG)
+        
+          if (Process.kill(0, pid) rescue false)
+            running += 1
+          else
+            # look for this pid file and remove it
+            self.tasks[id][:max_threads].times do |i|
+              thread_pid_file = pid_file(id,i+1)
+              if File.exists?(thread_pid_file)
+                existing_pid = File.open(thread_pid_file).read
+                if existing_pid.to_i == pid.to_i
+                  File.unlink(thread_pid_file)
+                end
+              end
+            end
+            self.pids[id].delete(pid)
+          end
+        end
+      end
+
+      return (running >= quota)
+    end
+
+    def process_stop(id, pid, recursive=true)
+      return unless pid
+
+      if recursive
+        # recursive, look through all the stat files for this one's child processes and call recursively
+        Dir.glob('/proc/*/status').each do |stat_file|
+          File.open(stat_file).each do |line|
+            if line =~ /^PPid:\s*#{pid}$/
+              process_stop(id, stat_file.match(/[0-9]+/)[0].to_i)
+              break
+            end
+          end
+        end
+      end
+
+      puts "Stopping process #{pid} (#{id})"
+      Process.kill(9, pid) rescue nil
+    end
+
+    def process_start(id, params={})
+      pid = Spawn::Task.new do
+        CACHE.reset if defined?(CACHE)
+        ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord::Base)
+        yield
+      end
+      pid = pid.handle.to_i
+
+      puts "Started process #{pid} (#{id})"
+      begin
+        params[:max_threads].times do |thread_num|
+          thread_pid_file = pid_file(id, thread_num+1)
+          if File.exists?(thread_pid_file)
+            # this pid must be running still, cause we must have just checked
+          else
+            File.open(thread_pid_file, 'w'){|f| f << "#{pid}" }
+            break
+          end
+        end
+      rescue Exception => e
+        # email this log message
+        puts e.message
+      end
+      self.pids[id][pid] = Time.now
+
+      if params[:priority]
+        Process.setpriority(Process::PRIO_PROCESS, pid, params[:priority])
+      end
+    end
+    
+  end
+end

data/lib/spawn/task.rb

@@ -0,0 +1,68 @@
+module Spawn
+  class Task
+    attr_accessor :handle
+
+    # socket to close in child process
+    @@resources = []
+
+    # set the resource to disconnect from in the child process (when forking)
+    def self.resource_to_close(resource)
+      @@resources << resource
+    end
+
+    # close all the resources added by calls to resource_to_close
+    def self.close_resources
+      @@resources.each do |resource|
+        resource.close if resource && resource.respond_to?(:close) && !resource.closed?
+      end
+    end
+
+    # Spawns a long-running section of code and returns the ID of the spawned process.
+    def initialize(options={})
+      self.handle = fork_it(options) { yield }
+    end
+
+    def wait(sids = [])
+      # wait for all threads and/or forks (if a single sid passed in, convert to array first)
+      Array(sids).each do |sid|
+        if sid.type == :thread
+          sid.handle.join()
+        else
+          begin
+            Process.wait(sid.handle)
+          rescue
+            # if the process is already done, ignore the error
+          end
+        end
+      end
+    end
+
+    protected
+    def fork_it(options)
+      child = fork do
+        begin
+          start = Time.now
+
+          # set the nice priority if needed
+          Process.setpriority(Process::PRIO_PROCESS, 0, options[:nice]) if options[:nice]
+
+          # disconnect from the listening socket, et al
+          self.class.close_resources
+
+          # run the block of code that takes so long
+          yield
+
+        rescue => ex
+          $stderr.puts "spawn> Exception in child[#{Process.pid}] - #{ex.class}: #{ex.message} #{ex.backtrace}"
+        ensure
+          exit!(0)
+        end
+      end
+    
+      # detach from child process (parent may still wait for detached process if they wish)
+      Process.detach(child)
+
+      return child
+    end
+  end
+end

data/lib/spawn_server.rb

@@ -0,0 +1,2 @@
+require 'spawn/task'
+require 'spawn/server'

data/test/spawn_server_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class SpawnServerTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'spawn_server'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: spawn_server
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jeff Moss
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-07 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Spawns processes using fork call, monitors them and other neat things.
+email: jeff.moss@matchbin.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/spawn/server.rb
+- lib/spawn/task.rb
+- lib/spawn_server.rb
+- test/spawn_server_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/zardinuk/spawn_server
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Forks new processes and monitors them and other neat things
+test_files: 
+- test/test_helper.rb
+- test/spawn_server_test.rb