xspond-delayed_job 1.8.5

data/spec/job_spec.rb

@@ -0,0 +1,315 @@
+require File.dirname(__FILE__) + '/database'
+require File.dirname(__FILE__) + '/sample_jobs'
+
+describe Delayed::Job do
+  before  do               
+    Delayed::Job.max_priority = nil
+    Delayed::Job.min_priority = nil      
+    
+    Delayed::Job.delete_all
+  end
+  
+  before(:each) do
+    SimpleJob.runs = 0
+  end
+
+  it "should set run_at automatically if not set" do
+    Delayed::Job.create(:payload_object => ErrorJob.new ).run_at.should_not == nil
+  end
+
+  it "should not set run_at automatically if already set" do
+    later = 5.minutes.from_now
+    Delayed::Job.create(:payload_object => ErrorJob.new, :run_at => later).run_at.should == later
+  end
+
+  it "should raise ArgumentError when handler doesn't respond_to :perform" do
+    lambda { Delayed::Job.enqueue(Object.new) }.should raise_error(ArgumentError)
+  end
+
+  it "should increase count after enqueuing items" do
+    Delayed::Job.enqueue SimpleJob.new
+    Delayed::Job.count.should == 1
+  end
+
+  it "should be able to set priority when enqueuing items" do
+    Delayed::Job.enqueue SimpleJob.new, 5
+    Delayed::Job.first.priority.should == 5
+  end
+
+  it "should be able to set run_at when enqueuing items" do
+    later = (Delayed::Job.db_time_now+5.minutes)
+    Delayed::Job.enqueue SimpleJob.new, 5, later
+
+    # use be close rather than equal to because millisecond values cn be lost in DB round trip
+    Delayed::Job.first.run_at.should be_close(later, 1)
+  end
+
+  it "should call perform on jobs when running run_with_lock" do
+    SimpleJob.runs.should == 0
+
+    job = Delayed::Job.enqueue SimpleJob.new
+    job.run_with_lock(Delayed::Job.max_run_time, 'worker')
+
+    SimpleJob.runs.should == 1
+  end
+                     
+                     
+  it "should work with eval jobs" do
+    $eval_job_ran = false
+
+    job = Delayed::Job.enqueue do <<-JOB
+      $eval_job_ran = true
+    JOB
+    end
+
+    job.run_with_lock(Delayed::Job.max_run_time, 'worker')
+
+    $eval_job_ran.should == true
+  end
+                   
+  it "should work with jobs in modules" do
+    M::ModuleJob.runs.should == 0
+
+    job = Delayed::Job.enqueue M::ModuleJob.new
+    job.run_with_lock(Delayed::Job.max_run_time, 'worker')
+
+    M::ModuleJob.runs.should == 1
+  end
+                   
+  it "should re-schedule by about 1 second at first and increment this more and more minutes when it fails to execute properly" do
+    job = Delayed::Job.enqueue ErrorJob.new
+    job.run_with_lock(Delayed::Job.max_run_time, 'worker')
+
+    job = Delayed::Job.find(:first)
+
+    job.last_error.should =~ /did not work/
+    job.last_error.should =~ /sample_jobs.rb:8:in `perform'/
+    job.attempts.should == 1
+
+    job.run_at.should > Delayed::Job.db_time_now - 10.minutes
+    job.run_at.should < Delayed::Job.db_time_now + 10.minutes
+  end
+
+  it "should record last_error when destroy_failed_jobs = false, max_attempts = 1" do
+    Delayed::Job.destroy_failed_jobs = false
+    Delayed::Job::max_attempts = 1
+    job = Delayed::Job.enqueue ErrorJob.new
+    job.run(1)
+    job.reload
+    job.last_error.should =~ /did not work/
+    job.last_error.should =~ /job_spec.rb/
+    job.attempts.should == 1
+
+    job.failed_at.should_not == nil
+  end
+
+  it "should raise an DeserializationError when the job class is totally unknown" do
+
+    job = Delayed::Job.new
+    job['handler'] = "--- !ruby/object:JobThatDoesNotExist {}"
+
+    lambda { job.payload_object.perform }.should raise_error(Delayed::DeserializationError)
+  end
+
+  it "should try to load the class when it is unknown at the time of the deserialization" do
+    job = Delayed::Job.new
+    job['handler'] = "--- !ruby/object:JobThatDoesNotExist {}"
+
+    job.should_receive(:attempt_to_load).with('JobThatDoesNotExist').and_return(true)
+
+    lambda { job.payload_object.perform }.should raise_error(Delayed::DeserializationError)
+  end
+
+  it "should try include the namespace when loading unknown objects" do
+    job = Delayed::Job.new
+    job['handler'] = "--- !ruby/object:Delayed::JobThatDoesNotExist {}"
+    job.should_receive(:attempt_to_load).with('Delayed::JobThatDoesNotExist').and_return(true)
+    lambda { job.payload_object.perform }.should raise_error(Delayed::DeserializationError)
+  end
+
+  it "should also try to load structs when they are unknown (raises TypeError)" do
+    job = Delayed::Job.new
+    job['handler'] = "--- !ruby/struct:JobThatDoesNotExist {}"
+
+    job.should_receive(:attempt_to_load).with('JobThatDoesNotExist').and_return(true)
+
+    lambda { job.payload_object.perform }.should raise_error(Delayed::DeserializationError)
+  end
+
+  it "should try include the namespace when loading unknown structs" do
+    job = Delayed::Job.new
+    job['handler'] = "--- !ruby/struct:Delayed::JobThatDoesNotExist {}"
+
+    job.should_receive(:attempt_to_load).with('Delayed::JobThatDoesNotExist').and_return(true)
+    lambda { job.payload_object.perform }.should raise_error(Delayed::DeserializationError)
+  end
+  
+  context "reschedule" do
+    before do
+      @job = Delayed::Job.create :payload_object => SimpleJob.new
+    end
+    
+    context "and we want to destroy jobs" do
+      before do
+        Delayed::Job.destroy_failed_jobs = true
+      end
+      
+      it "should be destroyed if it failed more than Job::max_attempts times" do
+        @job.should_receive(:destroy)
+        Delayed::Job::max_attempts.times { @job.reschedule 'FAIL' }
+      end
+      
+      it "should not be destroyed if failed fewer than Job::max_attempts times" do
+        @job.should_not_receive(:destroy)
+        (Delayed::Job::max_attempts - 1).times { @job.reschedule 'FAIL' }
+      end
+    end
+    
+    context "and we don't want to destroy jobs" do
+      before do
+        Delayed::Job.destroy_failed_jobs = false
+      end
+      
+      it "should be failed if it failed more than Job::max_attempts times" do
+        @job.reload.failed_at.should == nil
+        Delayed::Job::max_attempts.times { @job.reschedule 'FAIL' }
+        @job.reload.failed_at.should_not == nil
+      end
+
+      it "should not be failed if it failed fewer than Job::max_attempts times" do
+        (Delayed::Job::max_attempts - 1).times { @job.reschedule 'FAIL' }
+        @job.reload.failed_at.should == nil
+      end
+      
+    end
+  end
+  
+  it "should fail after Job::max_run_time" do
+    @job = Delayed::Job.create :payload_object => LongRunningJob.new
+    @job.run_with_lock(1.second, 'worker')
+    @job.reload.last_error.should =~ /expired/
+    @job.attempts.should == 1
+  end
+
+  it "should never find failed jobs" do
+    @job = Delayed::Job.create :payload_object => SimpleJob.new, :attempts => 50, :failed_at => Delayed::Job.db_time_now
+    Delayed::Job.find_available('worker', 1).length.should == 0
+  end
+
+  context "when another worker is already performing an task, it" do
+
+    before :each do
+      @job = Delayed::Job.create :payload_object => SimpleJob.new, :locked_by => 'worker1', :locked_at => Delayed::Job.db_time_now - 5.minutes
+    end
+
+    it "should not allow a second worker to get exclusive access" do
+      @job.lock_exclusively!(4.hours, 'worker2').should == false
+    end
+
+    it "should allow a second worker to get exclusive access if the timeout has passed" do
+      @job.lock_exclusively!(1.minute, 'worker2').should == true
+    end      
+    
+    it "should be able to get access to the task if it was started more then max_age ago" do
+      @job.locked_at = 5.hours.ago
+      @job.save
+
+      @job.lock_exclusively! 4.hours, 'worker2'
+      @job.reload
+      @job.locked_by.should == 'worker2'
+      @job.locked_at.should > 1.minute.ago
+    end
+
+    it "should not be found by another worker" do
+      Delayed::Job.find_available('worker2', 1, 6.minutes).length.should == 0
+    end
+
+    it "should be found by another worker if the time has expired" do
+      Delayed::Job.find_available('worker2', 1, 4.minutes).length.should == 1
+    end
+
+    it "should be able to get exclusive access again when the worker name is the same" do
+      @job.lock_exclusively!(5.minutes, 'worker1').should be_true
+      @job.lock_exclusively!(5.minutes, 'worker1').should be_true
+      @job.lock_exclusively!(5.minutes, 'worker1').should be_true
+    end                                        
+  end
+  
+  context "when another worker has worked on a task since the job was found to be available, it" do
+
+    before :each do
+      @job = Delayed::Job.create :payload_object => SimpleJob.new
+      @job_copy_for_worker_2 = Delayed::Job.find(@job.id)
+    end
+
+    it "should not allow a second worker to get exclusive access if already successfully processed by worker1" do
+      @job.delete
+      @job_copy_for_worker_2.lock_exclusively!(4.hours, 'worker2').should == false
+    end
+
+    it "should not allow a second worker to get exclusive access if failed to be processed by worker1 and run_at time is now in future (due to backing off behaviour)" do
+      @job.update_attributes(:attempts => 1, :run_at => 1.day.from_now)
+      @job_copy_for_worker_2.lock_exclusively!(4.hours, 'worker2').should == false
+    end
+  end
+
+  context "#name" do
+    it "should be the class name of the job that was enqueued" do
+      Delayed::Job.create(:payload_object => ErrorJob.new ).name.should == 'ErrorJob'
+    end
+
+    it "should be the method that will be called if its a performable method object" do
+      Delayed::Job.send_later(:clear_locks!)
+      Delayed::Job.last.name.should == 'Delayed::Job.clear_locks!'
+
+    end
+    it "should be the instance method that will be called if its a performable method object" do
+      story = Story.create :text => "..."                 
+      
+      story.send_later(:save)
+      
+      Delayed::Job.last.name.should == 'Story#save'
+    end
+  end
+  
+  context "worker prioritization" do
+    
+    before(:each) do
+      Delayed::Job.max_priority = nil
+      Delayed::Job.min_priority = nil      
+    end
+
+    it "should fetch jobs ordered by priority" do
+      number_of_jobs = 10
+      number_of_jobs.times { Delayed::Job.enqueue SimpleJob.new, rand(10) }
+      jobs = Delayed::Job.find_available('worker', 10)
+      ordered = true
+      jobs[1..-1].each_index{ |i| 
+        if (jobs[i].priority < jobs[i+1].priority)
+          ordered = false
+          break
+        end
+      }
+      ordered.should == true
+    end
+   
+  end
+  
+  context "when pulling jobs off the queue for processing, it" do
+    before(:each) do
+      @job = Delayed::Job.create(
+        :payload_object => SimpleJob.new, 
+        :locked_by => 'worker1', 
+        :locked_at => Delayed::Job.db_time_now - 5.minutes)
+    end
+
+    it "should leave the queue in a consistent state and not run the job if locking fails" do
+      SimpleJob.runs.should == 0     
+      @job.stub!(:lock_exclusively!).with(any_args).once.and_return(false)
+      @job.run_with_lock(Delayed::Job.max_run_time, 'worker')
+      SimpleJob.runs.should == 0
+    end
+  
+  end
+  
+end

data/spec/sample_jobs.rb

@@ -0,0 +1,21 @@
+class SimpleJob
+  cattr_accessor :runs; self.runs = 0
+  def perform; @@runs += 1; end
+end
+
+class ErrorJob
+  cattr_accessor :runs; self.runs = 0
+  def perform; raise 'did not work'; end
+end             
+
+class LongRunningJob
+  def perform; sleep 250; end
+end
+
+module M
+  class ModuleJob
+    cattr_accessor :runs; self.runs = 0
+    def perform; @@runs += 1; end    
+  end
+  
+end

data/spec/story_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/database'
+
+describe "A story" do
+
+  before(:all) do
+    @story = Story.create :text => "Once upon a time..."
+  end
+
+  it "should be shared" do
+    @story.tell.should == 'Once upon a time...'
+  end
+
+  it "should not return its result if it storytelling is delayed" do
+    @story.send_later(:tell).should_not == 'Once upon a time...'
+  end
+
+end

data/spec/worker_spec.rb

@@ -0,0 +1,105 @@
+require File.dirname(__FILE__) + '/database'
+require File.dirname(__FILE__) + '/sample_jobs'
+
+describe Delayed::Worker do
+  def job_create(opts = {})
+    Delayed::Job.create(opts.merge(:payload_object => SimpleJob.new))
+  end
+
+  before do
+    Delayed::Worker.class_eval('public :work_off')
+  end
+
+  before(:each) do
+    @worker = Delayed::Worker.new(:max_priority => nil, :min_priority => nil)
+
+    Delayed::Job.delete_all
+    
+    SimpleJob.runs = 0
+  end
+
+  context "worker prioritization" do
+    before(:each) do
+      @worker = Delayed::Worker.new(:max_priority => 5, :min_priority => -5)
+    end
+
+    it "should only work_off jobs that are >= min_priority" do
+      pending('Needs to work with forked workers')
+      SimpleJob.runs.should == 0
+
+      job_create(:priority => -10)
+      job_create(:priority => 0)
+      @worker.work_off
+
+      SimpleJob.runs.should == 1
+    end
+
+    it "should only work_off jobs that are <= max_priority" do
+      pending('Needs to work with forked workers')
+      SimpleJob.runs.should == 0
+
+      job_create(:priority => 10)
+      job_create(:priority => 0)
+
+      @worker.work_off
+
+      SimpleJob.runs.should == 1
+    end
+  end
+
+  context "while running alongside other workers that locked jobs, it" do
+    before(:each) do
+      @worker.name = 'worker1'
+      job_create(:locked_by => 'worker1', :locked_at => (Delayed::Job.db_time_now - 1.minutes))
+      job_create(:locked_by => 'worker2', :locked_at => (Delayed::Job.db_time_now - 1.minutes))
+      job_create
+      job_create(:locked_by => 'worker1', :locked_at => (Delayed::Job.db_time_now - 1.minutes))
+    end
+
+    it "should ingore locked jobs from other workers" do
+      pending('Needs to work with forked workers')
+      @worker.name = 'worker3'
+      SimpleJob.runs.should == 0
+      @worker.work_off
+      SimpleJob.runs.should == 1 # runs the one open job
+    end
+
+    it "should find our own jobs regardless of locks" do
+      pending('Needs to work with forked workers')
+      @worker.name = 'worker1'
+      SimpleJob.runs.should == 0
+      @worker.work_off
+      SimpleJob.runs.should == 3 # runs open job plus worker1 jobs that were already locked
+    end
+  end
+
+  context "while running with locked and expired jobs, it" do
+    before(:each) do
+      @worker.name = 'worker1'
+      exp_time = Delayed::Job.db_time_now - (1.minutes + Delayed::Job::max_run_time)
+      job_create(:locked_by => 'worker1', :locked_at => exp_time)
+      job_create(:locked_by => 'worker2', :locked_at => (Delayed::Job.db_time_now - 1.minutes))
+      job_create
+      job_create(:locked_by => 'worker1', :locked_at => (Delayed::Job.db_time_now - 1.minutes))
+    end
+
+    it "should only find unlocked and expired jobs" do
+      pending('Needs to work with forked workers')
+      @worker.name = 'worker3'
+      SimpleJob.runs.should == 0
+      @worker.work_off
+      SimpleJob.runs.should == 2 # runs the one open job and one expired job
+    end
+
+    it "should ignore locks when finding our own jobs" do
+      pending('Needs to work with forked workers')
+      @worker.name = 'worker1'
+      SimpleJob.runs.should == 0
+      @worker.work_off
+      SimpleJob.runs.should == 3 # runs open job plus worker1 jobs
+      # This is useful in the case of a crash/restart on worker1, but make sure multiple workers on the same host have unique names!
+    end
+
+  end
+
+end