sidekiq-cron 0.6.3 → 1.4.0

data/test/unit/job_test.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require './test/test_helper'
 
 describe "Cron Job" do
@@ -131,6 +130,28 @@ describe "Cron Job" do
     end
   end
 
+  describe 'parse_enqueue_time' do
+    before do
+      @args = {
+        name: "Test",
+        cron: "* * * * *"
+      }
+      @job = Sidekiq::Cron::Job.new(@args)
+    end
+
+    it 'should correctly parse new format' do
+      assert_equal @job.send(:parse_enqueue_time, '2017-01-02 15:23:43 UTC'), Time.new(2017, 1, 2, 15, 23, 43, '+00:00')
+    end
+
+    it 'should correctly parse new format with different timezone' do
+      assert_equal @job.send(:parse_enqueue_time, '2017-01-02 15:23:43 +01:00'), Time.new(2017, 1, 2, 15, 23, 43, '+01:00')
+    end
+
+    it 'should correctly parse old format' do
+      assert_equal @job.send(:parse_enqueue_time, '2017-01-02 15:23:43'), Time.new(2017, 1, 2, 15, 23, 43, '+00:00')
+    end
+  end
+
   describe 'formatted time' do
     before do
       @args = {
@@ -201,6 +222,34 @@ describe "Cron Job" do
                                  "class"=>"CronTestClassWithQueue",
                                  "args"=>[]}
     end
+
+    it "be initialized with 'class' and date_as_argument" do
+      job = Sidekiq::Cron::Job.new('class' => 'CronTestClassWithQueue', "date_as_argument" => true)
+
+      job_message = job.message
+      job_args    = job_message.delete("args")
+      assert_equal job_message, {"retry"=>false,
+                                 "queue"=>:super,
+                                 "backtrace"=>true,
+                                 "class"=>"CronTestClassWithQueue"}
+      assert job_args[-1].is_a?(Float)
+      assert job_args[-1].between?(Time.now.to_f - 1, Time.now.to_f)
+    end
+
+    it "be initialized with 'class', 2 arguments and date_as_argument" do
+      job = Sidekiq::Cron::Job.new('class' => 'CronTestClassWithQueue', "date_as_argument" => true, "args"=> ["arg1", :arg2])
+
+      job_message = job.message
+      job_args    = job_message.delete("args")
+      assert_equal job_message, {"retry"=>false,
+                                 "queue"=>:super,
+                                 "backtrace"=>true,
+                                 "class"=>"CronTestClassWithQueue"}
+      assert job_args[-1].is_a?(Float)
+      assert job_args[-1].between?(Time.now.to_f - 1, Time.now.to_f)
+      assert_equal job_args[0..-2], ["arg1", :arg2]
+    end
+
   end
 
   describe "cron test" do
@@ -210,24 +259,24 @@ describe "Cron Job" do
 
     it "return previous minute" do
       @job.cron = "* * * * *"
-      time = Time.now.utc
+      time = Time.new(2018, 8, 10, 13, 24, 56).utc
       assert_equal @job.last_time(time).strftime("%Y-%m-%d-%H-%M-%S"), time.strftime("%Y-%m-%d-%H-%M-00")
     end
 
     it "return previous hour" do
       @job.cron = "1 * * * *"
-      time = Time.now.utc
+      time = Time.new(2018, 8, 10, 13, 24, 56).utc
       assert_equal @job.last_time(time).strftime("%Y-%m-%d-%H-%M-%S"), time.strftime("%Y-%m-%d-%H-01-00")
     end
 
     it "return previous day" do
       @job.cron = "1 2 * * * Etc/GMT"
-      time = Time.now.utc
+      time = Time.new(2018, 8, 10, 13, 24, 56).utc
 
       if time.hour >= 2
         assert_equal @job.last_time(time).strftime("%Y-%m-%d-%H-%M-%S"), time.strftime("%Y-%m-%d-02-01-00")
       else
-        yesterday = (Date.today - 1)
+        yesterday = time - 1.day
         assert_equal @job.last_time(time).strftime("%Y-%m-%d-%H-%M-%S"), yesterday.strftime("%Y-%m-%d-02-01-00")
       end
     end
@@ -299,6 +348,109 @@ describe "Cron Job" do
     it 'should return valid payload for Sidekiq::Client' do
       payload = {
         'class'       => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped'     => 'ActiveJobCronTestClass',
+        'queue'       => 'super_queue',
+        'description' => nil,
+        'args'        => [{
+          'job_class'  => 'ActiveJobCronTestClass',
+          'job_id'     => 'XYZ',
+          'queue_name' => 'super_queue',
+          'arguments'  => [{foo: 'bar'}]
+        }]
+      }
+      assert_equal @job.active_job_message, payload
+    end
+  end
+
+  describe '#active_job_message - unknown Active Job Worker class' do
+    before do
+      SecureRandom.stubs(:uuid).returns('XYZ')
+      ActiveJob::Base.queue_name_prefix = ''
+
+      @args = {
+        name:  'Test',
+        cron:  '* * * * *',
+        klass: 'UnknownActiveJobCronTestClass',
+        active_job: true,
+        queue: 'super_queue',
+        description: nil,
+        args:  { foo: 'bar' }
+      }
+      @job = Sidekiq::Cron::Job.new(@args)
+    end
+
+    it 'should return valid payload for Sidekiq::Client' do
+      payload = {
+        'class'       => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped'     => 'UnknownActiveJobCronTestClass',
+        'queue'       => 'super_queue',
+        'description' => nil,
+        'args'        => [{
+          'job_class'  => 'UnknownActiveJobCronTestClass',
+          'job_id'     => 'XYZ',
+          'queue_name' => 'super_queue',
+          'arguments'  => [{foo: 'bar'}]
+        }]
+      }
+      assert_equal @job.active_job_message, payload
+    end
+  end
+
+  describe '#active_job_message with symbolize_args (hash)' do
+    before do
+      SecureRandom.stubs(:uuid).returns('XYZ')
+      ActiveJob::Base.queue_name_prefix = ''
+
+      @args = {
+        name:  'Test',
+        cron:  '* * * * *',
+        klass: 'ActiveJobCronTestClass',
+        queue: 'super_queue',
+        description: nil,
+        symbolize_args: true,
+        args: { 'foo' => 'bar' }
+      }
+      @job = Sidekiq::Cron::Job.new(@args)
+    end
+
+    it 'should return valid payload for Sidekiq::Client' do
+      payload = {
+        'class'       => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped'     => 'ActiveJobCronTestClass',
+        'queue'       => 'super_queue',
+        'description' => nil,
+        'args'        => [{
+          'job_class'  => 'ActiveJobCronTestClass',
+          'job_id'     => 'XYZ',
+          'queue_name' => 'super_queue',
+          'arguments'  => [{foo: 'bar'}]
+        }]
+      }
+      assert_equal @job.active_job_message, payload
+    end
+  end
+
+  describe '#active_job_message with symbolize_args (array)' do
+    before do
+      SecureRandom.stubs(:uuid).returns('XYZ')
+      ActiveJob::Base.queue_name_prefix = ''
+
+      @args = {
+        name:  'Test',
+        cron:  '* * * * *',
+        klass: 'ActiveJobCronTestClass',
+        queue: 'super_queue',
+        description: nil,
+        symbolize_args: true,
+        args: [{ 'foo' => 'bar' }]
+      }
+      @job = Sidekiq::Cron::Job.new(@args)
+    end
+
+    it 'should return valid payload for Sidekiq::Client' do
+      payload = {
+        'class'       => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped'     => 'ActiveJobCronTestClass',
         'queue'       => 'super_queue',
         'description' => nil,
         'args'        => [{
@@ -330,10 +482,11 @@ describe "Cron Job" do
 
     it 'should return valid payload for Sidekiq::Client' do
       payload = {
-        'class' => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
-        'queue' => 'prefix_super_queue',
+        'class'       => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped'     => 'ActiveJobCronTestClass',
+        'queue'       => 'prefix_super_queue',
         'description' => nil,
-        'args'  =>[{
+        'args'        => [{
           'job_class'  => 'ActiveJobCronTestClass',
           'job_id'     => 'XYZ',
           'queue_name' => 'prefix_super_queue',
@@ -357,7 +510,7 @@ describe "Cron Job" do
 
       it 'pushes to queue active jobs message' do
         @job.expects(:enqueue_active_job)
-            .returns(true)
+            .returns(ActiveJobCronTestClass.new)
         @job.enque!
       end
     end
@@ -375,7 +528,7 @@ describe "Cron Job" do
 
       it 'pushes to queue active jobs message with queue_name_prefix' do
         @job.expects(:enqueue_active_job)
-            .returns(true)
+            .returns(ActiveJobCronTestClass.new)
         @job.enque!
       end
     end
@@ -522,7 +675,6 @@ describe "Cron Job" do
       assert @job.save
     end
 
-
     it "be saved and found by name" do
       assert @job.save, "not saved"
       assert Sidekiq::Cron::Job.find("Test").is_a?(Sidekiq::Cron::Job)
@@ -599,14 +751,15 @@ describe "Cron Job" do
 
     it "last_enqueue_time shouldn't be rewritten after save" do
       #adding last_enqueue_time to initialize is only for test purpose
-      last_enqueue_time = '2013-01-01 23:59:59'
+      last_enqueue_time = '2013-01-01 23:59:59 +0000'
+      expected_enqueue_time = DateTime.parse(last_enqueue_time).to_time.utc
       Sidekiq::Cron::Job.create(@args.merge('last_enqueue_time' => last_enqueue_time))
       job = Sidekiq::Cron::Job.find(@args)
-      assert_equal job.last_enqueue_time, Time.parse(last_enqueue_time)
+      assert_equal job.last_enqueue_time, expected_enqueue_time
 
       Sidekiq::Cron::Job.create(@args)
       job = Sidekiq::Cron::Job.find(@args)
-      assert_equal job.last_enqueue_time, Time.parse(last_enqueue_time), "after second create should have same time"
+      assert_equal job.last_enqueue_time, expected_enqueue_time, "after second create should have same time"
     end
   end
 
@@ -775,11 +928,11 @@ describe "Cron Job" do
         cron: "* * * * *",
         klass: "CronTestClass"
       }
-      #first time is allways
+      #first time is always
       #after next cron time!
       @time = Time.now.utc + 120
     end
-    it "be allways false when status is disabled" do
+    it "be always false when status is disabled" do
       refute Sidekiq::Cron::Job.new(@args.merge(status: 'disabled')).should_enque? @time
       refute Sidekiq::Cron::Job.new(@args.merge(status: 'disabled')).should_enque? @time - 60
       refute Sidekiq::Cron::Job.new(@args.merge(status: 'disabled')).should_enque? @time - 120
@@ -883,7 +1036,8 @@ describe "Cron Job" do
         @jobs_hash['name_of_job']['cron'] = "bad cron"
         out = Sidekiq::Cron::Job.load_from_hash @jobs_hash
         assert_equal 1, out.size, "should have 1 error"
-        assert_equal ({"name_of_job"=>["'cron' -> bad cron: not a valid cronline : 'bad cron'"]}), out
+        assert_includes out['name_of_job'].first, "bad cron"
+        assert_includes out['name_of_job'].first, "ArgumentError:"
         assert_equal 1, Sidekiq::Cron::Job.all.size, "Should have only 1 job after load"
       end
 
@@ -965,7 +1119,6 @@ describe "Cron Job" do
 
         assert_equal Sidekiq::Cron::Job.all.first.sidekiq_worker_message, payload
       end
-
     end
   end
 end

data/test/unit/poller_test.rb

@@ -1,13 +1,9 @@
-# -*- encoding : utf-8 -*-
 require './test/test_helper'
 
-
 describe 'Cron Poller' do
   before do
+    REDIS.with { |c| c.respond_to?(:redis) ? c.redis.flushdb : c.flushdb }
     Sidekiq.redis = REDIS
-    Sidekiq.redis do |conn|
-      conn.flushdb
-    end
 
     #clear all previous saved data from redis
     Sidekiq.redis do |conn|
@@ -28,8 +24,8 @@ describe 'Cron Poller' do
   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)
@@ -43,19 +39,20 @@ describe 'Cron Poller' do
     end
 
     #30 seconds after!
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 5, 30)
+    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)
@@ -68,7 +65,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,8 +76,8 @@ 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)
@@ -93,7 +90,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,8 +101,8 @@ 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)
@@ -118,7 +115,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 +123,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 +131,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 +139,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/web_extension_test.rb

@@ -1,37 +1,39 @@
 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
+    env 'rack.session', { csrf: TOKEN }
+    env 'HTTP_X_CSRF_TOKEN', TOKEN
+    REDIS.with { |c| c.respond_to?(:redis) ? c.redis.flushdb : c.flushdb }
     Sidekiq.redis = REDIS
-    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 +43,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 +119,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"
+      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"
+      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 +142,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