resque-mongo-scheduler 2.0.2

data/test/scheduler_args_test.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+context "scheduling jobs with arguments" do
+  setup { Resque::Scheduler.clear_schedule! }
+
+  test "calls the worker without arguments when 'args' is missing from the config" do
+    Resque::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      class: SomeIvarJob
+    YAML
+    SomeIvarJob.expects(:perform).once.with()
+    Resque.reserve('ivar').perform
+  end
+
+  test "calls the worker without arguments when 'args' is blank in the config" do
+    Resque::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      class: SomeIvarJob
+      args: 
+    YAML
+    SomeIvarJob.expects(:perform).once.with()
+    Resque.reserve('ivar').perform
+  end
+
+  test "calls the worker with a string when the config lists a string" do
+    Resque::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      class: SomeIvarJob
+      args: string
+    YAML
+    SomeIvarJob.expects(:perform).once.with('string')
+    Resque.reserve('ivar').perform
+  end
+
+  test "calls the worker with a Fixnum when the config lists an integer" do
+    Resque::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      class: SomeIvarJob
+      args: 1
+    YAML
+    SomeIvarJob.expects(:perform).once.with(1)
+    Resque.reserve('ivar').perform
+  end
+
+  test "calls the worker with multiple arguments when the config lists an array" do
+    Resque::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      class: SomeIvarJob
+      args:
+        - 1
+        - 2
+    YAML
+    SomeIvarJob.expects(:perform).once.with(1, 2)
+    Resque.reserve('ivar').perform
+  end
+
+  test "calls the worker with an array when the config lists a nested array" do
+    Resque::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      class: SomeIvarJob
+      args:
+        - - 1
+          - 2
+    YAML
+    SomeIvarJob.expects(:perform).once.with([1, 2])
+    Resque.reserve('ivar').perform
+  end
+
+  test "calls the worker with a hash when the config lists a hash" do
+    Resque::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      class: SomeIvarJob
+      args:
+        key: value
+    YAML
+    SomeIvarJob.expects(:perform).once.with('key' => 'value')
+    Resque.reserve('ivar').perform
+  end
+
+  test "calls the worker with a nested hash when the config lists a nested hash" do
+    Resque::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      class: SomeIvarJob
+      args:
+        first_key:
+          second_key: value
+    YAML
+    SomeIvarJob.expects(:perform).once.with('first_key' => {'second_key' => 'value'})
+    Resque.reserve('ivar').perform
+  end
+end

data/test/scheduler_test.rb

@@ -0,0 +1,241 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Resque::SchedulerTest < Test::Unit::TestCase
+
+  class FakeJob
+    def self.scheduled(queue, klass, *args); end
+  end
+
+  def setup
+    Resque::Scheduler.dynamic = false
+    Resque.flushall
+    Resque::Scheduler.mute = true
+    Resque::Scheduler.clear_schedule!
+    Resque::Scheduler.send(:class_variable_set, :@@scheduled_jobs, {})
+  end
+
+  def test_enqueue_from_config_puts_stuff_in_the_resque_queue_without_class_loaded
+    Resque::Job.stubs(:create).once.returns(true).with('joes_queue', 'BigJoesJob', '/tmp')
+    Resque::Scheduler.enqueue_from_config('cron' => "* * * * *", 'class' => 'BigJoesJob', 'args' => "/tmp", 'queue' => 'joes_queue')
+  end
+
+  def test_enqueue_from_config_with_every_syntax
+    Resque::Job.stubs(:create).once.returns(true).with('james_queue', 'JamesJob', '/tmp')
+    Resque::Scheduler.enqueue_from_config('every' => '1m', 'class' => 'JamesJob', 'args' => '/tmp', 'queue' => 'james_queue')
+  end
+
+  def test_enqueue_from_config_puts_stuff_in_the_resque_queue
+    Resque::Job.stubs(:create).once.returns(true).with(:ivar, 'SomeIvarJob', '/tmp')
+    Resque::Scheduler.enqueue_from_config('cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp")
+  end
+  
+  def test_enqueue_from_config_with_custom_class_job_in_the_resque_queue
+    FakeJob.stubs(:scheduled).once.returns(true).with(:ivar, 'SomeIvarJob', '/tmp')
+    Resque::Scheduler.enqueue_from_config('cron' => "* * * * *", 'class' => 'SomeIvarJob', 'custom_job_class' => 'Resque::SchedulerTest::FakeJob', 'args' => "/tmp")
+  end
+
+  def test_enqueue_from_config_puts_stuff_in_the_resque_queue_when_env_match
+    # The job should be loaded : its rails_env config matches the RAILS_ENV variable:
+    ENV['RAILS_ENV'] = 'production'
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'production'}}
+    Resque::Scheduler.load_schedule!
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+
+    # we allow multiple rails_env definition, it should work also:
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'staging, production'}}
+    Resque::Scheduler.load_schedule!
+    assert_equal(2, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+  end
+
+  def test_enqueue_from_config_dont_puts_stuff_in_the_resque_queue_when_env_doesnt_match
+    # RAILS_ENV is not set:
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'staging'}}
+    Resque::Scheduler.load_schedule!
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+
+    # SET RAILS_ENV to a common value:
+    ENV['RAILS_ENV'] = 'production'
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'staging'}}
+    Resque::Scheduler.load_schedule!
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+  end
+
+  def test_enqueue_from_config_when_rails_env_arg_is_not_set
+    # The job should be loaded, since a missing rails_env means ALL envs.
+    ENV['RAILS_ENV'] = 'production'
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"}}
+    Resque::Scheduler.load_schedule!
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+  end
+
+  def test_config_makes_it_into_the_rufus_scheduler
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"}}
+    Resque::Scheduler.load_schedule!
+
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert Resque::Scheduler.scheduled_jobs.include?(:some_ivar_job)
+  end
+  
+  def test_can_reload_schedule
+    Resque::Scheduler.dynamic = true
+    Resque.schedule = {"some_ivar_job" => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"}}
+  
+    Resque::Scheduler.load_schedule!
+  
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert Resque::Scheduler.scheduled_jobs.include?("some_ivar_job")
+    
+    Resque.schedules.remove
+    Resque.schedules.insert('_id' => "some_ivar_job2", 'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/2")
+    
+    Resque::Scheduler.reload_schedule!
+    
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    
+    assert_equal '/tmp/2', Resque.schedule["some_ivar_job2"]["args"]
+    assert Resque::Scheduler.scheduled_jobs.include?("some_ivar_job2")
+  end
+  
+  def test_load_schedule_job
+    Resque::Scheduler.load_schedule_job("some_ivar_job", {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"})
+    
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(1, Resque::Scheduler.scheduled_jobs.size)
+    assert Resque::Scheduler.scheduled_jobs.keys.include?("some_ivar_job")
+  end
+  
+  def test_load_schedule_job_with_no_cron
+    Resque::Scheduler.load_schedule_job("some_ivar_job", {'class' => 'SomeIvarJob', 'args' => "/tmp"})
+    
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Resque::Scheduler.scheduled_jobs.size)
+    assert !Resque::Scheduler.scheduled_jobs.keys.include?("some_ivar_job")
+  end
+  
+  def test_load_schedule_job_with_blank_cron
+    Resque::Scheduler.load_schedule_job("some_ivar_job", {'cron' => '', 'class' => 'SomeIvarJob', 'args' => "/tmp"})
+    
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Resque::Scheduler.scheduled_jobs.size)
+    assert !Resque::Scheduler.scheduled_jobs.keys.include?("some_ivar_job")
+  end
+  
+  def test_update_schedule
+    Resque::Scheduler.dynamic = true
+    Resque.schedule = {
+      "some_ivar_job"    => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"},
+      "another_ivar_job" => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/5"},
+      "stay_put_job"     => {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp"}
+    }
+    
+    Resque::Scheduler.load_schedule!
+    assert_equal 0, Resque.schedules_changed.count
+    
+    Resque.set_schedule("some_ivar_job",
+      {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/2"}
+    )
+    Resque.set_schedule("new_ivar_job",
+      {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp/3"}
+    )
+    Resque.set_schedule("stay_put_job",
+      {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp"}
+    )
+    Resque.remove_schedule("another_ivar_job")
+    
+    Resque::Scheduler.update_schedule
+    
+    assert_equal(3, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(3, Resque::Scheduler.scheduled_jobs.size)
+    %w(some_ivar_job new_ivar_job stay_put_job).each do |job_name|
+      assert Resque::Scheduler.scheduled_jobs.keys.include?(job_name)
+      assert Resque.schedule.keys.include?(job_name)
+    end
+    assert !Resque::Scheduler.scheduled_jobs.keys.include?("another_ivar_job")
+    assert !Resque.schedule.keys.include?("another_ivar_job")
+    assert_equal 0, Resque.schedules_changed.count
+  end
+  
+  def test_update_schedule_with_mocks
+    Resque::Scheduler.dynamic = true
+    Resque.schedule = {
+      "some_ivar_job" => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"},
+      "another_ivar_job"  => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/5"},
+      "stay_put_job"  => {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp"}
+    }
+    
+    Resque::Scheduler.load_schedule!
+    
+    Resque::Scheduler.rufus_scheduler.expects(:unschedule).with(Resque::Scheduler.scheduled_jobs["some_ivar_job"].job_id)
+    Resque::Scheduler.rufus_scheduler.expects(:unschedule).with(Resque::Scheduler.scheduled_jobs["another_ivar_job"].job_id)
+    
+    Resque.set_schedule("some_ivar_job",
+      {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/2"}
+    )
+    Resque.set_schedule("new_ivar_job",
+      {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp/3"}
+    )
+    Resque.set_schedule("stay_put_job",
+      {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp"}
+    )
+    Resque.remove_schedule("another_ivar_job")
+    
+    Resque::Scheduler.update_schedule
+    
+    assert_equal(3, Resque::Scheduler.scheduled_jobs.size)
+    %w(some_ivar_job new_ivar_job stay_put_job).each do |job_name|
+      assert Resque::Scheduler.scheduled_jobs.keys.include?(job_name)
+      assert Resque.schedule.keys.include?(job_name)
+    end
+    assert !Resque::Scheduler.scheduled_jobs.keys.include?("another_ivar_job")
+    assert !Resque.schedule.keys.include?("another_ivar_job")
+    assert_equal 0, Resque.schedules_changed.count
+  end
+  
+  def test_set_schedules
+    Resque::Scheduler.dynamic = true
+    Resque.schedule = {"some_ivar_job" => {
+      'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/75"
+    }}
+    assert_equal({'_id' => "some_ivar_job", 'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/75"}, 
+      Resque.schedules.find_one('_id' => "some_ivar_job"))
+  end
+  
+  def test_set_schedule
+    assert_equal 0, Resque.schedules_changed.find('_id' => "some_ivar_job").count
+    Resque.set_schedule("some_ivar_job", {
+      'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/22"
+    })
+    assert_equal({'_id' => "some_ivar_job", 'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/22"}, 
+      Resque.schedules.find_one('_id' => "some_ivar_job"))
+    assert_equal 1, Resque.schedules_changed.find('_id' => "some_ivar_job").count
+  end
+  
+  def test_get_schedule
+    schedule = {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/33"}
+    Resque.schedules.insert(schedule.merge('_id' => "some_ivar_job2"))
+    assert_equal(schedule, 
+      Resque.get_schedule("some_ivar_job2"))
+  end
+  
+  def test_remove_schedule
+    assert_equal 0, Resque.schedules_changed.find('_id' => "some_ivar_job3").count
+    Resque.schedules.insert('_id' => "some_ivar_job3", 'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/44")
+    Resque.remove_schedule("some_ivar_job3")
+    assert_equal nil, Resque.schedules.find_one('_id' => "some_ivar_job3")
+    assert_equal 1, Resque.schedules_changed.find('_id' => "some_ivar_job3").count
+  end
+  
+  def test_adheres_to_lint
+    assert_nothing_raised do
+      Resque::Plugin.lint(Resque::Scheduler)
+      Resque::Plugin.lint(ResqueScheduler)
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,92 @@
+
+# Pretty much copied this file from the resque-mongo test_helper since we want
+# to do all the same stuff
+
+dir = File.dirname(File.expand_path(__FILE__))
+
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+gem 'resque-mongo'
+require 'resque'
+require File.join(dir, '../lib/resque_scheduler')
+$LOAD_PATH.unshift File.dirname(File.expand_path(__FILE__)) + '/../lib'
+
+
+#
+# make sure we can run redis
+#
+
+# if !system("which redis-server")
+#   puts '', "** can't find `redis-server` in your path"
+#   puts "** try running `sudo rake install`"
+#   abort ''
+# end
+
+
+#
+# start our own redis when the tests start,
+# kill it when they end
+#
+
+# at_exit do
+#   next if $!
+# 
+#   if defined?(MiniTest)
+#     exit_code = MiniTest::Unit.new.run(ARGV)
+#   else
+#     exit_code = Test::Unit::AutoRunner.run
+#   end
+# 
+#   pid = `ps -e -o pid,command | grep [r]edis-test`.split(" ")[0]
+#   puts "Killing test redis server..."
+#   `rm -f #{dir}/dump.rdb`
+#   Process.kill("KILL", pid.to_i)
+#   exit exit_code
+# end
+
+Resque.mongo = 'localhost:27017'
+
+module Resque
+  # Drop all collections in the 'monque' database.
+  # Note: do not drop the database directly, as mongod allocates disk space
+  # each time it's re-created.
+  def flushall
+    for name in @db.collection_names
+      begin
+        @db.drop_collection(name)
+      rescue Mongo::OperationFailure
+        # "can't drop system ns"
+      end
+    end
+  end
+end
+
+##
+# test/spec/mini 3
+# http://gist.github.com/25455
+# chris@ozmm.org
+#
+def context(*args, &block)
+  return super unless (name = args.first) && block
+  require 'test/unit'
+  klass = Class.new(defined?(ActiveSupport::TestCase) ? ActiveSupport::TestCase : Test::Unit::TestCase) do
+    def self.test(name, &block)
+      define_method("test_#{name.gsub(/\W/,'_')}", &block) if block
+    end 
+    def self.xtest(*args) end 
+    def self.setup(&block) define_method(:setup, &block) end 
+    def self.teardown(&block) define_method(:teardown, &block) end 
+  end 
+  (class << klass; self end).send(:define_method, :name) { name.gsub(/\W/,'_') }
+  klass.class_eval &block
+end
+
+class SomeJob
+  def self.perform(repo_id, path)
+  end
+end
+
+class SomeIvarJob < SomeJob
+  @queue = :ivar
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: resque-mongo-scheduler
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 2.0.2
+platform: ruby
+authors: 
+- Ben VandenBos
+- "Nicolas Fouch\xC3\xA9"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: resque-mongo
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.11.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rufus-scheduler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: |-
+  Light weight job scheduling on top of Resque Mongo.
+      Adds methods enqueue_at/enqueue_in to schedule jobs in the future.
+      Also supports queueing jobs on a fixed, cron-like schedule.
+email: 
+- bvandenbos@gmail.com
+- nicolas@silentale.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- HISTORY.md
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/resque/scheduler.rb
+- lib/resque_scheduler.rb
+- lib/resque_scheduler/search_delayed.rb
+- lib/resque_scheduler/server.rb
+- lib/resque_scheduler/server/views/delayed.erb
+- lib/resque_scheduler/server/views/delayed_timestamp.erb
+- lib/resque_scheduler/server/views/scheduler.erb
+- lib/resque_scheduler/tasks.rb
+- lib/resque_scheduler/version.rb
+- resque-mongo-scheduler.gemspec
+- tasks/resque_scheduler.rake
+- test/delayed_queue_test.rb
+- test/redis-test.conf
+- test/resque-web_test.rb
+- test/scheduler_args_test.rb
+- test/scheduler_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/nfo/resque-mongo-scheduler
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Light weight job scheduling on top of Resque Mongo
+test_files: []
+