iyyov 1.0.0-java

data/lib/iyyov/task.rb

@@ -0,0 +1,179 @@
+#--
+# 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.
+#++
+
+require 'date'
+require 'time'
+require 'thread'
+
+module Iyyov
+
+  # A task to be scheduled and run.
+  class Task
+
+    # Regular interval between subsequent executions in seconds.
+    #
+    # Numeric (default: nil, use fixed_times)
+    attr_accessor :period
+
+    # One or more fixed time values in 24hour format, local
+    # timezone, i.e: [ "11:30", "23:30" ]
+    #
+    # ~to_a[String] (default: nil, use period)
+    attr_accessor :fixed_times
+
+    # Array or range for days of week in which fixed_times apply. Days
+    # are 0 (Sunday) .. 6 (Saturday). Example: M-F == (1..5)
+    #
+    # ~include?( day_of_week ) (default: (0..6))
+    attr_accessor :fixed_days
+
+    # Name the task for log reporting.
+    #
+    # String (default: nil)
+    attr_accessor :name
+
+    # Execution mode. If :async, run in separate thread, but only
+    # allow one thread for this task to run at any time.
+    #
+    # Symbol :sync|:async (default: :sync)
+    attr_accessor :mode
+
+    # Once schedule succeeds, the absolute next time to execute.
+    attr_reader :next_time
+
+    # New task given options matching accessors and block containing
+    # work.
+    def initialize( opts = {}, &block )
+      @name        = nil
+      @next_time   = nil
+      @period      = nil
+      @fixed_times = nil
+      @fixed_days  = (0..6) #all
+
+      opts.each { |k,v| send( k.to_s + '=', v ) }
+
+      @block = block
+
+      #FIXME: Validation?
+
+      @log = SLF4J[ [ SLF4J[ self.class ].name, name ].compact.join( '.' ) ]
+
+      @lock = ( Mutex.new if mode == :async )
+      @async_rc = nil
+
+      @log.info { "Task created : #{ opts.inspect }" }
+    end
+
+    # Execute the task, after which the task will be scheduled again
+    # in period time or for the next of fixed_times, unless :stop is
+    # returned.
+    def run
+      rc = :continue
+      if mode == :async
+        rc = test_async_return_code
+        run_thread if rc == :continue
+      else
+        rc = run_direct
+      end
+      rc
+    end
+
+    def test_async_return_code
+      rc = :continue
+      # Note: Currently only the main event loop thread goes here and
+      # so the only case for contention is this task already running
+      # in run_thread. In this case we can warn + :skip early.
+      if @lock.try_lock
+        begin
+          rc = @async_rc if ( @async_rc == :stop ) || ( @async_rc == :shutdown )
+        ensure
+          @lock.unlock
+        end
+      else
+        @log.warn "Already running, (pre) skipping this run."
+        rc = :skip
+      end
+      rc
+    end
+
+    def run_thread
+      Thread.new do
+        if @lock.try_lock
+          begin
+            @async_rc = run_direct
+          ensure
+            @lock.unlock
+          end
+        else
+          @log.warn "Already running, skipping this run."
+        end
+      end
+    end
+
+    def run_direct
+      @log.debug "Running."
+      rc = ( @block.call if @block )
+      #FIXME: Errors to handle?
+      filter( rc )
+    end
+
+    def filter( rc )
+      rc.is_a?( Symbol ) ? rc : :continue
+    end
+
+    # Determine next_time from now based on period or fixed_times
+    def schedule( now )
+      @next_time = nil
+
+      if fixed_times
+        @next_time = next_fixed_time( now )
+      elsif period
+        @next_time = ( now + period )
+      end
+
+      if @next_time && ( @next_time - now ) > 60.0
+        @log.debug { "Next run scheduled @ #{ next_time_to_s }" }
+      end
+
+      @next_time
+    end
+
+    def next_time_to_s
+      @next_time.strftime( '%Y-%m-%dT%H:%M:%S' ) if @next_time
+    end
+
+    def next_fixed_time( now )
+      day = Date.civil( now.year, now.month, now.day )
+      last = day + 7
+      ntime = nil
+      while ntime.nil? && day <= last
+        if fixed_days.include?( day.wday )
+          fixed_times.to_a.each do |ft|
+            ft = time_on_date( day, Time.parse( ft, now ) )
+            ntime = ft if ( ( ft > now ) && ( ntime.nil? || ft < ntime ) )
+          end
+        end
+        day += 1
+      end
+      ntime
+    end
+
+    def time_on_date( d, t )
+      Time.local( d.year, d.month, d.day, t.hour, t.min, t.sec, t.usec )
+    end
+
+  end
+end

data/lib/iyyov.rb

@@ -0,0 +1,78 @@
+#--
+# 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.
+#++
+
+require 'iyyov/base'
+require 'iyyov/context'
+
+module Iyyov
+
+  # Load configuration root_files and run the event loop, not
+  # returning. Yields new Context to optional block for extra
+  # configuration to be applied before any root_files are loaded.
+  def self.run( root_files, &block )
+    @extra_config_block = block
+    load_root_files( root_files )
+
+    continue = true
+    while( continue && @context )
+      rc = @context.event_loop
+      continue = ( rc == :shutdown )
+    end
+  end
+
+  # Yields current context to block. Called from configuration
+  # scripts.
+  def self.context
+    raise "Iyyov.context called before run" unless @context
+    yield @context if block_given?
+    @context
+  end
+
+  # Load root configuration files.
+  def self.load_root_files( files )
+    old_context = @context
+    @context = Context.new
+
+    @extra_config_block.call( @context ) if @extra_config_block
+
+    all_success = true
+    files.each { |cfile| all_success &&= @context.load_file( cfile, true ) }
+
+    if old_context
+      if all_success
+        # Stop old daemons that are no longer in the newly configured
+        # context, or who's exec_key has changed
+        old_context.daemons.each do |name,odaemon|
+          ndaemon = @context.daemons[name]
+          odaemon.stop unless ndaemon && ndaemon.exec_key == odaemon.exec_key
+        end
+      else
+        @context = old_context
+      end
+    end
+
+    all_success
+  end
+
+  #Class Instance Variables
+
+  #Presently active context
+  @context = nil
+
+  #Optional extra configuration block
+  @extra_config_block = nil
+
+end

data/test/setup.rb

@@ -0,0 +1,50 @@
+#--
+# 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.
+#++
+
+#### General test setup: LOAD_PATH, logging, console output ####
+
+ldir = File.join( File.dirname( __FILE__ ), "..", "lib" )
+$LOAD_PATH.unshift( ldir ) unless $LOAD_PATH.include?( ldir )
+
+def time_it( name )
+  start = Time.now
+  output = ARGV.include?( '-v' )
+  $stdout.write( "Loading %10s..." % name ) if output
+  yield
+  puts "%6.3fs" % (Time.now - start) if output
+end
+
+time_it( "rubygems" ) do
+  require 'rubygems'
+end
+
+time_it( "logback" ) do
+  require 'rjack-logback'
+  RJack::Logback.config_console( :level => Logback::INFO, :stderr => true )
+end
+
+time_it( "test/unit" ) do
+  require 'minitest/unit'
+  require 'minitest/autorun'
+
+  # Make test output logging compatible: no partial lines.
+  class TestOut
+    def print( *a ); $stdout.puts( *a ); end
+    def puts( *a );  $stdout.puts( *a ); end
+  end
+  MiniTest::Unit.output = TestOut.new
+
+end

data/test/test_daemon.rb

@@ -0,0 +1,89 @@
+#!/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.
+#++
+
+require File.join( File.dirname( __FILE__ ), "setup" )
+
+require 'iyyov'
+require 'fileutils'
+
+class TestDaemon < MiniTest::Unit::TestCase
+  include Iyyov
+
+  def setup
+    @log = RJack::SLF4J[ self.class ]
+    @tdir = File.dirname( __FILE__ )
+    @context = Context.new do |c|
+      c.base_dir = @tdir
+    end
+  end
+
+  def teardown
+    @context.event_loop #Confirm return
+    @context.shutdown
+    %w[ hashdot-test-daemon hashdot-noexist ].each do |rdir|
+      FileUtils.rm_rf( File.join( @tdir, rdir ) )
+    end
+  end
+
+  def test_init
+    d = Daemon.new( @context ) do |h|
+      h.name     = "myname"
+      h.instance = '33'
+    end
+
+    assert_equal( "myname",                            d.gem_name )
+    assert_equal( "#{@tdir}/myname-33",                d.run_dir )
+    assert_equal( "#{@tdir}/myname-33/myname.pid",     d.pid_file )
+  end
+
+  def test_exe_path
+    d = Daemon.new( @context ) { |h| h.name = "hashdot-test-daemon" }
+    assert File.executable?( d.exe_path )
+    @log.info d.exe_path
+  end
+
+  def test_invalid_init_name
+    d = Daemon.new( @context ) do |h|
+      h.name = "hashdot-test-daemon"
+      h.init_name = "no-exist"
+    end
+    assert_equal( :stop, d.do_first( nil ) )
+  end
+
+  def test_invalid_run_dir
+    d = Daemon.new( @context ) do |h|
+      h.name = "hashdot-test-daemon"
+      h.run_dir = "/no-permission"
+    end
+    assert_equal( :stop, d.do_first( nil ) )
+  end
+
+  def test_invalid_gem_name
+    d = Daemon.new( @context ) { |h| h.name = "hashdot-noexist" }
+    assert_equal( :stop, d.do_first( nil ) )
+ end
+
+  def test_invalid_gem_version
+    d = Daemon.new( @context ) do |h|
+      h.name = "hashdot-test-daemon"
+      h.version = "= 6.6.6"
+    end
+    assert_equal( :stop, d.do_first( nil ) )
+  end
+
+end

data/test/test_scheduler.rb

@@ -0,0 +1,75 @@
+#!/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.
+#++
+
+require File.join( File.dirname( __FILE__ ), "setup" )
+
+require 'iyyov/scheduler'
+require 'iyyov/task'
+
+class TestScheduler < MiniTest::Unit::TestCase
+  include Iyyov
+
+  def test_run
+    counter = 0
+    s = Scheduler.new
+    tk = Task.new( :name => "test_run", :period => 0.001 ) do
+      counter += 1
+      assert( counter <= 2 )
+      :stop unless counter < 2
+    end
+    s.add( tk )
+    s.event_loop
+  end
+
+  def test_fixed_times
+    tk = Task.new( :fixed_times => %w[ 6:00 8:00 10:00 12:00 ] )
+
+    assert_next_time_from( tk, '2010-02-08T08:00', '2010-02-08T10:00' )
+
+    assert_next_time_from( tk, '2010-02-08T12:00', '2010-02-09T06:00' )
+
+    tk.fixed_days = 3..6
+    assert_next_time_from( tk, '2010-02-08T08:00', '2010-02-10T06:00' )
+  end
+
+  def assert_next_time_from( tk, now, expected )
+    2.times do
+      assert_equal( tp( expected ), tk.next_fixed_time( tp( now ) ) )
+      tk.fixed_times = tk.fixed_times.reverse
+    end
+  end
+
+  def test_shutdown
+    s = Scheduler.new
+    s.on_exit { flunk "Shouldn't make it here" }
+    counter = 0
+    tk = Task.new( :name => "test_shutdown", :period => 0.001 ) do
+      counter += 1
+      assert( counter <= 2 )
+      :shutdown unless counter < 2
+    end
+    s.add( tk )
+    s.add( Task.new( :period => 5.0 ) { flunk "nor here" } )
+    assert_equal( :shutdown, s.event_loop )
+  end
+
+  def tp( t )
+    Time.parse( t )
+  end
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: iyyov
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: java
+authors: 
+  - David Kellum
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-07 00:00:00 -08:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rjack-sfl4j
+    type: :runtime
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.5.11
+      version: 
+  - !ruby/object:Gem::Dependency 
+    name: rjack-logback
+    type: :runtime
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 0.9.18
+      version: 
+  - !ruby/object:Gem::Dependency 
+    name: logrotate
+    type: :runtime
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            version: 1.2.1
+      version: 
+  - !ruby/object:Gem::Dependency 
+    name: minitest
+    type: :development
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.5.0
+      version: 
+  - !ruby/object:Gem::Dependency 
+    name: hashdot-test-daemon
+    type: :development
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 1.0.0
+      version: 
+  - !ruby/object:Gem::Dependency 
+    name: rjack-tarpit
+    type: :development
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !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).
+email: 
+  - dek-oss@gravitext.com
+executables: 
+  - iyyov-fg
+extensions: []
+
+extra_rdoc_files: 
+  - Manifest.txt
+  - README.rdoc
+  - History.rdoc
+files: 
+  - Manifest.txt
+  - History.rdoc
+  - README.rdoc
+  - Rakefile
+  - bin/iyyov-fg
+  - init/iyyov-daemon
+  - lib/iyyov/base.rb
+  - lib/iyyov.rb
+  - lib/iyyov/context.rb
+  - lib/iyyov/daemon.rb
+  - lib/iyyov/errors.rb
+  - lib/iyyov/log_rotator.rb
+  - lib/iyyov/scheduler.rb
+  - lib/iyyov/shutdown_handler.rb
+  - lib/iyyov/task.rb
+  - test/setup.rb
+  - test/test_daemon.rb
+  - test/test_scheduler.rb
+has_rdoc: true
+homepage: http://github.com/dekellum/iyyov
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --main
+  - README.rdoc
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: iyyov
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Down-to-earth job control and monitoring
+test_files: 
+  - test/test_scheduler.rb
+  - test/test_daemon.rb