topprospect-delayed_job 2.0.5

data/spec/backend/mongo_mapper_job_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'backend/shared_backend_spec'
+require 'delayed/backend/mongo_mapper'
+
+describe Delayed::Backend::MongoMapper::Job do
+  before(:all) do
+    @backend = Delayed::Backend::MongoMapper::Job
+  end
+  
+  before(:each) do
+    MongoMapper.database.collections.each(&:remove)
+  end
+  
+  it_should_behave_like 'a backend'
+
+  describe "indexes" do
+    it "should have combo index on priority and run_at" do
+      @backend.collection.index_information.detect { |index| index[0] == 'priority_1_run_at_1' }.should_not be_nil
+    end
+
+    it "should have index on locked_by" do
+      @backend.collection.index_information.detect { |index| index[0] == 'locked_by_1' }.should_not be_nil
+    end
+  end
+  
+  describe "delayed method" do
+    class MongoStoryReader
+      def read(story)
+        "Epilog: #{story.tell}"
+      end
+    end
+    
+    class MongoStory
+      include ::MongoMapper::Document
+      key :text, String
+      
+      def tell
+        text
+      end
+    end
+    
+    it "should ignore not found errors because they are permanent" do
+      story = MongoStory.create :text => 'Once upon a time...'
+      job = story.delay.tell
+      story.destroy
+      lambda { job.invoke_job }.should_not raise_error
+    end
+
+    it "should store the object as string" do
+      story = MongoStory.create :text => 'Once upon a time...'
+      job = story.delay.tell
+
+      job.payload_object.class.should   == Delayed::PerformableMethod
+      job.payload_object.object.should  == story
+      job.payload_object.method.should  == :tell
+      job.payload_object.args.should    == []
+      job.payload_object.perform.should == 'Once upon a time...'
+    end
+
+    it "should store arguments as string" do
+      story = MongoStory.create :text => 'Once upon a time...'
+      job = MongoStoryReader.new.delay.read(story)
+      job.payload_object.class.should   == Delayed::PerformableMethod
+      job.payload_object.method.should  == :read
+      job.payload_object.args.should    == [story]
+      job.payload_object.perform.should == 'Epilog: Once upon a time...'
+    end
+  end
+  
+  describe "before_fork" do
+    after do
+      MongoMapper.connection.connect_to_master
+    end
+    
+    it "should disconnect" do
+      lambda do
+        Delayed::Backend::MongoMapper::Job.before_fork
+      end.should change { !!MongoMapper.connection.connected? }.from(true).to(false)
+    end
+  end
+
+  describe "after_fork" do
+    before do
+      MongoMapper.connection.close
+    end
+    
+    it "should call reconnect" do
+      lambda do
+        Delayed::Backend::MongoMapper::Job.after_fork
+      end.should change { !!MongoMapper.connection.connected? }.from(false).to(true)
+    end
+  end
+  
+end

data/spec/backend/shared_backend_spec.rb

@@ -0,0 +1,280 @@
+class NamedJob < Struct.new(:perform)
+  def display_name
+    'named_job'
+  end
+end
+
+shared_examples_for 'a backend' do
+  def create_job(opts = {})
+    @backend.create(opts.merge(:payload_object => SimpleJob.new, :queue => Delayed::Worker.queue))
+  end
+
+  before do
+    # Delayed::Worker.queue  must be defined
+    Delayed::Worker.max_priority = nil
+    Delayed::Worker.min_priority = nil
+    Delayed::Worker.default_priority = 99
+    SimpleJob.runs = 0
+  end
+  
+  it "should set run_at automatically if not set" do
+    @backend.create(:payload_object => ErrorJob.new ).run_at.should_not be_nil
+  end
+
+  it "should not set run_at automatically if already set" do
+    later = @backend.db_time_now + 5.minutes
+    @backend.create(:payload_object => ErrorJob.new, :run_at => later).run_at.should be_close(later, 1)
+  end
+
+  it "should raise ArgumentError when handler doesn't respond_to :perform" do
+    lambda { @backend.enqueue(Object.new) }.should raise_error(ArgumentError)
+  end
+
+  it "should increase count after enqueuing items" do
+    @backend.enqueue SimpleJob.new
+    @backend.count.should == 1
+  end
+  
+  it "should be able to set priority when enqueuing items" do
+    @job = @backend.enqueue SimpleJob.new, 5
+    @job.priority.should == 5
+  end
+
+  it "should use default priority when it is not set" do
+    @job = @backend.enqueue SimpleJob.new
+    @job.priority.should == 99
+  end
+
+  it "should be able to set run_at when enqueuing items" do
+    later = @backend.db_time_now + 5.minutes
+    @job = @backend.enqueue SimpleJob.new, 5, later
+    @job.run_at.should be_close(later, 1)
+  end
+
+  it "should work with jobs in modules" do
+    M::ModuleJob.runs = 0
+    job = @backend.enqueue M::ModuleJob.new
+    lambda { job.invoke_job }.should change { M::ModuleJob.runs }.from(0).to(1)
+  end
+  
+  describe "payload_object" do
+    it "should raise a DeserializationError when the job class is totally unknown" do
+      job = @backend.new :handler => "--- !ruby/object:JobThatDoesNotExist {}"
+      lambda { job.payload_object }.should raise_error(Delayed::Backend::DeserializationError)
+    end
+
+    it "should raise a DeserializationError when the job struct is totally unknown" do
+      job = @backend.new :handler => "--- !ruby/struct:StructThatDoesNotExist {}"
+      lambda { job.payload_object }.should raise_error(Delayed::Backend::DeserializationError)
+    end
+    
+    it "should autoload classes that are unknown at runtime" do
+      job = @backend.new :handler => "--- !ruby/object:Autoloaded::Clazz {}"
+      lambda { job.payload_object }.should_not raise_error(Delayed::Backend::DeserializationError)
+    end
+
+    it "should autoload structs that are unknown at runtime" do
+      job = @backend.new :handler => "--- !ruby/struct:Autoloaded::Struct {}"
+      lambda { job.payload_object }.should_not raise_error(Delayed::Backend::DeserializationError)
+    end
+  end
+  
+  describe "find_available" do
+    it "should not find failed jobs" do
+      @job = create_job :attempts => 50, :failed_at => @backend.db_time_now
+      @backend.find_available('worker', 5, 1.second).should_not include(@job)
+    end
+    
+    it "should not find jobs scheduled for the future" do
+      @job = create_job :run_at => (@backend.db_time_now + 1.minute)
+      @backend.find_available('worker', 5, 4.hours).should_not include(@job)
+    end
+    
+    it "should not find jobs locked by another worker" do
+      @job = create_job(:locked_by => 'other_worker', :locked_at => @backend.db_time_now - 1.minute)
+      @backend.find_available('worker', 5, 4.hours).should_not include(@job)
+    end
+    
+    it "should find open jobs" do
+      @job = create_job
+      @backend.find_available('worker', 5, 4.hours).should include(@job)
+    end
+    
+    it "should find expired jobs" do
+      @job = create_job(:locked_by => 'worker', :locked_at => @backend.db_time_now - 2.minutes)
+      @backend.find_available('worker', 5, 1.minute).should include(@job)
+    end
+    
+    it "should find own jobs" do
+      @job = create_job(:locked_by => 'worker', :locked_at => (@backend.db_time_now - 1.minutes))
+      @backend.find_available('worker', 5, 4.hours).should include(@job)
+    end
+
+    it "should find only the right amount of jobs" do
+      10.times { create_job }
+      @backend.find_available('worker', 7, 4.hours).should have(7).jobs
+    end
+  end
+  
+  context "when another worker is already performing an task, it" do
+
+    before :each do
+      @job = @backend.create :payload_object => SimpleJob.new, :locked_by => 'worker1', :locked_at => @backend.db_time_now - 5.minutes, :queue => Delayed::Worker.queue
+    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
+      @backend.find_available('worker2', 1, 6.minutes).length.should == 0
+    end
+
+    it "should be found by another worker if the time has expired" do
+      @backend.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 = @backend.create :payload_object => SimpleJob.new
+      @job_copy_for_worker_2 = @backend.find(@job.id)
+    end
+
+    it "should not allow a second worker to get exclusive access if already successfully processed by worker1" do
+      @job.destroy
+      @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
+      @backend.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
+      job = @backend.new(:payload_object => NamedJob.new)
+      job.name.should == 'named_job'
+    end
+
+    it "should be the instance method that will be called if its a performable method object" do
+      @job = Story.create(:text => "...").delay.save
+      @job.name.should == 'Story#save'
+    end
+  end
+  
+  context "worker prioritization" do
+    before(:each) do
+      Delayed::Worker.max_priority = nil
+      Delayed::Worker.min_priority = nil
+    end
+
+    it "should fetch jobs ordered by priority" do
+      10.times { @backend.enqueue SimpleJob.new, rand(10), Delayed::Worker.queue }
+      jobs = @backend.find_available('worker', 10)
+      jobs.size.should == 10
+      jobs.each_cons(2) do |a, b| 
+        a.priority.should <= b.priority
+      end
+    end
+
+    it "should only find jobs greater than or equal to min priority" do
+      min = 5
+      Delayed::Worker.min_priority = min
+      10.times {|i| @backend.enqueue SimpleJob.new, i }
+      jobs = @backend.find_available('worker', 10)
+      jobs.each {|job| job.priority.should >= min}
+    end
+
+    it "should only find jobs less than or equal to max priority" do
+      max = 5
+      Delayed::Worker.max_priority = max
+      10.times {|i| @backend.enqueue SimpleJob.new, i }
+      jobs = @backend.find_available('worker', 10)
+      jobs.each {|job| job.priority.should <= max}
+    end
+  end
+  
+  context "clear_locks!" do
+    before do
+      @job = create_job(:locked_by => 'worker', :locked_at => @backend.db_time_now)
+    end
+    
+    it "should clear locks for the given worker" do
+      @backend.clear_locks!('worker')
+      @backend.find_available('worker2', 5, 1.minute).should include(@job)
+    end
+    
+    it "should not clear locks for other workers" do
+      @backend.clear_locks!('worker1')
+      @backend.find_available('worker1', 5, 1.minute).should_not include(@job)
+    end
+  end
+  
+  context "unlock" do
+    before do
+      @job = create_job(:locked_by => 'worker', :locked_at => @backend.db_time_now)
+    end
+
+    it "should clear locks" do
+      @job.unlock
+      @job.locked_by.should be_nil
+      @job.locked_at.should be_nil
+    end
+  end
+  
+  context "large handler" do
+    before do
+      text = "Lorem ipsum dolor sit amet. " * 1000
+      @job = @backend.enqueue Delayed::PerformableMethod.new(text, :length, {})
+    end
+    
+    it "should have an id" do
+      @job.id.should_not be_nil
+    end
+  end
+
+  describe "yaml serialization" do
+    it "should reload changed attributes" do
+      job = @backend.enqueue SimpleJob.new
+      yaml = job.to_yaml
+      job.priority = 99
+      job.save
+      YAML.load(yaml).priority.should == 99
+    end
+
+    it "should ignore destroyed records" do
+      job = @backend.enqueue SimpleJob.new
+      yaml = job.to_yaml
+      job.destroy
+      lambda { YAML.load(yaml).should be_nil }.should_not raise_error
+    end
+  end
+
+end

data/spec/message_sending_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Delayed::MessageSending do
+  describe "handle_asynchronously" do
+    class Story < ActiveRecord::Base
+      def tell!(arg)
+      end
+      handle_asynchronously :tell!
+    end
+    
+    it "should alias original method" do
+      Story.new.should respond_to(:tell_without_delay!)
+      Story.new.should respond_to(:tell_with_delay!)
+    end
+    
+    it "should create a PerformableMethod" do
+      story = Story.create!
+      lambda {
+        job = story.tell!(1)
+        job.payload_object.class.should   == Delayed::PerformableMethod
+        job.payload_object.method.should  == :tell_without_delay!
+        job.payload_object.args.should    == [1]
+      }.should change { Delayed::Job.count }
+    end
+  end
+
+  context "delay" do
+    it "should create a new PerformableMethod job" do
+      lambda {
+        job = "hello".delay.count('l')
+        job.payload_object.class.should   == Delayed::PerformableMethod
+        job.payload_object.method.should  == :count
+        job.payload_object.args.should    == ['l']
+      }.should change { Delayed::Job.count }.by(1)
+    end
+
+    it "should set default priority" do
+      Delayed::Worker.default_priority = 99
+      job = Object.delay.to_s
+      job.priority.should == 99
+      Delayed::Worker.default_priority = 0
+    end
+
+    it "should set job options" do
+      run_at = Time.parse('2010-05-03 12:55 AM')
+      job = Object.delay(:priority => 20, :run_at => run_at).to_s
+      job.run_at.should == run_at
+      job.priority.should == 20
+    end
+  end
+end

data/spec/performable_method_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Delayed::PerformableMethod do
+  describe "perform" do
+    before do
+      @method = Delayed::PerformableMethod.new("foo", :count, ['o'])
+    end
+    
+    context "with the persisted record cannot be found" do
+      before do
+        @method.object = nil
+      end
+    
+      it "should be a no-op if object is nil" do
+        lambda { @method.perform }.should_not raise_error
+      end
+    end
+    
+    it "should call the method on the object" do
+      @method.object.should_receive(:count).with('o')
+      @method.perform
+    end
+    
+    it "should respond to on_permanent_failure when implemented and target object is called via object.delay.do_something" do
+      @method = Delayed::PerformableMethod.new(OnPermanentFailureJob.new, :perform, [])
+      @method.respond_to?(:on_permanent_failure).should be_true
+      @method.object.should_receive(:on_permanent_failure)
+      @method.on_permanent_failure
+    end    
+  end
+
+  it "should raise a NoMethodError if target method doesn't exist" do
+    lambda {
+      Delayed::PerformableMethod.new(Object, :method_that_does_not_exist, [])
+    }.should raise_error(NoMethodError)
+  end
+  
+  it "should not raise NoMethodError if target method is private" do
+    clazz = Class.new do
+      def private_method
+      end
+      private :private_method
+    end
+    lambda {
+      Delayed::PerformableMethod.new(clazz.new, :private_method, [])
+    }.should_not raise_error(NoMethodError)
+  end
+end

data/spec/sample_jobs.rb

@@ -0,0 +1,25 @@
+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
+
+class OnPermanentFailureJob < SimpleJob
+  def on_permanent_failure
+  end
+end
+
+module M
+  class ModuleJob
+    cattr_accessor :runs; self.runs = 0
+    def perform; @@runs += 1; end    
+  end
+end

data/spec/setup/active_record.rb

@@ -0,0 +1,54 @@
+require 'active_record'
+
+#ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => 'test.sql3')
+ActiveRecord::Base.logger = Delayed::Worker.logger
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :delayed_jobs, :force => true do |table|
+    table.integer  :priority, :default => 0
+    table.integer  :attempts, :default => 0
+    table.column   :handler,  :mediumtext
+    table.text     :last_error
+    table.datetime :run_at
+    table.datetime :locked_at
+    table.datetime :failed_at
+    table.string   :locked_by
+    table.string   :queue, :limit => 255, :null => false, :default => Delayed::DEFAULT_QUEUE
+    table.timestamps
+  end
+
+=begin
+CREATE TABLE `delayed_jobs` (
+  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
+  `priority` int(11) DEFAULT '0',
+  `attempts` int(11) DEFAULT '0',
+  `handler` mediumtext COLLATE utf8_unicode_ci,
+  `last_error` text COLLATE utf8_unicode_ci,
+  `run_at` datetime DEFAULT NULL,
+  `locked_at` datetime DEFAULT NULL,
+  `failed_at` datetime DEFAULT NULL,
+  `locked_by` varchar(128) COLLATE utf8_unicode_ci DEFAULT NULL,
+  `queue` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '',
+  `created_at` datetime DEFAULT NULL,
+  `updated_at` datetime DEFAULT NULL,
+  PRIMARY KEY (`id`),
+  KEY `index_delayed_jobs_on_queue_and_locked_by` (`queue`,`locked_by`)
+) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
+=end
+
+  add_index :delayed_jobs, [:priority, :run_at], :name => 'delayed_jobs_priority'
+
+  create_table :stories, :force => true do |table|
+    table.string :text
+  end
+end
+
+# Purely useful for test cases...
+class Story < ActiveRecord::Base
+  def tell; text; end       
+  def whatever(n, _); tell*n; end
+  
+  handle_asynchronously :whatever
+end

data/spec/setup/couch_rest.rb

@@ -0,0 +1,7 @@
+require 'couchrest'
+require 'delayed/backend/couch_rest'
+
+Delayed::Backend::CouchRest::Job.use_database CouchRest::Server.new.database!('delayed_job_spec')
+
+# try to perform a query to check that we can connect
+Delayed::Backend::CouchRest::Job.all

data/spec/setup/data_mapper.rb

@@ -0,0 +1,8 @@
+require 'dm-core'
+require 'dm-validations'
+
+require 'delayed/backend/data_mapper'
+
+DataMapper.logger = Delayed::Worker.logger
+DataMapper.setup(:default, "sqlite3::memory:")
+DataMapper.auto_migrate!

data/spec/setup/mongo_mapper.rb

@@ -0,0 +1,17 @@
+require 'mongo_mapper'
+
+MongoMapper.config = {
+  RAILS_ENV => {'database' => 'delayed_job'}
+}
+MongoMapper.connect RAILS_ENV
+
+unless defined?(Story)
+  class Story
+    include ::MongoMapper::Document
+    def tell; text; end       
+    def whatever(n, _); tell*n; end
+    def self.count; end
+  
+    handle_asynchronously :whatever
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'spec'
+require 'logger'
+
+gem 'rails', '~>2.3.5'
+
+require 'delayed_job'
+require 'sample_jobs'
+
+Delayed::Worker.logger = Logger.new('/tmp/dj.log')
+RAILS_ENV = 'test'
+
+# determine the available backends
+BACKENDS = []
+Dir.glob("#{File.dirname(__FILE__)}/setup/*.rb") do |backend|
+  begin
+    backend = File.basename(backend, '.rb')
+    require "setup/#{backend}"
+    require "backend/#{backend}_job_spec"
+    BACKENDS << backend.to_sym
+  rescue Exception
+    puts "Unable to load #{backend} backend: #{$!}"
+  end
+end
+
+Delayed::Worker.backend = BACKENDS.first
+
+# Add this directory so the ActiveSupport autoloading works
+ActiveSupport::Dependencies.load_paths << File.dirname(__FILE__)