qu-scheduler 0.0.1 → 0.1.0

data/test/redis-test.conf

@@ -0,0 +1,115 @@
+# Redis configuration file example
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize yes
+
+# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile ./test/redis-test.pid
+
+# Accept connections on the specified port, default is 6379
+port 9736
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+save 900 1
+save 300 10
+save 60 10000
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./test/
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also 'stdout' can be used to force
+# the demon to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile stdout
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+
+# slaveof <masterip> <masterport>
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+
+# requirepass foobared
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limts.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+
+# maxmemory <bytes>
+
+############################### ADVANCED CONFIG ###############################
+
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+glueoutputbuf yes

data/test/scheduler_args_test.rb

@@ -0,0 +1,156 @@
+require 'test_helper'
+
+context "scheduling jobs with arguments" do
+  def run_job_for_queue(*queues)
+    worker = Qu::Worker.new(*queues)
+    Qu.backend.register_worker(worker)
+    worker.work
+    Qu.backend.unregister_worker(worker)
+  end
+
+  setup do
+    Qu::Scheduler.clear_schedule!
+    Qu::Scheduler.dynamic = false
+  end
+
+  test "enqueue_from_config with_every_syntax" do
+    Qu.backend.stubs(:enqueue).once.returns(true).with(all_of(instance_of(Qu::Payload), responds_with(:klass, SomeIvarJob), responds_with(:args, '/tmp'), responds_with(:every, '1m')))
+    Qu::Scheduler.enqueue_from_config('every' => '1m', 'klass' => 'SomeIvarJob', 'args' => '/tmp', 'queue' => 'james_queue')
+  end
+
+  test "enqueue_from_config puts jobs in the resque queue" do
+    Qu.backend.stubs(:enqueue).once.returns(true).with(all_of(instance_of(Qu::Payload), responds_with(:klass, SomeIvarJob), responds_with(:args, '/tmp'), responds_with(:queue, 'ivar')))
+    Qu::Scheduler.enqueue_from_config('cron' => "* * * * *", 'klass' => 'SomeIvarJob', 'args' => "/tmp")
+  end
+
+  test "enqueue_from_config with custom_class_job in resque" do
+    FakeCustomJobClass.stubs(:scheduled).once.returns(true).with('ivar', 'FakeCustomJobClass', '/tmp')
+    Qu::Scheduler.enqueue_from_config('cron' => "* * * * *", 'klass' => 'SomeIvarJob', 'custom_job_class' => 'FakeCustomJobClass', 'args' => "/tmp")
+  end
+
+  test "enqueue_from_config puts stuff in resquewhen rails_env matches" do
+    # The job should be loaded : its rails_env config matches the RAILS_ENV variable:
+    ENV['RAILS_ENV'] = 'production'
+    assert_equal(0, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+
+    Qu.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'production'}}
+    Qu::Scheduler.load_schedule!
+    assert_equal(1, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+
+    # we allow multiple rails_env definition, it should work also:
+    Qu.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'staging, production'}}
+    Qu::Scheduler.load_schedule!
+    assert_equal(2, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+  end
+
+  test "enqueue_from_config  doesnt put stuff in resque when rails_env doesnt match" do
+    # RAILS_ENV is not set:
+    assert_equal(0, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+    Qu.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'staging'}}
+    Qu::Scheduler.load_schedule!
+    assert_equal(0, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+
+    # SET RAILS_ENV to a common value:
+    ENV['RAILS_ENV'] = 'production'
+    Qu.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'staging'}}
+    Qu::Scheduler.load_schedule!
+    assert_equal(0, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+  end
+
+  test "enqueue_from_config when rails env arg is not set" do
+    # The job should be loaded, since a missing rails_env means ALL envs.
+    ENV['RAILS_ENV'] = 'production'
+    assert_equal(0, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+    Qu.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"}}
+    Qu::Scheduler.load_schedule!
+    assert_equal(1, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+  end
+
+  test "calls the worker without arguments when 'args' is missing from the config" do
+    Qu::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      klass: SomeIvarJob
+    YAML
+    SomeIvarJob.expects(:perform).once.with()
+    run_job_for_queue('ivar')
+  end
+
+  test "calls the worker without arguments when 'args' is blank in the config" do
+    Qu::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      klass: SomeIvarJob
+      args:
+    YAML
+    SomeIvarJob.expects(:perform).once.with()
+    run_job_for_queue('ivar')
+  end
+
+  test "calls the worker with a string when the config lists a string" do
+    Qu::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      klass: SomeIvarJob
+      args: string
+    YAML
+    SomeIvarJob.expects(:perform).once.with('string')
+    run_job_for_queue('ivar')
+  end
+
+  test "calls the worker with a Fixnum when the config lists an integer" do
+    Qu::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      klass: SomeIvarJob
+      args: 1
+    YAML
+    SomeIvarJob.expects(:perform).once.with(1)
+    run_job_for_queue('ivar')
+  end
+
+  test "calls the worker with multiple arguments when the config lists an array" do
+    Qu::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      klass: SomeIvarJob
+      args:
+        - 1
+        - 2
+    YAML
+    SomeIvarJob.expects(:perform).once.with(1, 2)
+    run_job_for_queue('ivar')
+  end
+
+  test "calls the worker with an array when the config lists a nested array" do
+    Qu::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      klass: SomeIvarJob
+      args:
+        - - 1
+          - 2
+    YAML
+    SomeIvarJob.expects(:perform).once.with([1, 2])
+    run_job_for_queue('ivar')
+  end
+
+  test "calls the worker with a hash when the config lists a hash" do
+    Qu::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      klass: SomeIvarJob
+      args:
+        key: value
+    YAML
+    SomeIvarJob.expects(:perform).once.with(['key', 'value'])
+    run_job_for_queue('ivar')
+  end
+
+  test "calls the worker with a nested hash when the config lists a nested hash" do
+    Qu::Scheduler.enqueue_from_config(YAML.load(<<-YAML))
+      klass: SomeIvarJob
+      args:
+        first_key:
+          second_key: value
+    YAML
+    SomeIvarJob.expects(:perform).once.with(['first_key', {'second_key' => 'value'}])
+    run_job_for_queue('ivar')
+  end
+
+  test "poll_sleep_amount defaults to 5" do
+    assert_equal 5, Qu::Scheduler.poll_sleep_amount
+  end
+
+  test "poll_sleep_amount is settable" do
+    Qu::Scheduler.poll_sleep_amount = 1
+    assert_equal 1, Qu::Scheduler.poll_sleep_amount
+  end
+
+end

data/test/scheduler_hooks_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+context "scheduling jobs with hooks" do
+  class JobThatCannotBeScheduledWithoutArguments
+    @queue = :job_that_cannot_be_scheduled_without_arguments
+    def self.perform(*x);end
+    def self.before_schedule_return_nil_if_arguments_not_supplied(*args)
+      counters[:before_schedule] += 1
+      return false if args.empty?
+    end
+
+    def self.after_schedule_do_something(*args)
+      counters[:after_schedule] += 1
+    end
+
+    class << self
+      def counters
+        @counters ||= Hash.new{|h,k| h[k]=0}
+      end
+      def clean
+        counters.clear
+        self
+      end
+    end
+  end
+
+  setup do
+    Qu::Scheduler.dynamic = false
+    Qu.backend.redis.del(:schedules)
+    Qu.backend.redis.del(:schedules_changed)
+    Qu::Scheduler.clear_schedule!
+    Qu::Scheduler.send(:class_variable_set, :@@scheduled_jobs, {})
+  end
+
+  test "before_schedule hook that does not return false should not block" do
+    enqueue_time = Time.now + 12
+    Qu.enqueue_at(enqueue_time, JobThatCannotBeScheduledWithoutArguments.clean, :foo)
+    assert_equal(1, Qu.backend.delayed_timestamp_size(enqueue_time.to_i), "delayed queue should have one entry now")
+    assert_equal(1, JobThatCannotBeScheduledWithoutArguments.counters[:before_schedule], 'before_schedule was not run')
+    assert_equal(1, JobThatCannotBeScheduledWithoutArguments.counters[:after_schedule], 'after_schedule was not run')
+  end
+
+  test "before_schedule hook that returns false should block" do
+    enqueue_time = Time.now + 60
+    assert_equal(0, JobThatCannotBeScheduledWithoutArguments.clean.counters[:before_schedule], 'before_schedule should be zero')
+    Qu.enqueue_at(enqueue_time, JobThatCannotBeScheduledWithoutArguments.clean)
+    assert_equal(0, Qu.backend.delayed_timestamp_size(enqueue_time.to_i), "job should not have been put in queue")
+    assert_equal(1, JobThatCannotBeScheduledWithoutArguments.counters[:before_schedule], 'before_schedule was not run')
+    assert_equal(0, JobThatCannotBeScheduledWithoutArguments.counters[:after_schedule], 'after_schedule was run')
+  end
+end

data/test/scheduler_test.rb

@@ -0,0 +1,181 @@
+require 'test_helper'
+
+context "Qu::Scheduler" do
+
+  setup do
+    Qu::Scheduler.dynamic = false
+    Qu.backend.redis.del(:schedules)
+    Qu.backend.redis.del(:schedules_changed)
+    Qu::Scheduler.clear_schedule!
+    Qu::Scheduler.send(:class_variable_set, :@@scheduled_jobs, {})
+  end
+
+  test "enqueue constantizes" do
+    # The job should be loaded, since a missing rails_env means ALL envs.
+    ENV['RAILS_ENV'] = 'production'
+    config = {'cron' => "* * * * *", 'klass' => 'SomeRealClass', 'args' => "/tmp"}
+    Qu.backend.expects(:enqueue).once.with(all_of(instance_of(Qu::Payload), responds_with(:klass, SomeRealClass), responds_with(:args, '/tmp'), responds_with(:cron, '* * * * *')))
+    Qu::Scheduler.enqueue_from_config(config)
+  end
+
+  test "config makes it into the rufus_scheduler" do
+    assert_equal(0, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+
+    Qu.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"}}
+    Qu::Scheduler.load_schedule!
+
+    assert_equal(1, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+    assert Qu::Scheduler.scheduled_jobs.include?(:some_ivar_job)
+  end
+
+  test "can reload schedule" do
+    Qu::Scheduler.dynamic = true
+    Qu.schedule = {"some_ivar_job" => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"}}
+
+    Qu::Scheduler.load_schedule!
+
+    assert_equal(1, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+    assert Qu::Scheduler.scheduled_jobs.include?("some_ivar_job")
+
+    Qu.backend.redis.del(:schedules)
+    Qu.backend.redis.hset(:schedules, "some_ivar_job2", MultiJson.encode(
+      {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/2"}
+    ))
+
+    Qu::Scheduler.reload_schedule!
+
+    assert_equal(1, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+
+    assert_equal '/tmp/2', Qu.schedule["some_ivar_job2"]["args"]
+    assert Qu::Scheduler.scheduled_jobs.include?("some_ivar_job2")
+  end
+
+  test "load_schedule_job loads a schedule" do 
+    Qu::Scheduler.load_schedule_job("some_ivar_job", {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"})
+
+    assert_equal(1, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(1, Qu::Scheduler.scheduled_jobs.size)
+    assert Qu::Scheduler.scheduled_jobs.keys.include?("some_ivar_job")
+  end
+
+  test "load_schedule_job without cron" do
+    Qu::Scheduler.load_schedule_job("some_ivar_job", {'class' => 'SomeIvarJob', 'args' => "/tmp"})
+
+    assert_equal(0, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Qu::Scheduler.scheduled_jobs.size)
+    assert !Qu::Scheduler.scheduled_jobs.keys.include?("some_ivar_job")
+  end
+
+  test "load_schedule_job with an empty cron" do
+    Qu::Scheduler.load_schedule_job("some_ivar_job", {'cron' => '', 'class' => 'SomeIvarJob', 'args' => "/tmp"})
+
+    assert_equal(0, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Qu::Scheduler.scheduled_jobs.size)
+    assert !Qu::Scheduler.scheduled_jobs.keys.include?("some_ivar_job")
+  end
+
+  test "update_schedule" do
+    Qu::Scheduler.dynamic = true
+    Qu.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"}
+    }
+
+    Qu::Scheduler.load_schedule!
+
+    Qu.backend.set_schedule("some_ivar_job",
+      {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/2"}
+    )
+    Qu.backend.set_schedule("new_ivar_job",
+      {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp/3"}
+    )
+    Qu.backend.set_schedule("stay_put_job",
+      {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp"}
+    )
+    Qu.backend.remove_schedule("another_ivar_job")
+
+    Qu.backend.update_schedule
+
+    assert_equal(3, Qu::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(3, Qu::Scheduler.scheduled_jobs.size)
+    %w(some_ivar_job new_ivar_job stay_put_job).each do |job_name|
+      assert Qu::Scheduler.scheduled_jobs.keys.include?(job_name)
+      assert Qu.schedule.keys.include?(job_name)
+    end
+    assert !Qu::Scheduler.scheduled_jobs.keys.include?("another_ivar_job")
+    assert !Qu.schedule.keys.include?("another_ivar_job")
+    assert_equal 0, Qu.backend.redis.scard(:schedules_changed)
+  end
+
+  test "update_schedule with mocks" do
+    Qu::Scheduler.dynamic = true
+    Qu.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"}
+    }
+
+    Qu::Scheduler.load_schedule!
+
+    Qu::Scheduler.rufus_scheduler.expects(:unschedule).with(Qu::Scheduler.scheduled_jobs["some_ivar_job"].job_id)
+    Qu::Scheduler.rufus_scheduler.expects(:unschedule).with(Qu::Scheduler.scheduled_jobs["another_ivar_job"].job_id)
+
+    Qu.backend.set_schedule("some_ivar_job",
+      {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/2"}
+    )
+    Qu.backend.set_schedule("new_ivar_job",
+      {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp/3"}
+    )
+    Qu.backend.set_schedule("stay_put_job",
+      {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp"}
+    )
+    Qu.backend.remove_schedule("another_ivar_job")
+
+    Qu.backend.update_schedule
+
+    assert_equal(3, Qu::Scheduler.scheduled_jobs.size)
+    %w(some_ivar_job new_ivar_job stay_put_job).each do |job_name|
+      assert Qu::Scheduler.scheduled_jobs.keys.include?(job_name)
+      assert Qu.schedule.keys.include?(job_name)
+    end
+    assert !Qu::Scheduler.scheduled_jobs.keys.include?("another_ivar_job")
+    assert !Qu.schedule.keys.include?("another_ivar_job")
+    assert_equal 0, Qu.backend.redis.scard(:schedules_changed)
+  end
+
+  test "schedule= sets the schedule" do
+    Qu::Scheduler.dynamic = true
+    Qu.schedule = {"my_ivar_job" => {
+      'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/75"
+    }}
+    assert_equal({'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/75"},
+      MultiJson.decode(Qu.backend.redis.hget(:schedules, "my_ivar_job")))
+  end
+
+  test "set_schedule can set an individual schedule" do
+    Qu.backend.set_schedule("some_ivar_job", {
+      'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/22"
+    })
+    assert_equal({'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/22"},
+      MultiJson.decode(Qu.backend.redis.hget(:schedules, "some_ivar_job")))
+    assert Qu.backend.redis.sismember(:schedules_changed, "some_ivar_job")
+  end
+
+  test "get_schedule returns a schedule" do
+    Qu.backend.redis.hset(:schedules, "some_ivar_job2", MultiJson.encode(
+      {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/33"}
+    ))
+    assert_equal({'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/33"},
+      Qu.backend.get_schedule("some_ivar_job2"))
+  end
+
+  test "remove_schedule removes a schedule" do
+    Qu.backend.redis.hset(:schedules, "some_ivar_job3", MultiJson.encode(
+      {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/44"}
+    ))
+    Qu.backend.remove_schedule("some_ivar_job3")
+    assert_equal nil, Qu.backend.redis.hget(:schedules, "some_ivar_job3")
+    assert Qu.backend.redis.sismember(:schedules_changed, "some_ivar_job3")
+  end
+end