activejob-retry 0.0.1 → 0.1.1

data/test/helper.rb

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler.setup
+
+require 'active_job'
+require 'support/job_buffer'
+
+GlobalID.app = 'aj'
+
+@adapter  = ENV['AJADAPTER'] || 'resque'
+
+if ENV['AJ_INTEGRATION_TESTS']
+  require 'support/integration/helper'
+else
+  require "adapters/#{@adapter}"
+end
+
+require 'active_job/retry'
+
+require 'active_support/testing/autorun'
+
+ActiveSupport::TestCase.test_order = :random

data/test/integration/queuing_test.rb

@@ -0,0 +1,46 @@
+require 'helper'
+require 'jobs/logging_job'
+require 'active_support/core_ext/numeric/time'
+
+class QueuingTest < ActiveSupport::TestCase
+  test 'should run jobs enqueued on a listening queue' do
+    TestJob.perform_later @id
+    wait_for_jobs_to_finish_for(5.seconds)
+    assert job_executed
+  end
+
+  test 'should not run jobs queued on a non-listening queue' do
+    old_queue = TestJob.queue_name
+
+    begin
+      TestJob.queue_as :some_other_queue
+      TestJob.perform_later @id
+      wait_for_jobs_to_finish_for(2.seconds)
+      assert_not job_executed
+    ensure
+      TestJob.queue_name = old_queue
+    end
+  end
+
+  test 'should not run job enqueued in the future' do
+    TestJob.set(wait: 10.minutes).perform_later @id
+    wait_for_jobs_to_finish_for(5.seconds)
+    assert_not job_executed
+  end
+
+  test 'should run job enqueued in the future at the specified time' do
+    TestJob.set(wait: 3.seconds).perform_later @id
+    wait_for_jobs_to_finish_for(2.seconds)
+    assert_not job_executed
+    wait_for_jobs_to_finish_for(10.seconds)
+    assert job_executed
+  end
+
+  test 'should retry when the job fails' do
+    TestJob.perform_later @id, true
+    wait_for_jobs_to_finish_for(2.seconds)
+    assert_not job_executed
+    wait_for_jobs_to_finish_for(5.seconds)
+    assert job_executed
+  end
+end

data/test/jobs/callback_job.rb

@@ -0,0 +1,31 @@
+class CallbackJob < ActiveJob::Base
+  include ActiveJob::Retry
+
+  before_perform ->(job) { job.history << "CallbackJob ran before_perform" }
+  after_perform ->(job) { job.history << "CallbackJob ran after_perform" }
+
+  before_enqueue ->(job) { job.history << "CallbackJob ran before_enqueue" }
+  after_enqueue ->(job) { job.history << "CallbackJob ran after_enqueue" }
+
+  around_perform do |job, block|
+    job.history << "CallbackJob ran around_perform_start"
+    block.call
+    job.history << "CallbackJob ran around_perform_stop"
+  end
+
+  around_enqueue do |job, block|
+    job.history << "CallbackJob ran around_enqueue_start"
+    block.call
+    job.history << "CallbackJob ran around_enqueue_stop"
+  end
+
+
+  def perform(person = "david")
+    # NOTHING!
+  end
+
+  def history
+    @history ||= []
+  end
+
+end

data/test/jobs/gid_job.rb

@@ -0,0 +1,10 @@
+require_relative '../support/job_buffer'
+
+class GidJob < ActiveJob::Base
+  include ActiveJob::Retry
+
+  def perform(person)
+    JobBuffer.add("Person with ID: #{person.id}")
+  end
+end
+

data/test/jobs/hello_job.rb

@@ -0,0 +1,9 @@
+require_relative '../support/job_buffer'
+
+class HelloJob < ActiveJob::Base
+  include ActiveJob::Retry
+
+  def perform(greeter = "David")
+    JobBuffer.add("#{greeter} says hello")
+  end
+end

data/test/jobs/logging_job.rb

@@ -0,0 +1,12 @@
+class LoggingJob < ActiveJob::Base
+  include ActiveJob::Retry
+
+  def perform(dummy)
+    logger.info "Dummy, here is it: #{dummy}"
+  end
+
+  def job_id
+    "LOGGING-JOB-ID"
+  end
+end
+

data/test/jobs/nested_job.rb

@@ -0,0 +1,12 @@
+class NestedJob < ActiveJob::Base
+  include ActiveJob::Retry
+
+  def perform
+    LoggingJob.perform_later "NestedJob"
+  end
+
+  def job_id
+    "NESTED-JOB-ID"
+  end
+end
+

data/test/jobs/rescue_job.rb

@@ -0,0 +1,31 @@
+require_relative '../support/job_buffer'
+
+class RescueJob < ActiveJob::Base
+  include ActiveJob::Retry
+  constant_retry limit: 2, delay: 0
+
+  class OtherError < StandardError; end
+
+  rescue_from(ArgumentError) do
+    JobBuffer.add('rescued from ArgumentError')
+    arguments[0] = "DIFFERENT!"
+    retry_job
+  end
+
+  rescue_from(ActiveJob::DeserializationError) do |e|
+    JobBuffer.add('rescued from DeserializationError')
+    JobBuffer.add("DeserializationError original exception was #{e.original_exception.class.name}")
+  end
+
+  def perform(person = "david")
+    JobBuffer.add('running')
+    case person
+    when "david"
+      raise ArgumentError, "Hair too good"
+    when "other"
+      raise OtherError
+    else
+      JobBuffer.add('performed beautifully')
+    end
+  end
+end

data/test/models/person.rb

@@ -0,0 +1,20 @@
+class Person
+  class RecordNotFound < StandardError; end
+
+  include GlobalID::Identification
+
+  attr_reader :id
+
+  def self.find(id)
+    raise RecordNotFound.new("Cannot find person with ID=404") if id.to_i==404
+    new(id)
+  end
+
+  def initialize(id)
+    @id = id
+  end
+
+  def ==(other_person)
+    other_person.is_a?(Person) && id.to_s == other_person.id.to_s
+  end
+end

data/test/support/backburner/inline.rb

@@ -0,0 +1,8 @@
+require 'backburner'
+
+Backburner::Worker.class_eval do
+  class << self; alias_method :original_enqueue, :enqueue; end
+  def self.enqueue(job_class, args=[], opts={})
+    job_class.perform(*args)
+  end
+end

data/test/support/delayed_job/delayed/backend/test.rb

@@ -0,0 +1,111 @@
+#copied from https://github.com/collectiveidea/delayed_job/blob/master/spec/delayed/backend/test.rb
+require 'ostruct'
+
+# An in-memory backend suitable only for testing. Tries to behave as if it were an ORM.
+module Delayed
+  module Backend
+    module Test
+      class Job
+        attr_accessor :id
+        attr_accessor :priority
+        attr_accessor :attempts
+        attr_accessor :handler
+        attr_accessor :last_error
+        attr_accessor :run_at
+        attr_accessor :locked_at
+        attr_accessor :locked_by
+        attr_accessor :failed_at
+        attr_accessor :queue
+
+        include Delayed::Backend::Base
+
+        cattr_accessor :id
+        self.id = 0
+
+        def initialize(hash = {})
+          self.attempts = 0
+          self.priority = 0
+          self.id = (self.class.id += 1)
+          hash.each{|k,v| send(:"#{k}=", v)}
+        end
+
+        @jobs = []
+        def self.all
+          @jobs
+        end
+
+        def self.count
+          all.size
+        end
+
+        def self.delete_all
+          all.clear
+        end
+
+        def self.create(attrs = {})
+          new(attrs).tap(&:save)
+        end
+
+        def self.create!(*args); create(*args); end
+
+        def self.clear_locks!(worker_name)
+          all.select{|j| j.locked_by == worker_name}.each {|j| j.locked_by = nil; j.locked_at = nil}
+        end
+
+        # Find a few candidate jobs to run (in case some immediately get locked by others).
+        def self.find_available(worker_name, limit = 5, max_run_time = Worker.max_run_time)
+          jobs = all.select do |j|
+            j.run_at <= db_time_now &&
+            (j.locked_at.nil? || j.locked_at < db_time_now - max_run_time || j.locked_by == worker_name) &&
+            !j.failed?
+          end
+
+          jobs = jobs.select{|j| Worker.queues.include?(j.queue)}   if Worker.queues.any?
+          jobs = jobs.select{|j| j.priority >= Worker.min_priority} if Worker.min_priority
+          jobs = jobs.select{|j| j.priority <= Worker.max_priority} if Worker.max_priority
+          jobs.sort_by{|j| [j.priority, j.run_at]}[0..limit-1]
+        end
+
+        # Lock this job for this worker.
+        # Returns true if we have the lock, false otherwise.
+        def lock_exclusively!(max_run_time, worker)
+          now = self.class.db_time_now
+          if locked_by != worker
+            # We don't own this job so we will update the locked_by name and the locked_at
+            self.locked_at = now
+            self.locked_by = worker
+          end
+
+          return true
+        end
+
+        def self.db_time_now
+          Time.current
+        end
+
+        def update_attributes(attrs = {})
+          attrs.each{|k,v| send(:"#{k}=", v)}
+          save
+        end
+
+        def destroy
+          self.class.all.delete(self)
+        end
+
+        def save
+          self.run_at ||= Time.current
+
+          self.class.all << self unless self.class.all.include?(self)
+          true
+        end
+
+        def save!; save; end
+
+        def reload
+          reset
+          self
+        end
+      end
+    end
+  end
+end

data/test/support/integration/adapters/backburner.rb

@@ -0,0 +1,38 @@
+module BackburnerJobsManager
+  def setup
+    ActiveJob::Base.queue_adapter = :backburner
+    Backburner.configure do |config|
+      config.logger = Rails.logger
+    end
+    unless can_run?
+      puts "Cannot run integration tests for backburner. To be able to run integration tests for backburner you need to install and start beanstalkd.\n"
+      exit
+    end
+  end
+
+  def clear_jobs
+    tube.clear
+  end
+
+  def start_workers
+    @thread = Thread.new { Backburner.work "integration-tests" } # backburner dasherizes the queue name
+  end
+
+  def stop_workers
+    @thread.kill
+  end
+
+  def tube
+    @tube ||= Beaneater::Tube.new(Backburner::Worker.connection, "backburner.worker.queue.integration-tests") # backburner dasherizes the queue name
+  end
+
+  def can_run?
+    begin
+      Backburner::Worker.connection.send :connect!
+    rescue
+      return false
+    end
+    true
+  end
+end
+

data/test/support/integration/adapters/delayed_job.rb

@@ -0,0 +1,20 @@
+require 'delayed_job'
+require 'delayed_job_active_record'
+
+module DelayedJobJobsManager
+  def setup
+    ActiveJob::Base.queue_adapter = :delayed_job
+  end
+  def clear_jobs
+    Delayed::Job.delete_all
+  end
+
+  def start_workers
+    @worker = Delayed::Worker.new(quiet: true, sleep_delay: 0.5, queues: %w(integration_tests))
+    @thread = Thread.new { @worker.start }
+  end
+
+  def stop_workers
+    @worker.stop
+  end
+end

data/test/support/integration/adapters/que.rb

@@ -0,0 +1,37 @@
+module QueJobsManager
+  def setup
+    require 'sequel'
+    ActiveJob::Base.queue_adapter = :que
+    que_url = ENV['QUE_DATABASE_URL'] || 'postgres:///dummy_test'
+    uri = URI.parse(que_url)
+    user = uri.user||ENV['USER']
+    pass = uri.password
+    db   = uri.path[1..-1]
+    %x{#{"PGPASSWORD=\"#{pass}\"" if pass} psql -c 'drop database if exists "#{db}"' -U #{user} -t template1}
+    %x{#{"PGPASSWORD=\"#{pass}\"" if pass} psql -c 'create database "#{db}"' -U #{user} -t template1}
+    Que.connection = Sequel.connect(que_url)
+    Que.migrate!
+    Que.mode = :off
+    Que.worker_count = 1
+  rescue Sequel::DatabaseConnectionError
+    puts "Cannot run integration tests for que. To be able to run integration tests for que you need to install and start postgresql.\n"
+    exit
+  end
+
+  def clear_jobs
+    Que.clear!
+  end
+
+  def start_workers
+    @thread = Thread.new do
+      loop do
+        Que::Job.work("integration_tests")
+        sleep 0.5
+      end
+    end
+  end
+
+  def stop_workers
+    @thread.kill
+  end
+end

data/test/support/integration/adapters/resque.rb

@@ -0,0 +1,49 @@
+module ResqueJobsManager
+  def setup
+    ActiveJob::Base.queue_adapter = :resque
+    Resque.redis = Redis::Namespace.new 'active_jobs_int_test', redis: Redis.connect(url: "redis://127.0.0.1:6379/12", :thread_safe => true)
+    Resque.logger = Rails.logger
+    unless can_run?
+      puts "Cannot run integration tests for resque. To be able to run integration tests for resque you need to install and start redis.\n"
+      exit
+    end
+  end
+
+  def clear_jobs
+    Resque.queues.each { |queue_name| Resque.redis.del "queue:#{queue_name}" }
+    Resque.redis.keys("delayed:*").each  { |key| Resque.redis.del "#{key}" }
+    Resque.redis.del "delayed_queue_schedule"
+  end
+
+  def start_workers
+    @resque_thread = Thread.new do
+      w = Resque::Worker.new("integration_tests")
+      w.term_child = true
+      w.work(0.5)
+    end
+    @scheduler_thread = Thread.new do
+      Resque::Scheduler.configure do |c|
+        c.poll_sleep_amount = 0.5
+        c.dynamic = true
+        c.quiet = true
+        c.logfile = nil
+      end
+      Resque::Scheduler.master_lock.release!
+      Resque::Scheduler.run
+    end
+  end
+
+  def stop_workers
+    @resque_thread.kill
+    @scheduler_thread.kill
+  end
+
+  def can_run?
+    begin
+      Resque.redis.client.connect
+    rescue
+      return false
+    end
+    true
+  end
+end