onyx-resque-retry 0.1.0

data/test/test_helper.rb

@@ -0,0 +1,78 @@
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+$TESTING = true
+
+require 'test/unit'
+require 'rubygems'
+require 'turn'
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter "/test/"
+end
+
+require 'resque-retry'
+require dir + '/test_jobs'
+
+
+# make sure we can run redis
+if !system("which redis-server")
+  puts '', "** can't find `redis-server` in your path"
+  puts "** try running `sudo rake install`"
+  abort ''
+end
+
+
+# start our own redis when the tests start,
+# kill it when they end
+at_exit do
+  next if $!
+
+  if defined?(MiniTest)
+    exit_code = MiniTest::Unit.new.run(ARGV)
+  else
+    exit_code = Test::Unit::AutoRunner.run
+  end
+
+  pid = `ps -e -o pid,command | grep [r]edis-test`.split(" ")[0]
+  puts "Killing test redis server..."
+  `rm -f #{dir}/dump.rdb`
+  Process.kill("KILL", pid.to_i)
+  exit exit_code
+end
+
+puts "Starting redis for testing at localhost:9736..."
+`redis-server #{dir}/redis-test.conf`
+Resque.redis = '127.0.0.1:9736'
+
+# Mock failure backend for testing MultipleWithRetrySuppression
+class MockFailureBackend < Resque::Failure::Base
+  class << self
+    attr_accessor :errors
+  end
+
+  def save
+    self.class.errors << exception.to_s
+  end
+
+  self.errors = []
+end
+
+# Test helpers
+class Test::Unit::TestCase
+  def perform_next_job(worker, &block)
+    return unless job = @worker.reserve
+    @worker.perform(job, &block)
+    @worker.done_working
+  end
+
+  def clean_perform_job(klass, *args)
+    Resque.redis.flushall
+    Resque.enqueue(klass, *args)
+
+    worker = Resque::Worker.new(:testing)
+    return false unless job = worker.reserve
+    worker.perform(job)
+    worker.done_working
+  end
+end

data/test/test_jobs.rb

@@ -0,0 +1,280 @@
+CustomException = Class.new(StandardError)
+HierarchyCustomException = Class.new(CustomException)
+AnotherCustomException = Class.new(StandardError)
+
+class NoRetryJob
+  @queue = :testing
+
+  def self.perform(*args)
+    raise "error"
+  end
+end
+
+class GoodJob
+  extend Resque::Plugins::Retry
+  @queue = :testing
+  def self.perform(*args)
+  end
+end
+
+class RetryDefaultsJob
+  extend Resque::Plugins::Retry
+  @queue = :testing
+
+  def self.perform(*args)
+    raise
+  end
+end
+
+class JobRetryQueue
+  extend Resque::Plugins::Retry
+  @queue = :testing_retry
+
+  def self.perform(*args)
+  end
+end
+
+class JobWithRetryQueue
+  extend Resque::Plugins::Retry
+  @queue = :testing
+  @retry_job_class = JobRetryQueue
+
+  def self.perform(*args)
+    raise
+  end
+end
+
+class DelayedJobWithRetryQueue
+  extend Resque::Plugins::Retry
+  @queue = :testing
+  @retry_delay = 1
+  @retry_job_class = JobRetryQueue
+
+  def self.perform(*args)
+    raise
+  end
+end
+
+class InheritTestJob < RetryDefaultsJob
+end
+
+class InheritTestWithExtraJob < InheritTestJob
+  retry_criteria_check do |exception, *args|
+    false
+  end
+end
+
+class InheritTestWithMoreExtraJob < InheritTestWithExtraJob
+  retry_criteria_check do |exception, *args|
+    false
+  end
+
+  retry_criteria_check do |exception, *args|
+    false
+  end
+end
+
+class RetryWithModifiedArgsJob < RetryDefaultsJob
+  @queue = :testing
+
+  def self.args_for_retry(*args)
+    args.each { |arg| arg << 'bar' }
+  end
+end
+
+class NeverGiveUpJob < RetryDefaultsJob
+  @queue = :testing
+  @retry_limit = 0
+end
+
+class LimitThreeJob < RetryDefaultsJob
+  @queue = :testing
+  @retry_limit = 3
+
+  def self.perform(*args)
+    raise ArgumentError, "custom message"
+  end
+end
+
+class FailFiveTimesJob < RetryDefaultsJob
+  @queue = :testing
+  @retry_limit = 6
+
+  def self.perform(*args)
+    raise if retry_attempt <= 4
+  end
+end
+
+class ExponentialBackoffJob < RetryDefaultsJob
+  extend Resque::Plugins::ExponentialBackoff
+  @queue = :testing
+end
+
+class CustomExponentialBackoffJob
+  extend Resque::Plugins::ExponentialBackoff
+  @queue = :testing
+
+  @retry_limit = 4
+  @backoff_strategy = [10, 20, 30]
+
+  def self.perform(url, hook_id, hmac_key)
+    raise
+  end
+end
+
+class RetryCustomExceptionsJob < RetryDefaultsJob
+  @queue = :testing
+
+  @retry_limit = 5
+  @retry_exceptions = [CustomException, HierarchyCustomException]
+
+  def self.perform(exception)
+    case exception
+    when 'CustomException' then raise CustomException
+    when 'HierarchyCustomException' then raise HierarchyCustomException
+    when 'AnotherCustomException' then raise AnotherCustomException
+    else raise StandardError
+    end
+  end
+end
+
+module RetryModuleDefaultsJob
+  extend Resque::Plugins::Retry
+  @queue = :testing
+
+  def self.perform(*args)
+    raise
+  end
+end
+
+module RetryModuleCustomRetryCriteriaCheck
+  extend Resque::Plugins::Retry
+  @queue = :testing
+
+  # make sure the retry exceptions check will return false.
+  @retry_exceptions = [CustomException]
+
+  retry_criteria_check do |exception, *args|
+    true
+  end
+
+  def self.perform(*args)
+    raise
+  end
+end
+
+class CustomRetryCriteriaCheckDontRetry < RetryDefaultsJob
+  @queue = :testing
+
+  # make sure the retry exceptions check will return false.
+  @retry_exceptions = [CustomException]
+
+  retry_criteria_check do |exception, *args|
+    false
+  end
+end
+
+class CustomRetryCriteriaCheckDoRetry < CustomRetryCriteriaCheckDontRetry
+  @queue = :testing
+
+  # make sure the retry exceptions check will return false.
+  @retry_exceptions = [CustomException]
+
+  retry_criteria_check do |exception, *args|
+    true
+  end
+end
+
+# A job using multiple custom retry criteria checks.
+# It always fails 2 times.
+class CustomRetryCriteriaCheckMultipleFailTwice
+  extend Resque::Plugins::Retry
+  @retry_limit = 6
+  @queue = :testing
+
+  # make sure we dont retry due to default exception behaviour.
+  @retry_exceptions = []
+
+  retry_criteria_check do |exception, *args|
+    exception.message == 'dont' ? false : true
+  end
+
+  retry_criteria_check do |exception, *args|
+    exception.message == 'do' ? true : false
+  end
+
+  retry_criteria_check do |exception, *args|
+    exception.message == 'do_again' ? true : false
+  end
+
+  def self.perform(msg)
+    if retry_attempt < 2 # always fail twice please.
+      raise StandardError, msg
+    end
+  end
+end
+
+# A job to test whether self.inherited is respected
+# when added by other modules.
+class InheritOrderingJobExtendFirst
+  extend Resque::Plugins::Retry
+
+  retry_criteria_check do |exception, *args|
+    false
+  end
+
+  class << self
+    attr_accessor :test_value
+  end
+
+  def self.inherited(subclass)
+    super(subclass)
+    subclass.test_value = 'test'
+  end
+end
+
+# This job switches to successful after
+# n +tries+.
+class SwitchToSuccessJob < GoodJob
+  @queue = :testing
+  @max_retries = 3
+
+  class << self
+    attr_accessor :successful_after
+    attr_accessor :tries
+
+    def reset_defaults
+      self.tries = 0
+      self.successful_after = 2
+    end
+  end
+
+  reset_defaults
+
+  def self.perform(*args)
+    if self.tries < self.successful_after
+      self.tries += 1
+      raise "error"
+    end
+  end
+end
+
+class InheritOrderingJobExtendLast
+  class << self
+    attr_accessor :test_value
+  end
+
+  def self.inherited(subclass)
+    super(subclass)
+    subclass.test_value = 'test'
+  end
+
+  extend Resque::Plugins::Retry
+
+  retry_criteria_check do |exception, *args|
+    false
+  end
+end
+
+class InheritOrderingJobExtendFirstSubclass < InheritOrderingJobExtendFirst; end
+class InheritOrderingJobExtendLastSubclass < InheritOrderingJobExtendLast; end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification 
+name: onyx-resque-retry
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Onyx Team
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-13 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 1
+        - 8
+        - 0
+        version: 1.8.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: resque-scheduler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 1
+        - 8
+        - 0
+        version: 1.8.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: turn
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: "  resque-retry provides retry, delay and exponential backoff support for\n  resque jobs.\n\n  Features:\n\n  * Redis backed retry count/limit.\n  * Retry on all or specific exceptions.\n  * Exponential backoff (varying the delay between retrys).\n  * Multiple failure backend with retry suppression & resque-web tab.\n  * Small & Extendable - plenty of places to override retry logic/settings.\n"
+email: rob.sweet@ove.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- Rakefile
+- README.md
+- HISTORY.md
+- test/retry_test.rb
+- test/multiple_failure_test.rb
+- test/retry_inheriting_checks_test.rb
+- test/redis-test.conf
+- test/retry_criteria_test.rb
+- test/resque_test.rb
+- test/exponential_backoff_test.rb
+- test/test_helper.rb
+- test/test_jobs.rb
+- lib/resque/failure/multiple_with_retry_suppression.rb
+- lib/resque/plugins/exponential_backoff.rb
+- lib/resque/plugins/retry.rb
+- lib/resque-retry.rb
+- lib/resque-retry/server/views/retry.erb
+- lib/resque-retry/server/views/retry_timestamp.erb
+- lib/resque-retry/server.rb
+has_rdoc: false
+homepage: http://github.com/onyx/resque-retry
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A resque plugin; provides retry, delay and exponential backoff support for resque jobs.
+test_files: []
+