iyyov 1.0.0-java → 1.0.1-java

data/History.rdoc

@@ -1,2 +1,10 @@
+=== 1.0.1 (2010-3-13)
+* Fix dependencies
+* Cleanup and add config examples to gem, including init.d and crontab
+  examples.
+* Proper README.rdoc
+* Add context file load error handling and example config tests.
+* Improve error handling with tasks (log, :stop on StandardError)
+
 === 1.0.0 (2010-3-7)
 * Initial release.

data/Manifest.txt

@@ -13,6 +13,14 @@ lib/iyyov/log_rotator.rb
 lib/iyyov/scheduler.rb
 lib/iyyov/shutdown_handler.rb
 lib/iyyov/task.rb
+config/async.rb
+config/crontab
+config/jobs.rb
+config/load-all.rb
+config/init.d/iyyov
+test/jobs-bad.rb
+test/jobs-dupe.rb
 test/setup.rb
+test/test_context.rb
 test/test_daemon.rb
 test/test_scheduler.rb

data/README.rdoc

@@ -6,13 +6,77 @@
 
 == Description
 
-Down-to-earth job control and monitoring. Features include:
+Down-to-earth job control and monitoring.
 
-* Runs on JRuby (no fork)
-* Ruby-based configuration
-* Gem packaged/Hashdot daemon based launching
+=== Features
+
+* Runs on JRuby (no fork or native code extensions)
+* Powerful ruby-based configuration inspired by {God}[http://god.rubyforge.org]
+* Simplified gem packaged daemon launching and monitoring (via Hashdot, others)
 * Log rotation with daemon SIGHUP support
-* Fixed and periodic time job scheduling (basic cron replacement).
+* Fixed and periodic time job scheduling (basic cron replacement)
+  * Threaded asynchronous support with mutual exclusion for long
+    running scheduled jobs
+* Configuration file monitoring and reload support
+  * Automatic daemon restart on upgrade or other changes
+
+== Synopsis
+
+Iyyov can be tested in the foreground with (-d)ebug logging:
+
+  % iyyov-fg -d jobs.rb
+
+See gem or source config/ directory for sample/runnable
+configurations. Sample jobs.rb configuration:
+
+  Iyyov.context do |c|
+
+    c.define_daemon do |d|
+      d.name     = "hashdot-test-daemon"
+      d.version  = "~> 1.0.0"
+      d.log_rotate do |l|
+        l.max_size_mb = 256
+      end
+    end
+
+    c.schedule_at( :name => "hello", :period => 3.0 ) do
+      puts "hello every 3.0 seconds"
+    end
+
+    c.schedule_at( :name => "fixed",
+                   :fixed_times => %w[ 00:01 12:02 ] ) do
+      puts "Fixed time task"
+    end
+
+  end
+
+== Daemon support
+
+The simple form of the define_daemon creates an Iyyov::Daemon
+based on the following conventions:
+
+* The required name by default is used as a gem name as well as init
+  script name.
+* Most all set attributes may be lambda's.
+* If a version is specified, the default Daemon.exe_path will be an
+  init script with the same name and provided by the same named gem
+  and highest matching version.
+* In any case, the Daemon.exe_path should itself demonize and create
+  a pid in order to be monitored.
+  {Hashdot}[http://hashdot.sourceforge.net/] provides one reliable
+  means of achieving this. Its could also be achieved via a bash
+  script.
+
+== Setup
+
+Besides creating one or many jobs.rb scripts, you will want to arrange
+for iyyov to be started on system boot. There are several ways to
+achieve this:
+
+* UNIX init.d script (a CentOS/Fedora version is provided in gem or source
+  config/init.d directory)
+* inittab or upstart (which also supports monitoring iyyov/restarting itself)
+* Crontab (an example is provided at gem or source config/crontab)
 
 == License
 

data/Rakefile

@@ -28,26 +28,38 @@ t = RJack::TarPit.new( 'iyyov', Iyyov::VERSION, :java_platform )
 t.specify do |h|
   h.developer( 'David Kellum', 'dek-oss@gravitext.com' )
   h.testlib = :minitest
-  h.extra_deps     += [ [ 'rjack-sfl4j',         '~> 1.5.11' ],
+  h.extra_deps     += [ [ 'rjack-slf4j',         '~> 1.5.11' ],
                         [ 'rjack-logback',       '~> 0.9.18' ],
-                        [ 'logrotate',           '=  1.2.1' ] ]
-  h.extra_dev_deps += [ [ 'minitest',            '~> 1.5.0' ],
-                        [ 'hashdot-test-daemon', '>= 1.0.0' ] ]
+                        [ 'logrotate',           '=  1.2.1'  ] ]
+  h.extra_dev_deps += [ [ 'minitest',            '~> 1.5.0'  ],
+                        [ 'hashdot-test-daemon', '>= 1.0.0'  ] ]
 end
 
-task :check_init_version do
+# Version/date consistency checks:
+
+task :chk_init_v do
   t.test_line_match( 'init/iyyov-daemon',
                       /^gem.+#{t.name}/, /= #{t.version}/ )
 end
-task :check_history_version do
+task :chk_rcd_v do
+  t.test_line_match( 'config/init.d/iyyov', /^version=".+"/, /"#{t.version}"/ )
+end
+task :chk_cron_v do
+  t.test_line_match( 'config/crontab', /gems\/iyyov/,
+                     /iyyov-#{t.version}-java/ )
+end
+task :chk_hist_v do
   t.test_line_match( 'History.rdoc', /^==/, / #{t.version} / )
 end
-task :check_history_date do
+
+gem_tests = [ :chk_init_v, :chk_rcd_v, :chk_cron_v, :chk_hist_v  ]
+
+task :chk_hist_date do
   t.test_line_match( 'History.rdoc', /^==/, /\([0-9\-]+\)$/ )
 end
 
-task :gem  => [ :check_init_version, :check_history_version ]
-task :tag  => [ :check_init_version, :check_history_version, :check_history_date ]
-task :push => [                                              :check_history_date ]
+task :gem  => gem_tests
+task :tag  => gem_tests + [ :chk_hist_date ]
+task :push => [ :chk_hist_date ]
 
 t.define_tasks

data/config/async.rb

@@ -0,0 +1,11 @@
+
+Iyyov.context do |c|
+  count = 0
+  log = SLF4J["hello"]
+  c.schedule_at( :name => "hello", :mode => :async, :period => 1.5 ) do
+    count += 1
+    sleep count
+    log.info "Hello after #{count}s"
+    :stop unless count <= 10 # Avoid killing ourselves.
+  end
+end

data/config/crontab

@@ -0,0 +1,2 @@
+# PATH=/opt/bin
+*/1 * * * * cd /opt/var/iyyov && /opt/jruby/gems/gems/iyyov-1.0.1-java/init/iyyov-daemon jobs.rb

data/config/init.d/iyyov

@@ -0,0 +1,97 @@
+#!/bin/bash
+#
+# iyyov    Startup script for Iyyov monitoring daemon
+#
+# chkconfig: 2345 88 12
+# description: Iyyov daemon
+# processname: iyyov-daemon
+# config: /opt/var/iyyov/jobs.rb
+
+. /etc/rc.d/init.d/functions
+
+# Gem home directory
+# Set to match system "jgem environment path"
+gem_home="/opt/jruby/gems"
+
+# (Exact) Gem version of iyyov to run
+version="1.0.1"
+
+# User to run the daemon as (should own rundir)
+user="iyyov"
+
+# Running directory (for jobs.rb config, log, and pid file)
+rundir="/opt/var/iyyov"
+
+# Add PATH to jruby if non-standard
+export PATH=/opt/bin:$PATH
+
+prog="iyyov-daemon"
+daemon="${gem_home}/gems/iyyov-${version}-java/init/${prog}"
+config="${rundir}/jobs.rb"
+pidfile="${rundir}/${prog}.pid"
+
+RETVAL=0
+
+start() {
+    [ -x "$daemon" ] || exit 5
+    [ -f "$config" ] || exit 6
+    [ -d "$rundir" ] || exit 7
+
+    echo -n $"Starting $prog: "
+    runuser -c "cd $rundir && $daemon $config" $user
+    RETVAL=$?
+    [ $RETVAL -eq 0 ] && success $"$prog startup" || failure $"$prog startup"
+    echo
+}
+
+status() {
+    if [ -f "$pidfile" ]; then
+        echo "Status $prog: running pid $(<$pidfile)"
+    else
+        echo "Status $prog: not running"
+    fi
+}
+
+reload() {
+    if [ -e "$pidfile" ]; then
+        touch $config
+    fi
+}
+
+stop() {
+    echo -n $"Shutting down $prog: "
+    killproc -p $pidfile $prog
+    RETVAL=$?
+    [ $RETVAL -eq 0 ] && success || failure
+    echo
+    return $RETVAL
+}
+
+case "$1" in
+    start)
+        start
+        ;;
+    stop)
+        stop
+        ;;
+    status)
+        status
+        ;;
+    reload)
+        reload
+        ;;
+    restart)
+        stop
+        start
+        RETVAL=$?
+        ;;
+    condrestart)
+        [ -e $pidfile ] && restart
+        RETVAL=$?
+        ;;
+    *)
+        echo $"Usage: $0 {start|stop|status|reload|restart|condrestart}"
+        RETVAL=1
+esac
+
+exit $RETVAL

data/config/jobs.rb

@@ -0,0 +1,29 @@
+Iyyov.context do |c|
+
+  c.define_daemon do |d|
+    d.name     = "hashdot-test-daemon"
+    d.version  = "~> 1.0.0"
+    d.stop_on_exit = true
+    d.stop_delay = 2.0
+    d.log_rotate
+    d.log_rotate do |l|
+      l.max_size = 500
+      l.check_period = 21.0
+    end
+  end
+
+  c.schedule_at( :name => "hello", :period => 3.0 ) do
+    puts "hello every 3.0 seconds"
+  end
+
+  c.schedule_at( :name => "fixed",
+                 :fixed_times => %w[ 00:03 1:00 2:00 3:00 4:00 12:00 ] ) do
+    puts "Fixed time task"
+  end
+
+  c.iyyov_log_rotate do |l|
+    l.max_size = 50_000
+    l.check_period = 17.0
+  end
+
+end

data/config/load-all.rb

@@ -0,0 +1,10 @@
+
+Iyyov.context do |c|
+
+  # Load all the other config examples in this directory.  Avoid
+  # recursively reading self.
+  Dir[ File.join( File.dirname( __FILE__ ), '*.rb' ) ].each do |conf|
+    c.load_file( conf ) unless conf == __FILE__
+  end
+
+end

data/init/iyyov-daemon

@@ -24,7 +24,7 @@
 
 require 'rubygems'
 
-gem( "iyyov", "= 1.0.0" )
+gem( "iyyov", "= 1.0.1" )
 
 require 'rjack-logback'
 RJack::Logback.config_console( :full => true, :thread => true )

data/lib/iyyov/base.rb

@@ -16,5 +16,5 @@
 
 module Iyyov
   # Iyyov version
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/iyyov/daemon.rb

@@ -22,7 +22,7 @@ require 'iyyov/log_rotator'
 module Iyyov
   include RJack
 
-  # A daemon isntance to start and monitor
+  # A daemon instance to start and monitor
   class Daemon
 
     # Name of this daemon. Must be unique in combination with any
@@ -101,13 +101,6 @@ module Iyyov
     # Symbol (in STATES)
     attr_reader   :state
 
-    # Once do_first is called and provided a gem is found (gem version
-    # specified).
-    #
-    # Gem::Specification
-    # FIXME: May not want to expose this.
-    attr_reader   :gem_spec
-
     # States tracked
     STATES = [ :begin, :up, :failed, :stopped ]
 
@@ -231,7 +224,6 @@ module Iyyov
     end
 
     def find_gem_spec
-      #FIXME: Use Gem.clear_paths to rescan.
       @gem_spec ||= Gem.source_index.find_name( gem_name, version ).last
       unless @gem_spec
         raise( Gem::GemNotFoundException, "Missing gem #{gem_name} (#{version})" )

data/lib/iyyov/log_rotator.rb

@@ -77,7 +77,6 @@ module Iyyov
 
       yield self if block_given?
 
-      #FIXME: Validate log directory?
       nil
     end
 

data/lib/iyyov/task.rb

@@ -67,7 +67,10 @@ module Iyyov
 
       @block = block
 
-      #FIXME: Validation?
+      unless period || fixed_times
+        raise( SetupError,
+               "Task #{ opts.inspect } needs one of period or fixed_times" )
+      end
 
       @log = SLF4J[ [ SLF4J[ self.class ].name, name ].compact.join( '.' ) ]
 
@@ -125,9 +128,13 @@ module Iyyov
 
     def run_direct
       @log.debug "Running."
-      rc = ( @block.call if @block )
-      #FIXME: Errors to handle?
-      filter( rc )
+      begin
+        rc = ( @block.call if @block )
+        filter( rc )
+      rescue StandardError => e
+        @log.error( "Handled and stopped with: ", e )
+        :stop
+      end
     end
 
     def filter( rc )

data/lib/iyyov.rb

@@ -41,6 +41,10 @@ module Iyyov
     @context
   end
 
+  def self.set_test_context
+    @context = Context.new
+  end
+
   # Load root configuration files.
   def self.load_root_files( files )
     old_context = @context

data/test/jobs-bad.rb

@@ -0,0 +1 @@
+no_method_by_this_name

data/test/jobs-dupe.rb

@@ -0,0 +1,11 @@
+Iyyov.context do |c|
+
+  c.define_daemon do |d|
+    d.name     = "hashdot-test-daemon"
+  end
+
+  c.define_daemon do |d|
+    d.name     = "hashdot-test-daemon"
+  end
+
+end

data/test/test_context.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env jruby
+#.hashdot.profile += jruby-shortlived
+#--
+# Copyright (C) 2010 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You
+# may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+TESTDIR = File.dirname( __FILE__ )
+
+require File.join( TESTDIR, "setup" )
+
+require 'iyyov'
+
+class TestContext < MiniTest::Unit::TestCase
+  def setup
+    Iyyov.set_test_context
+  end
+
+  def teardown
+    Iyyov.context.shutdown
+  end
+
+  def test_load_ruby_error
+    Iyyov.context do |c|
+      c.load_file( File.join( TESTDIR, "jobs-bad.rb" ) )
+      pass
+    end
+    pass
+  end
+
+  def test_load_dupe_error
+    Iyyov.context do |c|
+      c.load_file( File.join( TESTDIR, "jobs-dupe.rb" ) )
+      pass
+    end
+    pass
+  end
+
+  def test_load_samples
+    Dir[ File.join( TESTDIR, '..', 'config', '*.rb' ) ].each do |conf|
+      Iyyov.context { |c| c.load_file( conf ) }
+      Iyyov.context.shutdown
+      Iyyov.set_test_context
+      pass
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: iyyov
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: java
 authors: 
   - David Kellum
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-07 00:00:00 -08:00
+date: 2010-03-12 23:00:00 -08:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
-    name: rjack-sfl4j
+    name: rjack-slf4j
     type: :runtime
     version_requirement: 
     version_requirements: !ruby/object:Gem::Requirement 
@@ -72,14 +72,7 @@ dependencies:
           - !ruby/object:Gem::Version 
             version: 1.2.0
       version: 
-description: |-
-  Down-to-earth job control and monitoring. Features include:
-  
-  * Runs on JRuby (no fork)
-  * Ruby-based configuration
-  * Gem packaged/Hashdot daemon based launching
-  * Log rotation with daemon SIGHUP support
-  * Fixed and periodic time job scheduling (basic cron replacement).
+description: Down-to-earth job control and monitoring.
 email: 
   - dek-oss@gravitext.com
 executables: 
@@ -106,7 +99,15 @@ files:
   - lib/iyyov/scheduler.rb
   - lib/iyyov/shutdown_handler.rb
   - lib/iyyov/task.rb
+  - config/async.rb
+  - config/crontab
+  - config/jobs.rb
+  - config/load-all.rb
+  - config/init.d/iyyov
+  - test/jobs-bad.rb
+  - test/jobs-dupe.rb
   - test/setup.rb
+  - test/test_context.rb
   - test/test_daemon.rb
   - test/test_scheduler.rb
 has_rdoc: true
@@ -137,7 +138,8 @@ rubyforge_project: iyyov
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Down-to-earth job control and monitoring
+summary: Down-to-earth job control and monitoring.
 test_files: 
+  - test/test_context.rb
   - test/test_scheduler.rb
   - test/test_daemon.rb