resque-workers-lock 1.3 → 1.4

data/Rakefile

@@ -1,3 +1,5 @@
+require 'resque/tasks'
+
 require 'rake/testtask'
 require 'rdoc/task'
 

data/lib/resque/plugins/workers/lock.rb

@@ -1,42 +1,44 @@
+require 'resque'
+
 module Resque
   alias_method :orig_remove_queue, :remove_queue
-  
+
   def remove_queue(queue)
     Resque.redis.keys('enqueuelock:*').collect { |x| Resque.redis.del(x) }.count
     Resque.redis.keys('workerslock:*').collect { |x| Resque.redis.del(x) }.count
-    
+
     orig_remove_queue(queue)
   end
-  
+
   module Plugins
     module Workers
       module Lock
-        
+
         # Override in your job to control the queue lock key
         def lock_enqueue(*args)
           "#{name}-#{args.to_s}"
         end
-        
+
         def get_lock_enqueue(*args)
           "enqueuelock:"+lock_enqueue(*args).to_s
         end
-        
+
         # Override in your job to control the workers lock key.
         def lock_workers(*args)
           "#{name}-#{args.to_s}"
         end
-        
+
         def get_lock_workers(*args)
           "workerslock:"+lock_workers(*args).to_s
         end
-        
+
         # Override in your job to change the perform requeue delay
         def requeue_perform_delay
           1.0
         end
-        
-        
-        # Called with the job args before a job is placed on the queue. 
+
+
+        # Called with the job args before a job is placed on the queue.
         # If the hook returns false, the job will not be placed on the queue.
         def before_enqueue_lock(*args)
           if lock_enqueue(*args) == false
@@ -45,8 +47,8 @@ module Resque
             return Resque.redis.setnx(get_lock_enqueue(*args), true)
           end
         end
-        
-        # Called with the job args before perform. 
+
+        # Called with the job args before perform.
         # If it raises Resque::Job::DontPerform, the job is aborted.
         def before_perform_lock(*args)
           if lock_workers(*args)
@@ -59,12 +61,12 @@ module Resque
             end
           end
         end
-        
+
         def after_dequeue_lock(*args)
           # Clear the lock when dequeueed
           Resque.redis.del(get_lock_enqueue(*args))
         end
-      
+
         def around_perform_lock(*args)
           begin
             yield
@@ -74,14 +76,14 @@ module Resque
             Resque.redis.del(get_lock_enqueue(*args))
           end
         end
-        
+
         def on_failure_lock(exception, *args)
           # Clear the lock on DirtyExit
           Resque.redis.del(get_lock_workers(*args))
           Resque.redis.del(get_lock_enqueue(*args))
         end
-        
+
       end
     end
   end
-end
+end

data/test/lock_test.rb

@@ -1,9 +1,6 @@
 require 'test/unit'
-require 'resque'
 require 'resque/plugins/workers/lock'
 
-$counter = 0
-
 class LockTest < Test::Unit::TestCase
   class SimilarJob
     extend Resque::Plugins::Workers::Lock
@@ -13,19 +10,19 @@ class LockTest < Test::Unit::TestCase
       raise "Woah woah! How did this happen?"
     end
   end
-  
+
   class UniqueJob
     extend Resque::Plugins::Workers::Lock
     @queue = :lock_test
-    
+
     def self.lock_enqueue(id)
       return id.to_s+"e"
     end
-    
+
     def self.lock_workers(id)
       return id.to_s+"w"
     end
-    
+
     def self.perform(id)
       raise "Woah woah! How did this happen?"
     end
@@ -43,46 +40,74 @@ class LockTest < Test::Unit::TestCase
     end
   end
 
-  def test_version
-    major, minor, patch = Resque::Version.split('.')
-    assert_equal 1, major.to_i
-    assert minor.to_i >= 17
-    assert Resque::Plugin.respond_to?(:before_enqueue_hooks)
-  end
-
   def test_enqueue
     3.times { Resque.enqueue(SimilarJob) }
 
     assert_equal "LockTest::SimilarJob-[]", SimilarJob.lock_workers
     assert_equal "LockTest::SimilarJob-[]", SimilarJob.lock_enqueue
     assert_equal 1, Resque.redis.llen('queue:lock_test')
-    
+
     3.times do |i|
       Resque.enqueue(UniqueJob, i+100)
       assert_equal i.to_s+"e", UniqueJob.lock_enqueue(i)
       assert_equal i.to_s+"w", UniqueJob.lock_workers(i)
     end
-    
+
     assert_equal 4, Resque.redis.llen('queue:lock_test')
-    
+
     # Test for complete queue wipe
     Resque.remove_queue(:lock_test)
-    
+
     Resque.enqueue(SimilarJob)
     assert_equal 1, Resque.redis.llen('queue:lock_test')
   end
-  
+
   def test_zcleanup
     Resque.remove_queue(:lock_test)
-    
-    Resque.redis.keys('enqueuelock:*').collect { |x| Resque.redis.del(x) }.count
-    Resque.redis.keys('workerslock:*').collect { |x| Resque.redis.del(x) }.count
-    
+
+    Resque.redis.keys('enqueuelock:*').collect { |x| Resque.redis.del(x) }
+    Resque.redis.keys('workerslock:*').collect { |x| Resque.redis.del(x) }
+
     assert_equal 0, Resque.redis.llen('queue:lock_test')
   end
-  
+
+  # Sleep job, for testing that two workers are not processing two jobs with
+  # the same lock.
+  class SimilarSleepJob
+    extend Resque::Plugins::Workers::Lock
+    @queue = :lock_test_workers
+
+    def self.lock_enqueue(id)
+      false
+    end
+
+    def self.lock_workers(id)
+      return id.to_s
+    end
+
+    def self.perform(id)
+      File.open('test/test.txt', 'a') {|f| f.write('1') }
+      sleep(5)
+    end
+  end
+
+  # To test this, make sure to run `TERM_CHILD=1 COUNT=2 VVERBOSE=1 QUEUES=* rake resque:work`
   def test_lock
-    # TODO: test that two workers are not processing two jobs with same locks
-    # This is pretty hard to do, contributors are welcome!
+    2.times { Resque.enqueue(SimilarSleepJob, 'writing_and_sleeping') }
+    SimilarSleepJob.perform('abc')
+    
+    # After 3 seconds only 1 job had the change of running
+    sleep(3)
+    file = File.open('test/test.txt', 'rb')
+    contents = file.read
+    file.close
+    assert_equal '1', contents
+    
+    # After 12 seconds the 2 jobs should have been processed (not at the same time because of the lock)
+    sleep(12)
+    file = File.open('test/test.txt', 'rb')
+    contents = file.read
+    file.close
+    assert_equal '11', contents
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-workers-lock
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '1.4'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-21 00:00:00.000000000 Z
+date: 2012-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque