yajm 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a29284d81f85cc02371a19dab30aa94ea5f81e0
+  data.tar.gz: 98ec5d62ceeb18572517ae2a3ec9c0bfbeb5fad2
+SHA512:
+  metadata.gz: 2758736cb64b6798e87fafbbe06b07f2d16dbf7db71a3d56bc264bacaf86aec04f65d8739995f4d7a0eed31c33d11d2c189fc8bd04b22724f5018135e0c759b7
+  data.tar.gz: 10d6f882c764e92be9efdf12d544d5972e3863d7723c8acd78d42c592391a4dba9b86921cb83cf66cdf198a35a5d8219b85e2ce38b15817f5ff675bf027b6b4a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yajm.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jose Luis Salas
+
+MIT License
+
+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,29 @@
+# Yajm
+
+A simple job manager inspired by Twke job manager.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yajm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yajm
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/yajm/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/yajm/job.rb

@@ -0,0 +1,85 @@
+require 'fileutils'
+require 'eventmachine'
+
+module Yajm
+  class Job < EventMachine::Connection
+    attr_reader :start_time, :end_time, :pid, :command
+
+    def initialize(params)
+      @start_time = params[:start_time]
+      @end_time = nil
+      @pid = params[:pid]
+      @command = params[:command]
+
+      @opts = params
+      @dfr = EM::DefaultDeferrable.new
+
+      # All output is sent immediately to disk
+      @out_filename = File.join(@opts[:tmpdir], "output.txt")
+      @out_file = File.open(@out_filename, "w+")
+      @out_file.sync = true
+      @out_file.close_on_exec = true
+      super
+    end
+
+    alias_method :jid, :pid
+
+    def callback(&blk)
+      @dfr.callback(&blk)
+    end
+
+    def errback(&blk)
+      @dfr.errback(&blk)
+    end
+
+    def output
+      File.read(@out_filename)
+    end
+
+    def output_tail
+      %x{tail -n 20 #{@out_filename}}
+    end
+
+    def kill!
+      # Kill the process group
+      Process.kill("-TERM", self.pid) rescue 0
+    end
+
+    def notify_readable
+      begin
+        result = @io.read_nonblock(1024)
+        @out_file.write(result)
+      rescue IO::WaitReadable
+      rescue EOFError
+        detach
+      end
+    end
+
+    # Invoked when the process completes and is passed the status
+    #
+    def finished(status)
+      @end_time = Time.now
+      if status.success?
+        @dfr.succeed(self)
+      else
+        @dfr.fail(self)
+      end
+    end
+
+    def unbind
+      @io.close
+      @out_file.fsync
+      @out_file.close
+      @out_file = nil
+    end
+
+    # Remove any temporary files
+    def cleanup
+      FileUtils.rm(@out_filename)
+
+      # XXX: could be rm-rf, but be safe for now. Might have
+      # problems if app creates files in $PWD
+      FileUtils.rmdir(@opts[:tmpdir])
+    end
+  end
+end

data/lib/yajm/job_manager.rb

@@ -0,0 +1,231 @@
+require 'fileutils'
+require 'yajm/job'
+
+module Yajm
+  module JobManager
+    MAX_FD_CLOSE = 1024
+
+    # Watch the read end of the SIGCLD notication pipe
+    class ProcessPipeWatch < EM::Connection
+      def initialize(procwatch)
+        @procwatch = procwatch
+      end
+
+      def notify_readable
+        @procwatch.handle_process_exit
+      rescue EOFError
+        detach
+      end
+
+      def unbind
+        @io.close
+      end
+    end
+
+    class ProcessWatch
+      # How long do we keep finished jobs around?
+      FINISHED_JOB_WAIT_SECS = 1800
+
+      def initialize
+        # Active running jobs
+        @active = {}
+
+        # Finished queue -- entries are evicted after an hour
+        @finished = {}
+
+        rd, wr = IO::pipe
+
+        rd.close_on_exec = true
+        wr.close_on_exec = true
+
+        @watched_pids_fd = {:rd => rd, :wr => wr}
+      end
+
+      def start
+        conn = EM::watch(@watched_pids_fd[:rd], ProcessPipeWatch, self)
+        conn.notify_readable = true
+
+        EM::PeriodicTimer.new(300) do
+          purge_finished_jobs
+        end
+      end
+
+      def purge_finished_jobs
+        now = Time.now
+        @finished.delete_if do |pid, job|
+          done = (now - job.end_time) > FINISHED_JOB_WAIT_SECS
+          job.cleanup if done
+          done
+        end
+      end
+
+      # Watch the PID and notify the spawned job
+      def watch_pid(pid, sj)
+        @active[pid] = sj
+      end
+
+      def active_jobs
+        @active.values.sort{|a, b| a.start_time <=> b.start_time }
+      end
+
+      def finished_jobs
+        @finished.values.sort{|a, b| a.end_time <=> b.end_time }
+      end
+
+      def job(id)
+        @active[id] || @finished[id]
+      end
+
+      def alert_exit
+        # Don't handle signal, just wake up the reactor
+        @watched_pids_fd[:wr].write_nonblock("1")
+      end
+
+      # Invoked when a SIGCLD occurs
+      def handle_process_exit
+        begin
+          # Drain the pipe
+          begin
+            result = @watched_pids_fd[:rd].read_nonblock(1024)
+          rescue IO::WaitReadable
+            result = nil
+          end
+        end while result
+
+        # Check all processes waiting.
+        begin
+          begin
+            pid, status = Process.waitpid2(-1, Process::WNOHANG)
+          rescue Errno::ECHILD => err
+            pid = nil
+          end
+
+          if pid
+            # If there is a callback, invoke it. The process may
+            # not belong to us.
+            #
+            proc = @active.delete(pid)
+            if proc
+              proc.finished(status)
+              @finished[proc.pid] = proc
+            end
+          end
+        end while pid
+      end
+    end
+
+    class << self
+
+      def init
+        return if @process_watcher
+
+        @process_watcher = ProcessWatch.new
+        @process_watcher.start
+
+        trap("CHLD") do
+          # Alert the process watcher that a process exited.
+          @process_watcher.alert_exit
+        end
+      end
+
+      def list
+        # Return a list of the jobs
+        jobs = { :active => [], :finished => [] }
+        return jobs unless @process_watcher
+
+        jobs[:active] = @process_watcher.active_jobs
+        jobs[:finished] = @process_watcher.finished_jobs
+        jobs
+      end
+
+      def getjob(jid)
+        return nil unless @process_watcher
+
+        @process_watcher.job(jid)
+      end
+
+      #
+      # When invoked, will spawn the command in 'cmdstr' using
+      # exec. Returns an EM:Deferrable and the success callback will
+      # be invoked if the command succeeds or else the errback will be
+      # invoked. Both callbacks are passed the program output.
+      #
+      def spawn(cmdstr, opts = {})
+        self.init
+
+        # All jobs have a temporary directory.
+        tmproot = ENV['TMPDIR'] || "/tmp"
+        jobtmpdir = File.join(tmproot, "jobs/job_#{rand 9999999}")
+
+        FileUtils.mkdir_p(jobtmpdir)
+
+        rd, wr = IO::pipe
+        start_time = Time.now
+        pid = fork do
+          rd.close
+
+          # Job control
+          #
+          Process.setpgid(Process.pid, Process.pid)
+
+          # Reset signals
+          trap("INT", "DEFAULT")
+          trap("QUIT", "DEFAULT")
+          trap("TSTP", "DEFAULT")
+          trap("TTIN", "DEFAULT")
+          trap("TTOU", "DEFAULT")
+          trap("CHLD", "DEFAULT")
+
+          # Fix lack of close-on-exec use
+          3.upto(MAX_FD_CLOSE) do |fd|
+            next if fd == wr.fileno
+
+            begin
+              f = IO.new(fd)
+              f.close
+            rescue
+            end
+          end
+
+          # Tie stdout and stderr together
+          $stdout.reopen wr
+          $stderr.reopen wr
+
+          # Set environs if specified
+          opts[:environ].each_pair do |k, v|
+            ENV[k] = v
+          end if opts[:environ]
+
+          dir = opts[:dir] || jobtmpdir
+
+          Dir.chdir(dir) do
+            exec(cmdstr)
+          end
+
+          # Shouldn't get here unless the exec fails
+          exit 127
+        end
+
+        wr.close
+        rd.close_on_exec = true
+
+        params = {
+          :chdir => opts[:dir] || jobtmpdir,
+          :tmpdir => jobtmpdir,
+          :pid => pid,
+          :command => cmdstr,
+          :start_time => start_time,
+        }
+
+        d = EM::watch(rd, Job, params)
+        d.notify_readable = true
+
+        # Watch the process to notify when it completes
+        @process_watcher.watch_pid(pid, d)
+
+        return d
+      end
+    end
+  end
+end
+

data/lib/yajm/version.rb

@@ -0,0 +1,3 @@
+module Yajm
+  VERSION = "0.0.3"
+end

data/lib/yajm.rb

@@ -0,0 +1,2 @@
+require 'yajm/version'
+require 'yajm/job_manager'

data/yajm.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yajm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yajm"
+  spec.version       = Yajm::VERSION
+  spec.authors       = ["Jose Luis Salas"]
+  spec.email         = ["josacar@gmail.com"]
+  spec.summary       = %q{Yet another job manager.}
+  spec.description   = %q{A simple job manager inspired by Twke job manager.}
+  spec.homepage      = "https://github.com/josacar/yajm"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'eventmachine'
+  spec.add_development_dependency "bundler", "~> 1.6"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: yajm
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Jose Luis Salas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: A simple job manager inspired by Twke job manager.
+email:
+- josacar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/yajm.rb
+- lib/yajm/job.rb
+- lib/yajm/job_manager.rb
+- lib/yajm/version.rb
+- yajm.gemspec
+homepage: https://github.com/josacar/yajm
+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: Yet another job manager.
+test_files: []