activejob-retry 0.0.1 → 0.1.1

data/test/cases/callbacks_test.rb

@@ -0,0 +1,23 @@
+require 'helper'
+require 'jobs/callback_job'
+
+require 'active_support/core_ext/object/inclusion'
+
+class CallbacksTest < ActiveSupport::TestCase
+  test 'perform callbacks' do
+    performed_callback_job = CallbackJob.new("A-JOB-ID")
+    performed_callback_job.perform_now
+    assert "CallbackJob ran before_perform".in? performed_callback_job.history
+    assert "CallbackJob ran after_perform".in? performed_callback_job.history
+    assert "CallbackJob ran around_perform_start".in? performed_callback_job.history
+    assert "CallbackJob ran around_perform_stop".in? performed_callback_job.history
+  end
+
+  test 'enqueue callbacks' do
+    enqueued_callback_job = CallbackJob.perform_later
+    assert "CallbackJob ran before_enqueue".in? enqueued_callback_job.history
+    assert "CallbackJob ran after_enqueue".in? enqueued_callback_job.history
+    assert "CallbackJob ran around_enqueue_start".in? enqueued_callback_job.history
+    assert "CallbackJob ran around_enqueue_stop".in? enqueued_callback_job.history
+  end
+end

data/test/cases/job_serialization_test.rb

@@ -0,0 +1,15 @@
+require 'helper'
+require 'jobs/gid_job'
+require 'models/person'
+
+class JobSerializationTest < ActiveSupport::TestCase
+  setup do
+    JobBuffer.clear
+    @person = Person.find(5)
+  end
+
+  test 'serialize job with gid' do
+    GidJob.perform_later @person
+    assert_equal "Person with ID: 5", JobBuffer.last_value
+  end
+end

data/test/cases/logging_test.rb

@@ -0,0 +1,114 @@
+require 'helper'
+require "active_support/log_subscriber/test_helper"
+require 'active_support/core_ext/numeric/time'
+require 'jobs/hello_job'
+require 'jobs/logging_job'
+require 'jobs/nested_job'
+require 'models/person'
+
+class AdapterTest < ActiveSupport::TestCase
+  include ActiveSupport::LogSubscriber::TestHelper
+  include ActiveSupport::Logger::Severity
+
+  class TestLogger < ActiveSupport::Logger
+    def initialize
+      @file = StringIO.new
+      super(@file)
+    end
+
+    def messages
+      @file.rewind
+      @file.read
+    end
+  end
+
+  def setup
+    super
+    JobBuffer.clear
+    @old_logger = ActiveJob::Base.logger
+    @logger = ActiveSupport::TaggedLogging.new(TestLogger.new)
+    set_logger @logger
+    ActiveJob::Logging::LogSubscriber.attach_to :active_job
+  end
+
+  def teardown
+    super
+    ActiveJob::Logging::LogSubscriber.log_subscribers.pop
+    set_logger @old_logger
+  end
+
+  def set_logger(logger)
+    ActiveJob::Base.logger = logger
+  end
+
+
+  def test_uses_active_job_as_tag
+    HelloJob.perform_later "Cristian"
+    assert_match(/\[ActiveJob\]/, @logger.messages)
+  end
+
+  def test_uses_job_name_as_tag
+    LoggingJob.perform_later "Dummy"
+    assert_match(/\[LoggingJob\]/, @logger.messages)
+  end
+
+  def test_uses_job_id_as_tag
+    LoggingJob.perform_later "Dummy"
+    assert_match(/\[LOGGING-JOB-ID\]/, @logger.messages)
+  end
+
+  def test_logs_correct_queue_name
+    original_queue_name = LoggingJob.queue_name
+    LoggingJob.queue_as :php_jobs
+    LoggingJob.perform_later("Dummy")
+    assert_match(/to .*?\(php_jobs\).*/, @logger.messages)
+  ensure
+    LoggingJob.queue_name = original_queue_name
+  end
+
+  def test_globalid_parameter_logging
+    person = Person.new(123)
+    LoggingJob.perform_later person
+    assert_match(%r{Enqueued.*gid://aj/Person/123}, @logger.messages)
+    assert_match(%r{Dummy, here is it: #<Person:.*>}, @logger.messages)
+    assert_match(%r{Performing.*gid://aj/Person/123}, @logger.messages)
+  end
+
+  def test_enqueue_job_logging
+    HelloJob.perform_later "Cristian"
+    assert_match(/Enqueued HelloJob \(Job ID: .*?\) to .*?:.*Cristian/, @logger.messages)
+  end
+
+  def test_perform_job_logging
+    LoggingJob.perform_later "Dummy"
+    assert_match(/Performing LoggingJob from .*? with arguments:.*Dummy/, @logger.messages)
+    assert_match(/Dummy, here is it: Dummy/, @logger.messages)
+    assert_match(/Performed LoggingJob from .*? in .*ms/, @logger.messages)
+  end
+
+  def test_perform_nested_jobs_logging
+    NestedJob.perform_later
+    assert_match(/\[LoggingJob\] \[.*?\]/, @logger.messages)
+    assert_match(/\[ActiveJob\] Enqueued NestedJob \(Job ID: .*\) to/, @logger.messages)
+    assert_match(/\[ActiveJob\] \[NestedJob\] \[NESTED-JOB-ID\] Performing NestedJob from/, @logger.messages)
+    assert_match(/\[ActiveJob\] \[NestedJob\] \[NESTED-JOB-ID\] Enqueued LoggingJob \(Job ID: .*?\) to .* with arguments: "NestedJob"/, @logger.messages)
+    assert_match(/\[ActiveJob\].*\[LoggingJob\] \[LOGGING-JOB-ID\] Performing LoggingJob from .* with arguments: "NestedJob"/, @logger.messages)
+    assert_match(/\[ActiveJob\].*\[LoggingJob\] \[LOGGING-JOB-ID\] Dummy, here is it: NestedJob/, @logger.messages)
+    assert_match(/\[ActiveJob\].*\[LoggingJob\] \[LOGGING-JOB-ID\] Performed LoggingJob from .* in/, @logger.messages)
+    assert_match(/\[ActiveJob\] \[NestedJob\] \[NESTED-JOB-ID\] Performed NestedJob from .* in/, @logger.messages)
+  end
+
+  def test_enqueue_at_job_logging
+    HelloJob.set(wait_until: 24.hours.from_now).perform_later "Cristian"
+    assert_match(/Enqueued HelloJob \(Job ID: .*\) to .*? at.*Cristian/, @logger.messages)
+  rescue NotImplementedError
+    skip
+  end
+
+  def test_enqueue_in_job_logging
+    HelloJob.set(wait: 2.seconds).perform_later "Cristian"
+    assert_match(/Enqueued HelloJob \(Job ID: .*\) to .*? at.*Cristian/, @logger.messages)
+  rescue NotImplementedError
+    skip
+  end
+end

data/test/cases/queue_naming_test.rb

@@ -0,0 +1,102 @@
+require 'helper'
+require 'jobs/hello_job'
+require 'jobs/logging_job'
+require 'jobs/nested_job'
+
+class QueueNamingTest < ActiveSupport::TestCase
+  test 'name derived from base' do
+    assert_equal "default", HelloJob.queue_name
+  end
+
+  test 'uses given queue name job' do
+    original_queue_name = HelloJob.queue_name
+
+    begin
+      HelloJob.queue_as :greetings
+      assert_equal "greetings", HelloJob.new.queue_name
+    ensure
+      HelloJob.queue_name = original_queue_name
+    end
+  end
+
+  test 'allows a blank queue name' do
+    original_queue_name = HelloJob.queue_name
+
+    begin
+      HelloJob.queue_as ""
+      assert_equal "", HelloJob.new.queue_name
+    ensure
+      HelloJob.queue_name = original_queue_name
+    end
+  end
+
+  test 'does not use a nil queue name' do
+    original_queue_name = HelloJob.queue_name
+
+    begin
+      HelloJob.queue_as nil
+      assert_equal "default", HelloJob.new.queue_name
+    ensure
+      HelloJob.queue_name = original_queue_name
+    end
+  end
+
+  test 'evals block given to queue_as to determine queue' do
+    original_queue_name = HelloJob.queue_name
+
+    begin
+      HelloJob.queue_as { :another }
+      assert_equal "another", HelloJob.new.queue_name
+    ensure
+      HelloJob.queue_name = original_queue_name
+    end
+  end
+
+  test 'can use arguments to determine queue_name in queue_as block' do
+    original_queue_name = HelloJob.queue_name
+
+    begin
+      HelloJob.queue_as { self.arguments.first=='1' ? :one : :two }
+      assert_equal "one", HelloJob.new('1').queue_name
+      assert_equal "two", HelloJob.new('3').queue_name
+    ensure
+      HelloJob.queue_name = original_queue_name
+    end
+  end
+
+  test 'queue_name_prefix prepended to the queue name with default delimiter' do
+    original_queue_name_prefix = ActiveJob::Base.queue_name_prefix
+    original_queue_name = HelloJob.queue_name
+
+    begin
+      ActiveJob::Base.queue_name_prefix = 'aj'
+      HelloJob.queue_as :low
+      assert_equal 'aj_low', HelloJob.queue_name
+    ensure
+      ActiveJob::Base.queue_name_prefix = original_queue_name_prefix
+      HelloJob.queue_name = original_queue_name
+    end
+  end
+
+  test 'queue_name_prefix prepended to the queue name with custom delimiter' do
+    original_queue_name_prefix = ActiveJob::Base.queue_name_prefix
+    original_queue_name_delimiter = ActiveJob::Base.queue_name_delimiter
+    original_queue_name = HelloJob.queue_name
+
+    begin
+      ActiveJob::Base.queue_name_delimiter = '.'
+      ActiveJob::Base.queue_name_prefix = 'aj'
+      HelloJob.queue_as :low
+      assert_equal 'aj.low', HelloJob.queue_name
+    ensure
+      ActiveJob::Base.queue_name_prefix = original_queue_name_prefix
+      ActiveJob::Base.queue_name_delimiter = original_queue_name_delimiter
+      HelloJob.queue_name = original_queue_name
+    end
+  end
+
+  test 'uses queue passed to #set' do
+    job = HelloJob.set(queue: :some_queue).perform_later
+    assert_equal "some_queue", job.queue_name
+  end
+end

data/test/cases/queuing_test.rb

@@ -0,0 +1,44 @@
+require 'helper'
+require 'jobs/hello_job'
+require 'active_support/core_ext/numeric/time'
+
+
+class QueuingTest < ActiveSupport::TestCase
+  setup do
+    JobBuffer.clear
+  end
+
+  test 'run queued job' do
+    HelloJob.perform_later
+    assert_equal "David says hello", JobBuffer.last_value
+  end
+
+  test 'run queued job with arguments' do
+    HelloJob.perform_later "Jamie"
+    assert_equal "Jamie says hello", JobBuffer.last_value
+  end
+
+  test 'run queued job later' do
+    begin
+      result = HelloJob.set(wait_until: 1.second.ago).perform_later "Jamie"
+      assert result
+    rescue NotImplementedError
+      skip
+    end
+  end
+
+  test 'job returned by enqueue has the arguments available' do
+    job = HelloJob.perform_later "Jamie"
+    assert_equal [ "Jamie" ], job.arguments
+  end
+
+
+  test 'job returned by perform_at has the timestamp available' do
+    begin
+      job = HelloJob.set(wait_until: Time.utc(2014, 1, 1)).perform_later
+      assert_equal Time.utc(2014, 1, 1).to_f, job.scheduled_at
+    rescue NotImplementedError
+      skip
+    end
+  end
+end

data/test/cases/rescue_test.rb

@@ -0,0 +1,35 @@
+require 'helper'
+require 'jobs/rescue_job'
+require 'models/person'
+
+class RescueTest < ActiveSupport::TestCase
+  setup do
+    JobBuffer.clear
+  end
+
+  test 'rescue perform exception with retry' do
+    job = RescueJob.new("david")
+    job.perform_now
+    assert_equal ["running", "rescued from ArgumentError", "running", "performed beautifully"], JobBuffer.values
+  end
+
+  test 'retries other errors' do
+    job = RescueJob.new("other")
+    assert_raises(RescueJob::OtherError) do
+      job.perform_now
+      assert_equal ["running", "running"], JobBuffer.values
+    end
+  end
+
+  test 'rescue from deserialization errors' do
+    RescueJob.perform_later Person.new(404)
+    assert_includes JobBuffer.values, 'rescued from DeserializationError'
+    assert_includes JobBuffer.values, 'DeserializationError original exception was Person::RecordNotFound'
+    assert_not_includes JobBuffer.values, 'performed beautifully'
+  end
+
+  test "should not wrap DeserializationError in DeserializationError" do
+    RescueJob.perform_later [Person.new(404)]
+    assert_includes JobBuffer.values, 'DeserializationError original exception was Person::RecordNotFound'
+  end
+end

data/test/cases/test_case_test.rb

@@ -0,0 +1,14 @@
+require 'helper'
+require 'jobs/hello_job'
+require 'jobs/logging_job'
+require 'jobs/nested_job'
+
+class ActiveJobTestCaseTest < ActiveJob::TestCase
+  def test_include_helper
+    assert_includes self.class.ancestors, ActiveJob::TestHelper
+  end
+
+  def test_set_test_adapter
+    assert_instance_of ActiveJob::QueueAdapters::TestAdapter, self.queue_adapter
+  end
+end

data/test/cases/test_helper_test.rb

@@ -0,0 +1,226 @@
+require 'helper'
+require 'active_support/core_ext/time'
+require 'active_support/core_ext/date'
+require 'jobs/hello_job'
+require 'jobs/logging_job'
+require 'jobs/nested_job'
+
+class EnqueuedJobsTest < ActiveJob::TestCase
+  def test_assert_enqueued_jobs
+    assert_nothing_raised do
+      assert_enqueued_jobs 1 do
+        HelloJob.perform_later('david')
+      end
+    end
+  end
+
+  def test_repeated_enqueued_jobs_calls
+    assert_nothing_raised do
+      assert_enqueued_jobs 1 do
+        HelloJob.perform_later('abdelkader')
+      end
+    end
+
+    assert_nothing_raised do
+      assert_enqueued_jobs 2 do
+        HelloJob.perform_later('sean')
+        HelloJob.perform_later('yves')
+      end
+    end
+  end
+
+  def test_assert_enqueued_jobs_with_no_block
+    assert_nothing_raised do
+      HelloJob.perform_later('rafael')
+      assert_enqueued_jobs 1
+    end
+
+    assert_nothing_raised do
+      HelloJob.perform_later('aaron')
+      HelloJob.perform_later('matthew')
+      assert_enqueued_jobs 3
+    end
+  end
+
+  def test_assert_no_enqueued_jobs_with_no_block
+    assert_nothing_raised do
+      assert_no_enqueued_jobs
+    end
+  end
+
+  def test_assert_no_enqueued_jobs
+    assert_nothing_raised do
+      assert_no_enqueued_jobs do
+        HelloJob.perform_now
+      end
+    end
+  end
+
+  def test_assert_enqueued_jobs_too_few_sent
+    error = assert_raise ActiveSupport::TestCase::Assertion do
+      assert_enqueued_jobs 2 do
+        HelloJob.perform_later('xavier')
+      end
+    end
+
+    assert_match(/2 .* but 1/, error.message)
+  end
+
+  def test_assert_enqueued_jobs_too_many_sent
+    error = assert_raise ActiveSupport::TestCase::Assertion do
+      assert_enqueued_jobs 1 do
+        HelloJob.perform_later('cristian')
+        HelloJob.perform_later('guillermo')
+      end
+    end
+
+    assert_match(/1 .* but 2/, error.message)
+  end
+
+  def test_assert_no_enqueued_jobs_failure
+    error = assert_raise ActiveSupport::TestCase::Assertion do
+      assert_no_enqueued_jobs do
+        HelloJob.perform_later('jeremy')
+      end
+    end
+
+    assert_match(/0 .* but 1/, error.message)
+  end
+
+  def test_assert_enqueued_job
+    assert_enqueued_with(job: LoggingJob, queue: 'default') do
+      LoggingJob.set(wait_until: Date.tomorrow.noon).perform_later
+    end
+  end
+
+  def test_assert_enqueued_job_failure
+    assert_raise ActiveSupport::TestCase::Assertion do
+      assert_enqueued_with(job: LoggingJob, queue: 'default') do
+        NestedJob.perform_later
+      end
+    end
+
+    error = assert_raise ActiveSupport::TestCase::Assertion do
+      assert_enqueued_with(job: NestedJob, queue: 'low') do
+        NestedJob.perform_later
+      end
+    end
+
+    assert_equal 'No enqueued job found with {:job=>NestedJob, :queue=>"low"}', error.message
+  end
+
+  def test_assert_enqueued_job_args
+    assert_raise ArgumentError do
+      assert_enqueued_with(class: LoggingJob) do
+        NestedJob.set(wait_until: Date.tomorrow.noon).perform_later
+      end
+    end
+  end
+end
+
+class PerformedJobsTest < ActiveJob::TestCase
+  def test_assert_performed_jobs
+    assert_nothing_raised do
+      assert_performed_jobs 1 do
+        HelloJob.perform_later('david')
+      end
+    end
+  end
+
+  def test_repeated_performed_jobs_calls
+    assert_nothing_raised do
+      assert_performed_jobs 1 do
+        HelloJob.perform_later('abdelkader')
+      end
+    end
+
+    assert_nothing_raised do
+      assert_performed_jobs 2 do
+        HelloJob.perform_later('sean')
+        HelloJob.perform_later('yves')
+      end
+    end
+  end
+
+  def test_assert_performed_jobs_with_no_block
+    assert_nothing_raised do
+      perform_enqueued_jobs do
+        HelloJob.perform_later('rafael')
+      end
+      assert_performed_jobs 1
+    end
+
+    assert_nothing_raised do
+      perform_enqueued_jobs do
+        HelloJob.perform_later('aaron')
+        HelloJob.perform_later('matthew')
+        assert_performed_jobs 3
+      end
+    end
+  end
+
+  def test_assert_no_performed_jobs_with_no_block
+    assert_nothing_raised do
+      assert_no_performed_jobs
+    end
+  end
+
+  def test_assert_no_performed_jobs
+    assert_nothing_raised do
+      assert_no_performed_jobs do
+        # empty block won't perform jobs
+      end
+    end
+  end
+
+  def test_assert_performed_jobs_too_few_sent
+    error = assert_raise ActiveSupport::TestCase::Assertion do
+      assert_performed_jobs 2 do
+        HelloJob.perform_later('xavier')
+      end
+    end
+
+    assert_match(/2 .* but 1/, error.message)
+  end
+
+  def test_assert_performed_jobs_too_many_sent
+    error = assert_raise ActiveSupport::TestCase::Assertion do
+      assert_performed_jobs 1 do
+        HelloJob.perform_later('cristian')
+        HelloJob.perform_later('guillermo')
+      end
+    end
+
+    assert_match(/1 .* but 2/, error.message)
+  end
+
+  def test_assert_no_performed_jobs_failure
+    error = assert_raise ActiveSupport::TestCase::Assertion do
+      assert_no_performed_jobs do
+        HelloJob.perform_later('jeremy')
+      end
+    end
+
+    assert_match(/0 .* but 1/, error.message)
+  end
+
+  def test_assert_performed_job
+    assert_performed_with(job: NestedJob, queue: 'default') do
+      NestedJob.perform_later
+    end
+  end
+
+  def test_assert_performed_job_failure
+    assert_raise ActiveSupport::TestCase::Assertion do
+      assert_performed_with(job: LoggingJob, at: Date.tomorrow.noon, queue: 'default') do
+        NestedJob.set(wait_until: Date.tomorrow.noon).perform_later
+      end
+    end
+
+    assert_raise ActiveSupport::TestCase::Assertion do
+      assert_performed_with(job: NestedJob, at: Date.tomorrow.noon, queue: 'low') do
+        NestedJob.set(queue: 'low', wait_until: Date.tomorrow.noon).perform_later
+      end
+    end
+  end
+end