sidekiq-cron 0.6.3 → 1.10.0

data/test/unit/launcher_test.rb

@@ -0,0 +1,33 @@
+require './test/test_helper'
+
+describe 'Cron launcher' do
+  describe 'initialization' do
+    before do
+      Sidekiq::Options[:cron_poll_interval] = nil
+    end
+
+    it 'initializes poller with default poll interval when not configured' do
+      Sidekiq::Cron::Poller.expects(:new).with do |options|
+        assert_equal Sidekiq::Cron::Launcher::DEFAULT_POLL_INTERVAL, options[:cron_poll_interval]
+      end
+
+      Sidekiq::Launcher.new(Sidekiq.respond_to?(:default_configuration) ? Sidekiq.default_configuration : Sidekiq)
+    end
+
+    it 'initializes poller with the configured poll interval' do
+      Sidekiq::Cron::Poller.expects(:new).with do |options|
+        assert_equal 99, options[:cron_poll_interval]
+      end
+
+      Sidekiq::Options[:cron_poll_interval] = 99
+      Sidekiq::Launcher.new(Sidekiq.respond_to?(:default_configuration) ? Sidekiq.default_configuration : Sidekiq)
+    end
+
+    it 'does not initialize the poller when interval is 0' do
+      Sidekiq::Cron::Poller.expects(:new).never
+
+      Sidekiq::Options[:cron_poll_interval] = 0
+      Sidekiq::Launcher.new(Sidekiq.respond_to?(:default_configuration) ? Sidekiq.default_configuration : Sidekiq)
+    end
+  end
+end

data/test/unit/poller_test.rb

@@ -1,22 +1,12 @@
-# -*- encoding : utf-8 -*-
 require './test/test_helper'
 
-
 describe 'Cron Poller' do
   before do
-    Sidekiq.redis = REDIS
+    # Clear all previous saved data from Redis.
     Sidekiq.redis do |conn|
       conn.flushdb
     end
 
-    #clear all previous saved data from redis
-    Sidekiq.redis do |conn|
-      conn.keys("cron_job*").each do |key|
-        conn.del(key)
-      end
-    end
-
-
     @args = {
       name: "Test",
       cron: "*/2 * * * *",
@@ -24,14 +14,14 @@ describe 'Cron Poller' do
     }
     @args2 = @args.merge(name: 'with_queue', klass: 'CronTestClassWithQueue', cron: "*/10 * * * *")
 
-    @poller = Sidekiq::Cron::Poller.new
+    @poller = Sidekiq::Cron::Poller.new(Sidekiq.const_defined?(:Config) ? Sidekiq::Config.new : {})
   end
 
   it 'not enqueue any job - new jobs' do
-    now = Time.now.utc
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 5, 1)
+    now = Time.now.utc + 3600
+    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 5, 1)
     Time.stubs(:now).returns(enqueued_time)
-    #new jobs!
+
     Sidekiq::Cron::Job.create(@args)
     Sidekiq::Cron::Job.create(@args2)
 
@@ -42,22 +32,23 @@ describe 'Cron Poller' do
       assert_equal 0, conn.llen("queue:super")
     end
 
-    #30 seconds after!
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 5, 30)
+    # 30 seconds after!
+    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 5, 30)
     Time.stubs(:now).returns(enqueued_time)
-      @poller.enqueue
 
-      Sidekiq.redis do |conn|
-        assert_equal 0, conn.llen("queue:default")
-        assert_equal 0, conn.llen("queue:super")
-      end
+    @poller.enqueue
+
+    Sidekiq.redis do |conn|
+      assert_equal 0, conn.llen("queue:default")
+      assert_equal 0, conn.llen("queue:super")
+    end
   end
 
   it 'should enqueue only job with cron */2' do
-    now = Time.now.utc
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 5, 1)
+    now = Time.now.utc + 3600
+    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 5, 1)
     Time.stubs(:now).returns(enqueued_time)
-    #new jobs!
+
     Sidekiq::Cron::Job.create(@args)
     Sidekiq::Cron::Job.create(@args2)
 
@@ -68,7 +59,7 @@ describe 'Cron Poller' do
       assert_equal 0, conn.llen("queue:super")
     end
 
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 6, 1)
+    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 6, 1)
     Time.stubs(:now).returns(enqueued_time)
     @poller.enqueue
 
@@ -79,10 +70,10 @@ describe 'Cron Poller' do
   end
 
   it 'should enqueue both jobs' do
-    now = Time.now.utc
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 8, 1)
+    now = Time.now.utc + 3600
+    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 8, 1)
     Time.stubs(:now).returns(enqueued_time)
-    #new jobs!
+
     Sidekiq::Cron::Job.create(@args)
     Sidekiq::Cron::Job.create(@args2)
 
@@ -93,7 +84,7 @@ describe 'Cron Poller' do
       assert_equal 0, conn.llen("queue:super")
     end
 
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 10, 5)
+    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 10, 5)
     Time.stubs(:now).returns(enqueued_time)
     @poller.enqueue
 
@@ -104,10 +95,10 @@ describe 'Cron Poller' do
   end
 
   it 'should enqueue both jobs but only one time each' do
-    now = Time.now.utc
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 8, 1)
+    now = Time.now.utc + 3600
+    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 8, 1)
     Time.stubs(:now).returns(enqueued_time)
-    #new jobs!
+
     Sidekiq::Cron::Job.create(@args)
     Sidekiq::Cron::Job.create(@args2)
 
@@ -118,7 +109,7 @@ describe 'Cron Poller' do
       assert_equal 0, conn.llen("queue:super")
     end
 
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 20, 1)
+    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 20, 1)
     Time.stubs(:now).returns(enqueued_time)
     @poller.enqueue
     Sidekiq.redis do |conn|
@@ -126,7 +117,7 @@ describe 'Cron Poller' do
       assert_equal 1, conn.llen("queue:super")
     end
 
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 20, 2)
+    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 20, 2)
     Time.stubs(:now).returns(enqueued_time)
     @poller.enqueue
     Sidekiq.redis do |conn|
@@ -134,7 +125,7 @@ describe 'Cron Poller' do
       assert_equal 1, conn.llen("queue:super")
     end
 
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 20, 20)
+    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 20, 20)
     Time.stubs(:now).returns(enqueued_time)
     @poller.enqueue
     Sidekiq.redis do |conn|
@@ -142,7 +133,7 @@ describe 'Cron Poller' do
       assert_equal 1, conn.llen("queue:super")
     end
 
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 20, 50)
+    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 20, 50)
     Time.stubs(:now).returns(enqueued_time)
     @poller.enqueue
     Sidekiq.redis do |conn|

data/test/unit/schedule_loader_test.rb

@@ -0,0 +1,58 @@
+require './test/test_helper'
+
+describe 'ScheduleLoader' do
+  before do
+    Sidekiq::Options[:lifecycle_events][:startup].clear
+  end
+
+  describe 'Schedule is defined in hash' do
+    before do
+      Sidekiq::Options[:cron_schedule_file] = 'test/unit/fixtures/schedule_hash.yml'
+      load 'sidekiq/cron/schedule_loader.rb'
+    end
+
+    it 'calls Sidekiq::Cron::Job.load_from_hash' do
+      Sidekiq::Cron::Job.expects(:load_from_hash!)
+      Sidekiq::Options[:lifecycle_events][:startup].first.call
+    end
+  end
+
+  describe 'Schedule is defined in array' do
+    before do
+      Sidekiq::Options[:cron_schedule_file] = 'test/unit/fixtures/schedule_array.yml'
+      load 'sidekiq/cron/schedule_loader.rb'
+    end
+
+    it 'calls Sidekiq::Cron::Job.load_from_array' do
+      Sidekiq::Cron::Job.expects(:load_from_array!)
+      Sidekiq::Options[:lifecycle_events][:startup].first.call
+    end
+  end
+
+  describe 'Schedule is not defined in hash nor array' do
+    before do
+      Sidekiq::Options[:cron_schedule_file] = 'test/unit/fixtures/schedule_string.yml'
+      load 'sidekiq/cron/schedule_loader.rb'
+    end
+
+    it 'raises an error' do
+      e = assert_raises StandardError do
+        Sidekiq::Options[:lifecycle_events][:startup].first.call
+      end
+      assert_equal 'Not supported schedule format. Confirm your test/unit/fixtures/schedule_string.yml', e.message
+    end
+  end
+
+  describe 'Schedule is defined using ERB' do
+    it 'properly parses the schedule file' do
+      Sidekiq::Options[:cron_schedule_file] = 'test/unit/fixtures/schedule_erb.yml'
+      load 'sidekiq/cron/schedule_loader.rb'
+
+      Sidekiq::Options[:lifecycle_events][:startup].first.call
+
+      job = Sidekiq::Cron::Job.find("daily_job")
+      assert_equal job.klass, "DailyJob"
+      assert_equal job.cron, "every day at 5 pm"
+    end
+  end
+end

data/test/unit/web_extension_test.rb

@@ -1,37 +1,38 @@
 require './test/test_helper'
 
-def app
-  Sidekiq::Web
-end
-
 describe 'Cron web' do
   include Rack::Test::Methods
 
+  TOKEN = SecureRandom.base64(32).freeze
+
+  def app
+    Sidekiq::Web
+  end
+
   before do
-    Sidekiq.redis = REDIS
-    Sidekiq.redis {|c| c.flushdb }
+    env 'rack.session', { csrf: TOKEN }
+    env 'HTTP_X_CSRF_TOKEN', TOKEN
+    Sidekiq.redis { |c| c.flushdb }
+  end
 
-    #clear all previous saved data from redis
-    Sidekiq.redis do |conn|
-      conn.keys("cron_job*").each do |key|
-        conn.del(key)
-      end
-    end
+  let(:job_name) { "TestNameOfCronJob" }
+  let(:cron_job_name) { "TesQueueNameOfCronJob" }
 
-    @args = {
-      name: "TestNameOfCronJob",
+  let(:args) do
+    {
+      name: job_name,
       cron: "*/2 * * * *",
       klass: "CronTestClass"
     }
+  end
 
-
-    @cron_args = {
-      name: "TesQueueNameOfCronJob",
+  let(:cron_args) do
+    {
+      name: cron_job_name,
       cron: "*/2 * * * *",
       klass: "CronQueueTestClass",
       queue: "cron"
     }
-
   end
 
   it 'display cron web' do
@@ -41,45 +42,62 @@ describe 'Cron web' do
 
   it 'display cron web with message - no cron jobs' do
     get '/cron'
-    assert last_response.body.include?('No cron jobs found')
+    assert last_response.body.include?('No cron jobs were found')
   end
 
   it 'display cron web with cron jobs table' do
-    Sidekiq::Cron::Job.create(@args)
+    Sidekiq::Cron::Job.create(args)
 
     get '/cron'
     assert_equal 200, last_response.status
-    refute last_response.body.include?('No cron jobs found')
+    refute last_response.body.include?('No cron jobs were found')
     assert last_response.body.include?('table')
     assert last_response.body.include?("TestNameOfCronJob")
   end
 
   describe "work with cron job" do
-
     before do
-      @job = Sidekiq::Cron::Job.new(@args.merge(status: "enabled"))
-      @job.save
-      @name = "TestNameOfCronJob"
+      @job = Sidekiq::Cron::Job.new(args.merge(status: "enabled"))
+      assert @job.save
+
+      @cron_job = Sidekiq::Cron::Job.new(cron_args.merge(status: "enabled"))
+      assert @cron_job.save
+    end
+
+    it 'shows history of a cron job' do
+      @job.enque!
+      get "/cron/#{job_name}"
+
+      jid =
+        Sidekiq.redis do |conn|
+          history = conn.lrange Sidekiq::Cron::Job.jid_history_key(job_name), 0, -1
+          Sidekiq.load_json(history.last)['jid']
+        end
+
+      assert jid
+      assert last_response.body.include?(jid)
+    end
+
+    it 'redirects to cron path when name not found' do
+      get '/cron/some-fake-name'
 
-      @cron_job = Sidekiq::Cron::Job.new(@cron_args.merge(status: "enabled"))
-      @cron_job.save
-      @cron_job_name = "TesQueueNameOfCronJob"
+      assert_match %r{\/cron\z}, last_response['Location']
     end
 
     it "disable and enable all cron jobs" do
       post "/cron/__all__/disable"
-      assert_equal Sidekiq::Cron::Job.find(@name).status, "disabled"
+      assert_equal Sidekiq::Cron::Job.find(job_name).status, "disabled"
 
       post "/cron/__all__/enable"
-      assert_equal Sidekiq::Cron::Job.find(@name).status, "enabled"
+      assert_equal Sidekiq::Cron::Job.find(job_name).status, "enabled"
     end
 
     it "disable and enable cron job" do
-      post "/cron/#{@name}/disable"
-      assert_equal Sidekiq::Cron::Job.find(@name).status, "disabled"
+      post "/cron/#{job_name}/disable"
+      assert_equal Sidekiq::Cron::Job.find(job_name).status, "disabled"
 
-      post "/cron/#{@name}/enable"
-      assert_equal Sidekiq::Cron::Job.find(@name).status, "enabled"
+      post "/cron/#{job_name}/enable"
+      assert_equal Sidekiq::Cron::Job.find(job_name).status, "enabled"
     end
 
     it "enqueue all jobs" do
@@ -100,21 +118,21 @@ describe 'Cron web' do
         assert_equal 0, conn.llen("queue:default"), "Queue should have no jobs"
       end
 
-      post "/cron/#{@name}/enque"
+      post "/cron/#{job_name}/enque"
 
       Sidekiq.redis do |conn|
         assert_equal 1, conn.llen("queue:default"), "Queue should have 1 job"
       end
 
-      #should enqueue more times
-      post "/cron/#{@name}/enque"
+      # Should enqueue more times.
+      post "/cron/#{job_name}/enque"
 
       Sidekiq.redis do |conn|
         assert_equal 2, conn.llen("queue:default"), "Queue should have 2 job"
       end
 
-      #should enqueue to cron job queue
-      post "/cron/#{@cron_job_name}/enque"
+      # Should enqueue to cron job queue.
+      post "/cron/#{cron_job_name}/enque"
 
       Sidekiq.redis do |conn|
         assert_equal 1, conn.llen("queue:cron"), "Queue should have 1 cron job"
@@ -123,8 +141,8 @@ describe 'Cron web' do
 
     it "destroy job" do
       assert_equal Sidekiq::Cron::Job.all.size, 2, "Should have 2 job"
-      post "/cron/#{@name}/delete"
-      post "/cron/#{@cron_job_name}/delete"
+      post "/cron/#{job_name}/delete"
+      post "/cron/#{cron_job_name}/delete"
       assert_equal Sidekiq::Cron::Job.all.size, 0, "Should have zero jobs"
     end