task_manager 0.0.2 → 0.0.4

data/.rvmrc

@@ -1,2 +1,2 @@
-rvm use ruby-1.8.7-p334
+rvm use ruby-1.8.7-p352
 rvm gemset use 'task_manager'

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+bundler_args: --without maintenance
+rvm:
+  - 1.8.7
+  - jruby-18mode
+  - ree

data/Gemfile

@@ -2,6 +2,9 @@ source "http://rubygems.org"
 
 gemspec
 
-group :development do
+group :maintenance do
   gem 'gem-release'
+  gem 'watchr'
+  # gem 'ruby-fsevent'
+  gem 'ruby-debug'
 end

data/Rakefile

@@ -1,2 +1,11 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+# require 'bundler'
+# Bundler::GemHelper.install_tasks
+
+task :test do
+  $:.push(File.expand_path('../lib/', __FILE__))
+  $:.push(File.expand_path('../test/', __FILE__))
+
+  require './test/all'
+end
+
+task :default => :test

data/TODO

@@ -1,4 +1,2 @@
 add a generator for rails
-add better test-coverage
-add basic documentation
-add examples
+add example to README

data/bin/task_manager.rb

@@ -1,77 +1,19 @@
 #!/usr/bin/env ruby
 # vim:ft=ruby:fileencoding=utf8
 
-# read environment variables or use default values
-# RAILS_ENV=${RAILS_ENV:-"staging"}
-# RUBY_BIN=${RUBY_BIN:-"ruby"}
-# BASEPATH=${BASEPATH:-"/home/application/projects/rails/$RAILS_ENV/current"}
-rails_env = Rails.env
-ruby_bin  = 'ruby'
-base_path = Rails.root
+require 'daemons'
+require 'pathname'
 
+base_path = Pathname.new('.').expand_path
 
-# variables that should only be changed if you REALLY know what you're doing
-# e.g. the log-filename is hardcoded in the scheduling-script
-# LOG="$BASEPATH/log/$RAILS_ENV.scheduler.log"
-# SCHEDULER_FILENAME='tasks.rb'
-# SCHEDULER="$BASEPATH/config/$SCHEDULER_FILENAME"
-log = base_path.join('log').join("#{rails_env}.scheduler.log")
-scheduler_fn = 'tasks.rb'
-scheduler = basepath.join('config').join(scheduler_fn)
+Daemons.run(base_path.join('config/scheduler.rb'), {
+  :app_name => "#{ENV['RAILS_ENV']}.scheduler",
+  :dir_mode => :normal,
+  :dir => base_path.join('tmp/pids'),
+  :mutliple => false,
+  :monitor => true,
+  :log_dir => base_path.join('log'),
+  :log_output => true,
+  :keep_pid_files => false
+})
 
-# PID=`ps aux | grep -v 'grep' | egrep "$RAILS_ENV.*$SCHEDULER_FILENAME" | head -n1 | sed 's/^!gw*\W\+\(\w\+\).*$/\1/'`
-pid = `ps aux | grep -v 'grep' | egrep "$RAILS_ENV.*$SCHEDULER_FILENAME" | head -n1 | sed 's/^\w*\W\+\(\w\+\).*$/\1/'`
-
-# # start scheduler in the background
-# function start_scheduler() {
-#   if [ -z "$PID" ]; then
-#     $RUBY_BIN $SCHEDULER >>$LOG 2>&1 &
-#     disown -a -h
-#   fi
-# }
-#
-# # kill the scheduler if it's running
-# function kill_scheduler() {
-#   if [ -n "$PID" ]; then
-#     kill $PID
-#   fi;
-# }
-#
-# # actual "init.d"-like interface
-# case "$1" in
-#   start)
-#     start_scheduler
-#     ;;
-#   stop)
-#     kill_scheduler
-#     ;;
-#   restart)
-#     kill_scheduler
-#     start_scheduler
-#     ;;
-#   status)
-#     if [ -n "$PID" ]; then
-#       echo "Scheduling is active ($PID)"
-#     else
-#       echo "Scheduling is inactive"
-#     fi
-#     ;;
-#   pid)
-#     echo $PID
-#     ;;
-#   *)
-#     echo "Usage: $0 {start|stop|restart|status|pid}"
-#     echo ""
-#     echo "recognized environment variables with default in parentheses:"
-#     echo ""
-#     echo "  variables which should be given"
-#     echo "    BASEPATH  ($BASEPATH)"
-#     echo "    RAILS_ENV ($RAILS_ENV)"
-#     echo ""
-#     echo "  variables which can be given for optimization reasons"
-#     echo "    RUBY_BIN  ($RUBY_BIN)"
-#     ;;
-# esac
-#
-# # for the lack of a better return value, exit successfully
-# exit 0

data/lib/task_manager/version.rb

@@ -1,7 +1,7 @@
 # vim:ft=ruby:fileencoding=utf-8
 
-module TaskManager
-  VERSION = "0.0.2"
+class TaskManager
+  VERSION = "0.0.4"
   DATE = File.mtime(__FILE__)
   SUMMARY = 'A simple wrapper around the Rufus::Scheduler to have a more configurable setup.'
   DESCRIPTION = <<-EOT

data/lib/task_manager.rb

@@ -1,17 +1,25 @@
+# vim:fileencoding=utf8
+
 # needs rufus-scheduler
 require 'rufus/scheduler'
 require 'pathname'
 
 class TaskManager
   attr_accessor :jobs
-  attr_reader :env, :path
+  attr_reader :env, :path, :config
 
-  # create the necessary scheduler/job-storages and store a basepath and a environment
+  # create the necessary scheduler/job-stores and store a basepath and a
+  # environment
+  #
+  # STDOUT is set to sync=true so that the log is not held back by some
+  # output-buffering
   def initialize(env = 'staging', path = '.')
     @path = Pathname.new(path)
     @env = env.to_sym
     @jobs = {}
     @schedulers = {}
+
+    $stdout.sync = true
   end
 
   # return a named scheduler
@@ -19,9 +27,20 @@ class TaskManager
     @schedulers[key] ||= Rufus::Scheduler.start_new
   end
 
+  # create a new job with a separate scheduler
+  def schedule(key)
+    raise ArgumentError unless block_given?
+    jobs[key] = yield scheduler(key)
+  end
+
+  # check wether a job is scheduled
+  def scheduled?(key)
+    !jobs[key].nil?
+  end
+
   # prevent RubyVM from quitting
   def persist
-    say "Scheduler wird persistiert, alle Definitionen sollten geladen sein."
+    say "Scheduler will be persisted now, all definitions should be loaded now."
     scheduler(:internal).join
   end
 
@@ -36,15 +55,40 @@ class TaskManager
   def execute_task(cmd_string)
     shortened_cmd = cmd_string.gsub(/--trace/, '').strip
     say   "starting #{shortened_cmd}"
-    if system("cd #{path}; RAILS_ENV=#{env} #{cmd_string} >>#{path}/log/#{env}.scheduler.task_output.log 2>>#{path}/log/#{env}.scheduler.log")
+    if system(full_command_string(cmd_string))
       say "finished #{shortened_cmd}"
     else
       say "ERROR in #{shortened_cmd}"
     end
   end
 
+  # overwritable command_string which will be executed in the system
+  def full_command_string(cmd_string)
+    "cd #{path}; RAILS_ENV=#{env} #{cmd_string} >>#{path}/log/#{env}.scheduler.task_output.log 2>>#{path}/log/#{env}.scheduler.log"
+  end
+
   # output a message with Time
   def say(msg)
-    puts "#{Time.now} - #{msg}"
+    $stdout.puts "#{Time.now} - #{msg}"
+  end
+
+  # store configuration from a hash
+  def config= hash
+    @config = {}
+
+    hash.keys.map do |key|
+      @config[key.to_sym] = hash[key].map do |r|
+        r.values.first
+      end
+    end
+
+    config
+  end
+
+  # apply configuration
+  def apply_configuration
+    config.each do |method, args|
+      send(method, *args)
+    end
   end
 end

data/task_manager.gemspec

@@ -25,7 +25,10 @@ Gem::Specification.new do |s|
   # s.post_install_message = TaskManager::RELEASE_NOTES
 
   s.add_dependency 'rufus-scheduler', '~> 2.0.6'
+  s.add_dependency 'daemons', '~> 1.1.3'
 
   # for tests, needed
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'more_unit_test'
+  s.add_development_dependency 'mocha'
 end

data/test/fixtures/config.yml

@@ -0,0 +1,12 @@
+cnet_import:
+  - cron: '30 0 * * *'
+  - confirm: false
+navision_import:
+  - every: '3h'
+  - stop_hour: 18
+  - stop_minute: 0
+restart_jobs:
+  - cron: '* 6 * * *'
+  - restart:
+     - navision_import
+

data/test/task_manager_test.rb

@@ -1,10 +1,11 @@
-require File.expand_path('../test_helper', __FILE__)
+require 'test_helper'
 
 class TaskManagerTest < Test::Unit::TestCase
   # remember to clean up after each test-run
   def teardown
     # @sut.unschedule(:internal)
     @sut = nil
+    @custom_tm = nil
   end
 
   # lets start by trying to create a taskmanager
@@ -35,7 +36,164 @@ class TaskManagerTest < Test::Unit::TestCase
 
   def test_taskmanager_can_output_messages
     assert_stdout_block MatchableString.new('testing') do
-      TaskManager.new.say('testing')
+      tm.say('testing')
     end
   end
+
+  # we will be configuring the taskmanager with a hash, so lets define one
+  # this configuration would expect the necessary methods on a subclass of the TaskManager
+  def configuration
+    {
+      "restart_jobs"=>[
+        {"cron"=>"* 6 * * *"},
+        {"restart"=>["navision_import"]}
+      ],
+      "navision_import"=>[
+        {"every"=>"3h"},
+        {"stop_hour"=>18},
+        {"stop_minute"=>0}
+      ],
+      "cnet_import"=>[
+        {"cron"=>"30 0 * * *"},
+        {"confirm"=>false}
+      ]
+    }
+  end
+
+  def test_taskmanager_can_be_configured_with_hash
+    assert_respond_to tm, :'config='
+    assert_respond_to tm, :config
+
+    tm.config = configuration
+
+    expected = {
+      :restart_jobs=>["* 6 * * *", ["navision_import"]],
+      :navision_import=>["3h", 18, 0],
+      :cnet_import=>["30 0 * * *", false]
+    }
+
+    assert_equal expected, tm.config
+  end
+
+  def test_taskmanager_can_apply_the_configration
+    tm.expects(:restart_jobs).with('* 6 * * *', ["navision_import"])
+    tm.expects(:navision_import).with('3h', 18, 0)
+    tm.expects(:cnet_import).with('30 0 * * *', false)
+
+    tm.config = configuration
+
+    assert_respond_to tm, :apply_configuration
+
+    tm.apply_configuration
+  end
+
+  # lets create a TaskManager so we can test a little more
+  class CustomTaskManager < TaskManager
+    def navision_import(frequency, end_hr, end_min = 0)
+      schedule(:navision_import) do |scheduler|
+        scheduler.every(frequency, :blocking => true) do
+          (Time.now.hour >= end_hr && Time.now.min >= end_min) ?
+            unschedule(:navision_import) :
+            execute_task('echo "importing from navision"')
+        end
+      end
+    end
+
+    def cnet_import(cron_def, param)
+      schedule(:cnet_import) do |scheduler|
+        scheduler.cron(cron_def) do
+          arg = param ? "production" : "test"
+          execute_task(%(echo "importing from cnet server #{arg}" ))
+        end
+      end
+    end
+
+    def restart_jobs(cron_def, tasks)
+      schedule(:restart_jobs) do |scheduler|
+        scheduler.cron(cron_def) do
+          tasks.each do |task|
+            send(task, *config[task]) unless scheduled?(task)
+          end
+        end
+      end
+    end
+  end
+
+  # verify that the building blocks are there
+  def test_taskmanager_has_a_schedule_method
+    assert_respond_to tm, :schedule
+    assert_equal 1, tm.method(:schedule).arity
+
+    assert_raise ArgumentError do
+      tm.schedule(:blah)
+    end
+
+    assert_nothing_raised do
+      tm.schedule(:blah) do |scheduler|
+        # the scheduler should be returned again
+        scheduler
+      end
+    end
+  end
+
+  def test_schedule_method_stores_the_job
+    prev_size = tm.jobs.size
+
+    tm.schedule(:blah) do |scheduler|
+      # the scheduler should be returned again
+      scheduler
+    end
+
+    assert_equal (prev_size + 1), tm.jobs.size
+    assert_not_nil tm.jobs[:blah], tm.jobs.inspect
+  end
+
+  def test_taskmanager_knows_what_is_scheduled
+    assert_respond_to tm, :'scheduled?'
+    assert !tm.scheduled?(:undefined)
+
+    tm.schedule(:defined) do |s|
+      s
+    end
+
+    assert tm.scheduled?(:defined)
+  end
+
+  # as we know that we have everyhing we need in the CustomTaskManager, lets test this one
+  def custom_tm
+    @custom_tm ||= CustomTaskManager.new
+  end
+
+  def test_custom_taskmanager_can_take_configuration
+    assert_nothing_raised Exception do
+      custom_tm.config = configuration
+      custom_tm.apply_configuration
+      assert_equal 3, custom_tm.jobs.size
+    end
+  end
+
+  # on more thing we can tweak from our subclass is the actual command we execute
+  def test_taskmanager_calls_method_to_construct_system_call
+    cmd = %(echo "importing from navision")
+    # I deliberatly redirect the result to /dev/null here because I don't test
+    # that the command is right it should just be executed. The next test shows
+    # what the full command string really looks like.
+    full_cmd = %(cd .; RAILS_ENV=staging echo "importing from navision" > /dev/null)
+
+    custom_tm.expects(:full_command_string).with(cmd).returns(full_cmd)
+
+    assert_stdout_block MatchableString.new(cmd) do
+      custom_tm.execute_task(cmd)
+    end
+  end
+
+  # somewhat more in depth, it works like this
+  def test_taskmanager_can_construct_a_full_command_string
+    assert_respond_to tm, :full_command_string
+    assert_equal 1, tm.method(:full_command_string).arity
+
+    expected = %(cd .; RAILS_ENV=staging echo "test" >>./log/staging.scheduler.task_output.log 2>>./log/staging.scheduler.log)
+
+    assert_equal expected, tm.full_command_string('echo "test"')
+  end
 end

data/test/test_helper.rb

@@ -2,7 +2,20 @@ require 'rubygems'
 
 require 'more_unit_test/assert_stdout'
 require 'test/unit'
+require 'mocha'
 
-$:.push(File.expand_path('../../lib/', __FILE__))
+class Test::Unit::Catch_IO
+  def sync=(value)
+    value
+  end
+
+  def puts(string)
+    write("#{string}\n")
+  end
+
+  def print(string)
+    write(string)
+  end
+end
 
 require 'task_manager'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: task_manager
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Mattthias Viehweger
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-24 00:00:00 +02:00
-default_executable: 
+date: 2012-03-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rufus-scheduler
@@ -35,9 +34,25 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: more_unit_test
+  name: daemons
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 1
+        - 3
+        version: 1.1.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -47,7 +62,35 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: more_unit_test
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: "    A simple wrapper around the Rufus::Scheduler to have a more configurable setup.\n\n    The Task to be scheduled should be defined in a subclass.\n"
 email: 
 - kronn@kronn.de
@@ -60,6 +103,7 @@ extra_rdoc_files: []
 
 files: 
 - .rvmrc
+- .travis.yml
 - Gemfile
 - README
 - Rakefile
@@ -71,9 +115,9 @@ files:
 - lib/task_manager/version.rb
 - task_manager.gemspec
 - test/all.rb
+- test/fixtures/config.yml
 - test/task_manager_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/kronn/task_manager
 licenses: []
 
@@ -103,11 +147,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: task_manager
-rubygems_version: 1.3.7
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: A simple wrapper around the Rufus::Scheduler to have a more configurable setup.
-test_files: 
-- test/all.rb
-- test/task_manager_test.rb
-- test/test_helper.rb
+test_files: []
+