ThiagoLelis-backgroundjob 1.0.2 → 1.0.3

data/lib/bj/attributes.rb

@@ -0,0 +1,120 @@
+module Attributes
+  Attributes::VERSION = '5.0.0' unless defined? Attributes::VERSION
+  def self.version() Attributes::VERSION end
+
+  class List < ::Array
+    def << element
+      super
+      self
+    ensure
+      uniq!
+      index!
+    end
+    def index!
+      @index ||= Hash.new
+      each{|element| @index[element] = true}
+    end
+    def include? element
+      @index ||= Hash.new
+      @index[element] ? true : false
+    end
+    def initializers
+      @initializers ||= Hash.new
+    end
+  end
+
+  def attributes *a, &b
+    unless a.empty?
+      returned = Hash.new
+
+      hashes, names = a.partition{|x| Hash === x}
+      names_and_defaults = {}
+      hashes.each{|h| names_and_defaults.update h}
+      names.flatten.compact.each{|name| names_and_defaults.update name => nil}
+
+      initializers = __attributes__.initializers
+
+      names_and_defaults.each do |name, default|
+        raise NameError, "bad instance variable name '@#{ name }'" if "@#{ name }" =~ %r/[!?=]$/o
+        name = name.to_s
+
+        initialize = b || lambda { default }
+        initializer = lambda do |this|
+          Object.instance_method('instance_eval').bind(this).call &initialize
+        end
+        initializer_id = initializer.object_id
+        __attributes__.initializers[name] = initializer
+
+        module_eval <<-code
+          def #{ name }=(*value, &block)
+            value.unshift block if block
+            @#{ name } = value.first
+          end
+        code
+
+        module_eval <<-code
+          def #{ name }(*value, &block)
+            value.unshift block if block
+            return self.send('#{ name }=', value.first) unless value.empty?
+            #{ name }! unless defined? @#{ name }
+            @#{ name }
+          end
+        code
+
+        module_eval <<-code
+          def #{ name }!
+            initializer = ObjectSpace._id2ref #{ initializer_id }
+            self.#{ name } = initializer.call(self)
+            @#{ name }
+          end
+        code
+
+        module_eval <<-code
+          def #{ name }?
+            #{ name }
+          end
+        code
+
+        attributes << name
+        returned[name] = initializer 
+      end
+
+      returned
+    else
+      begin
+        __attribute_list__
+      rescue NameError
+        singleton_class =
+          class << self
+            self
+          end
+        klass = self
+        singleton_class.module_eval do
+          attribute_list = List.new 
+          define_method('attribute_list'){ klass == self ? attribute_list : raise(NameError) }
+          alias_method '__attribute_list__', 'attribute_list'
+        end
+        __attribute_list__
+      end
+    end
+  end
+
+  %w( __attributes__ __attribute__ attribute ).each{|dst| alias_method dst, 'attributes'}
+end
+
+=begin
+class Object
+  def attributes *a, &b
+    sc = 
+      class << self
+        self
+      end
+    sc.attributes *a, &b
+  end
+  %w( __attributes__ __attribute__ attribute ).each{|dst| alias_method dst, 'attributes'}
+end
+=end
+
+class Module
+  include Attributes
+end

data/lib/bj/bj.rb

@@ -0,0 +1,72 @@
+class Bj
+  module ClassMethods
+    attribute("rails_root"){ Util.const_or_env("RAILS_ROOT"){ "." } }
+    attribute("rails_env"){ Util.const_or_env("RAILS_ENV"){ "development" } }
+    attribute("database_yml"){ File.join rails_root, "config", "database.yml" }
+    attribute("configurations"){ YAML::load(ERB.new(IO.read(database_yml)).result) }
+    attribute("tables"){ Table.list }
+    attribute("hostname"){ Socket.gethostname }
+    attribute("logger"){ Bj::Logger.off STDERR }
+    attribute("ruby"){ Util.which_ruby }
+    attribute("rake"){ Util.which_rake }
+    attribute("script"){ Util.find_script "bj" }
+    attribute("ttl"){ Integer(Bj::Table::Config["ttl"] || (twenty_four_hours = 24 * 60 * 60)) }
+    attribute("table"){ Table }
+    attribute("config"){ table.config }
+    attribute("util"){ Util }
+    attribute("runner"){ Runner }
+    attribute("joblist"){ Joblist }
+    attribute("default_path"){ %w'/bin /usr/bin /usr/local/bin /opt/local/bin'.join(File::PATH_SEPARATOR) }
+
+    def transaction options = {}, &block
+      options.to_options!
+
+      cur_rails_env = Bj.rails_env.to_s
+      new_rails_env = options[:rails_env].to_s
+
+      cur_spec = configurations[cur_rails_env]
+      table.establish_connection(cur_spec) unless table.connected?
+
+      if(new_rails_env.empty? or cur_rails_env == new_rails_env) 
+        table.transaction{ block.call(table.connection) }
+      else
+        new_spec = configurations[new_rails_env]
+        table.establish_connection(new_spec)
+        Bj.rails_env = new_rails_env
+        begin
+          table.transaction{ block.call(table.connection) }
+        ensure
+          table.establish_connection(cur_spec)
+          Bj.rails_env = cur_rails_env
+        end
+      end
+    end
+
+    def chroot options = {}, &block
+      if defined? @chrooted and @chrooted
+        return(block ? block.call(@chrooted) : @chrooted)
+      end
+      if block
+        begin
+          chrooted = @chrooted
+          Dir.chdir(@chrooted = rails_root) do
+            raise RailsRoot, "<#{ Dir.pwd }> is not a rails root" unless Util.valid_rails_root?(Dir.pwd)
+            block.call(@chrooted)
+          end
+        ensure
+          @chrooted = chrooted 
+        end
+      else
+        Dir.chdir(@chrooted = rails_root)
+        raise RailsRoot, "<#{ Dir.pwd }> is not a rails root" unless Util.valid_rails_root?(Dir.pwd)
+        @chrooted
+      end
+    end
+
+    def boot
+      load File.join(rails_root, "config", "boot.rb")
+      load File.join(rails_root, "config", "environment.rb")
+    end
+  end
+  send :extend, ClassMethods
+end

data/lib/bj/errors.rb

@@ -0,0 +1,4 @@
+class Bj
+  class Error < ::StandardError; end
+  class RailsRoot < Error; end
+end

data/lib/bj/joblist.rb

@@ -0,0 +1,112 @@
+class Bj
+  class JobList < ::Array
+    module ClassMethods
+      def for jobs, options = {}
+        if Joblist === jobs
+          jobs.update options
+          return jobs
+        end
+        options.to_options!
+        jobs = [jobs].flatten.compact
+        list = []
+        jobs.each do |arg|
+          list.push(
+            case arg
+              when String
+                case arg
+                  when %r/^\d+$/
+                    job_from_id arg
+                  else
+                    job_from_string arg
+                end
+              when Hash
+                job_from_hash arg
+              when Io
+                jobs_from_io arg
+              when Fixnum, Bignum
+                job_from_number arg
+              else
+                job_from_string arg
+            end
+          )
+        end
+        list.flatten!
+        list.compact!
+        list.map!{|job| job.reverse_merge! options}
+        list
+      end
+
+      def job_from_hash arg
+        arg.to_hash.to_options!
+      end
+
+      def job_from_string arg
+        unless arg.strip.empty?
+          { :command => arg.to_s }
+        else
+          nil
+        end
+      end
+
+      def job_from_number arg
+        id = arg.to_i
+        Table::Job.find(id).to_hash
+      end
+
+      def jobs_from_io arg 
+        if arg == "-"
+          load_from_io STDIN
+        else
+          if arg.respond_to? :read
+            load_from_io arg 
+          else
+            open(arg, "r"){|fd| load_from_io fd}
+          end
+        end
+      end
+
+      def load_from_io io
+        list = []
+        io.each do |line|
+          line.strip!
+          next if line.empty?
+          list << job_from_string(line)
+        end
+        list
+      end
+
+      def jobs_from_yaml arg 
+        object =
+          if arg == "-"
+            YAML.load STDIN
+          else
+            if arg.respond_to? :read
+              YAML.load arg
+            else
+              open(arg, "r"){|fd| YAML.load fd}
+            end
+          end
+        Joblist.for object
+      end
+    end
+    send :extend, ClassMethods
+
+    module InstanceMethods
+      def update options = {}
+        options.to_options!
+        each{|job| job.update options}
+      end
+
+      def push other
+        Joblist.for(other).each do |job|
+          super job
+        end
+        self
+      end
+      alias_method "<<", "push"
+    end
+    send :include, InstanceMethods
+  end
+
+  Joblist = JobList
+end

data/lib/bj/logger.rb

@@ -0,0 +1,50 @@
+class Bj
+  class Logger < ::Logger
+    def self.new *a, &b
+      super(*a, &b).instance_eval{ @default_formatter = @formatter = Formatter.new; self }
+    end
+    def format_message(severity, datetime, progname, msg)
+      (@formatter || @default_formatter).call(severity, datetime, progname, msg)
+    end
+
+    def device
+      @logdev.instance_eval{ @dev }
+    end
+
+    def tty?
+      device.respond_to?('tty?') and device.tty?
+    end
+
+    def turn which
+      @logdev.extend OnOff unless OnOff === @logdev
+      @logdev.turn which
+    end
+
+    module OnOff
+      def turn which
+        @turned = which.to_s =~ %r/on/i ? :on : :off
+      end
+
+      def write message 
+        return message.to_s.size if @turned == :off
+        super
+      end
+    end
+
+    def on
+      turn :on
+    end
+    alias_method "on!", "on"
+    def self.on *a, &b
+      new(*a, &b).instance_eval{ turn :on; self }
+    end
+
+    def off
+      turn :off
+    end
+    alias_method "off!", "off"
+    def self.off *a, &b
+      new(*a, &b).instance_eval{ turn :off; self }
+    end
+  end
+end

data/lib/bj/runner.rb

@@ -0,0 +1,357 @@
+class Bj
+  class Runner
+    class Background
+      def self.for(*a, &b) new(*a, &b) end
+
+      attribute "command"
+      attribute "thread"
+      attribute "pid"
+
+      def initialize command
+        @command = command
+        @thread = new_thread
+      end
+
+      def inspect
+        {
+          "command" => command,
+          "pid" => pid,
+        }.inspect
+      end
+
+
+# TODO - auto start runner?
+
+      def new_thread 
+        this = self
+        Thread.new do
+          Thread.current.abort_on_exception = true
+          loop do
+            cleanup = lambda{}
+
+            IO.popen command, "r+" do |pipe|
+              this.pid = pid = pipe.pid
+              cleanup = lambda do
+                cleanup = lambda{}
+                begin; Process.kill(Runner.kill_signal, pid); rescue Exception; 42; end
+              end
+              at_exit &cleanup
+              Process.wait
+            end
+
+            Bj.logger.error{ "#{ command } failed with #{ $?.inspect }" } unless
+              [0, 42].include?($?.exitstatus)
+
+            cleanup.call
+
+            sleep 42
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      attribute("thread"){ Thread.current }
+      attribute("hup_signal"){ Signal.list.keys.index("HUP") ? "HUP" : "ABRT" }
+      attribute("hup_signaled"){ false }
+      attribute("kill_signal"){ "TERM" }
+      attribute("kill_signaled"){ false }
+
+      def tickle
+        return nil if Bj.config[Runner.no_tickle_key]
+        ping or start
+      end
+
+      def ping
+        begin
+          pid = nil
+          uri = nil
+          process = nil
+          Bj.transaction do
+            pid = Bj.config[Runner.key(Process.pid)] || Bj.config[Runner.key]
+            uri = Bj.config["#{ pid }.uri"]
+            process =
+              if uri
+                require "drb"
+                # DRb.start_service "druby://localhost:0"
+                DRbObject.new(nil, uri)
+              else
+                Process
+              end
+          end
+          return nil unless pid
+          pid = Integer pid
+          begin
+            process.kill Runner.hup_signal, pid
+            pid
+          rescue Exception => e
+            false
+          end
+        rescue Exception => e
+          false
+        end
+      end
+
+      def key ppid = 0
+        ppid ||= 0
+        "#{ Bj.rails_env }.#{ ppid }.pid"
+      end
+
+      def no_tickle_key 
+        "#{ Bj.rails_env }.no_tickle"
+      end
+
+      def start options = {}
+        options.to_options!
+        background.delete Bj.rails_env if options[:force]
+        background[Bj.rails_env] ||= Background.for(command)
+      end
+
+      def background
+        @background ||= Hash.new
+      end
+
+      def background= value
+        @background ||= value 
+      end
+
+      def command
+        "#{ Bj.ruby } " + %W[
+          #{ Bj.script }
+          run 
+          --forever 
+          --redirect=#{ log }
+          --ppid=#{ Process.pid }
+          --rails_env=#{ Bj.rails_env }
+          --rails_root=#{ Bj.rails_root }
+        ].map{|word| word.inspect}.join(" ")
+      end
+
+      def log
+        File.join logdir, "bj.#{ Bj.hostname }.#{ Bj.rails_env }.log"
+      end
+
+      def logdir
+        File.join File.expand_path(Bj.rails_root), 'log'
+      end
+
+      def run options = {}, &block
+        new(options, &block).run
+      end 
+    end
+    send :extend, ClassMethods
+
+    module Instance_Methods
+      attribute "options"
+      attribute "block"
+
+      def initialize options = {}, &block
+        options.to_options!
+        @options, @block = options, block
+      end
+
+      def run
+        wait = options[:wait] || 42
+        limit = options[:limit]
+        forever = options[:forever]
+
+        limit = false if forever
+        wait = Integer wait
+        loopno = 0
+
+        Runner.thread = Thread.current
+        Bj.chroot
+
+        register or exit!(EXIT::WARNING)
+
+        Bj.logger.info{ "STARTED" }
+        at_exit{ Bj.logger.info{ "STOPPED" } }
+
+        fill_morgue
+        install_signal_handlers
+
+        loop do
+          ping_parent
+
+          loopno += 1
+          break if(limit and loopno > limit)
+
+          archive_jobs
+
+          catch :no_jobs do
+            loop do
+              job = thread = stdout = stderr = nil
+
+              Bj.transaction(options) do
+                now = Time.now
+
+                job = Bj::Table::Job.find :first,
+                                          :conditions => ["state = ? and submitted_at <= ?", "pending", now],
+                                          :order => "priority DESC, submitted_at ASC", 
+                                          :limit => 1,
+                                          :lock => true
+                throw :no_jobs unless job
+
+
+                Bj.logger.info{ "#{ job.title } - started" }
+
+                command = job.command
+                env = job.env || {}
+                stdin = job.stdin || ''
+                stdout = job.stdout || ''
+                stderr = job.stderr || ''
+                started_at = Time.now
+
+                thread = Util.start command, :cwd=>Bj.rails_root, :env=>env, :stdin=>stdin, :stdout=>stdout, :stderr=>stderr
+
+                job.state = "running"
+                job.runner = Bj.hostname
+                job.pid = thread.pid
+                job.started_at = started_at 
+                job.save!
+                job.reload
+              end
+
+              exit_status = thread.value
+              finished_at = Time.now
+
+              Bj.transaction(options) do
+                job = Bj::Table::Job.find job.id 
+                break unless job
+                job.state = "finished"
+                job.finished_at = finished_at 
+                job.stdout = stdout
+                job.stderr = stderr
+                job.exit_status = exit_status
+                job.save!
+                job.reload
+                Bj.logger.info{ "#{ job.title } - exit_status=#{ job.exit_status }" }
+              end
+            end
+          end
+
+          Runner.hup_signaled false
+          wait.times do
+            break if Runner.hup_signaled?
+            break if Runner.kill_signaled?
+            sleep 1
+          end 
+
+          break unless(limit or limit == false)
+          break if Runner.kill_signaled?
+        end
+      end
+
+      def ping_parent
+        ppid = options[:ppid]
+        return unless ppid 
+        begin
+          Process.kill 0, Integer(ppid)
+        rescue Errno::ESRCH
+          Kernel.exit 42
+        rescue Exception
+          42
+        end
+      end
+
+      def install_signal_handlers
+        Runner.hup_signaled false
+        hup_handler = nil
+        hup_handler =
+          trap Runner.hup_signal do |*a|
+            begin
+              Runner.hup_signaled true
+            rescue Exception => e
+              Bj.logger.error{ e } rescue nil
+            end
+            hup_handler.call *a rescue nil
+          end
+
+        Runner.kill_signaled false
+        kill_handler = nil
+        kill_handler =
+          trap Runner.kill_signal do |*a|
+            begin
+              Runner.kill_signaled true
+            rescue Exception => e
+              Bj.logger.error{ e } rescue nil
+            end
+            kill_handler.call *a rescue nil
+          end
+
+        begin
+          trap("INT"){ exit }
+        rescue Exception
+        end
+      end
+
+      def fill_morgue
+        Bj.transaction do
+          now = Time.now
+          jobs = Bj::Table::Job.find :all,
+                                     :conditions => ["state = 'running' and runner = ?", Bj.hostname]
+          jobs.each do |job|
+            if job.is_restartable?
+              Bj.logger.info{ "#{ job.title } - found dead and bloated but resubmitted" }
+              %w[ runner pid started_at finished_at stdout stderr exit_status ].each do |column|
+                job[column] = nil
+              end
+              job.state = 'pending'
+            else
+              Bj.logger.info{ "#{ job.title } - found dead and bloated" }
+              job.state = 'dead'
+              job.finished_at = now
+            end
+            job.save!
+          end
+        end
+      end
+
+      def archive_jobs
+        Bj.transaction do
+          now = Time.now
+          too_old = now - Bj.ttl
+          jobs = Bj::Table::Job.find :all,
+                                     :conditions => ["(state = 'finished' or state = 'dead') and submitted_at < ?", too_old]
+          jobs.each do |job|
+            Bj.logger.info{ "#{ job.title } - archived" }
+            hash = job.to_hash.update(:archived_at => now)
+            Bj::Table::JobArchive.create! hash 
+            job.destroy
+          end
+        end
+      end
+
+      def register
+        Bj.transaction do
+          pid = Bj.config[key]
+          return false if Util.alive?(pid)
+          Bj.config[key] = Process.pid
+          unless Bj.util.ipc_signals_supported? # not winblows
+            require "drb"
+            DRb.start_service "druby://localhost:0", Process
+            Bj.config["#{ Process.pid }.uri"] = DRb.uri 
+          end
+        end
+        at_exit{ unregister }
+        true
+      rescue Exception
+        false
+      end
+
+      def unregister
+        Bj.transaction do
+          Bj.config.delete key
+        end
+        true
+      rescue Exception
+        false
+      end
+
+      def key
+        @key ||= ( options[:ppid] ? Runner.key(options[:ppid]) : Runner.key )
+      end
+    end
+    send :include, Instance_Methods
+  end
+end