Skip to Content Skip to Search

Test helper for ActiveJob::Continuable jobs.

Methods
I
Included Modules

Instance Public methods

interrupt_job_after_step(job_class, step, reason: true, &block)

Interrupt a job after a step.

Note that there’s no checkpoint after the final step so it won’t be interrupted.

class MyJob < ApplicationJob
  include ActiveJob::Continuable

  cattr_accessor :items, default: []

  def perform
    step :step_one { items << 1 }
    step :step_two { items << 2 }
    step :step_three { items << 3 }
    step :step_four { items << 4 }
  end
end

test "interrupt job after step" do
  MyJob.perform_later
  interrupt_job_after_step(MyJob, :step_two) { perform_enqueued_jobs }
  assert_equal [1, 2], MyJob.items
  perform_enqueued_jobs
  assert_equal [1, 2, 3, 4], MyJob.items
end

A custom interrupt reason can be provided with the reason argument.

Source: show | on GitHub 

# File activejob/lib/active_job/continuation/test_helper.rb, line 70
def interrupt_job_after_step(job_class, step, reason: true, &block)
  require_active_job_test_adapter!("interrupt_job_after_step")
  stopping = ->(job) { reason if job.is_a?(job_class) && after_step?(job, step) }
  queue_adapter.with(stopping: stopping, &block)
end

interrupt_job_during_step(job_class, step, cursor: nil, reason: true, &block)

Interrupt a job during a step.

class MyJob < ApplicationJob
  include ActiveJob::Continuable

  cattr_accessor :items, default: []
  def perform
    step :my_step, start: 1 do |step|
      (step.cursor..10).each do |i|
        items << i
        step.advance!
      end
    end
  end
end

test "interrupt job during step" do
  MyJob.perform_later
  interrupt_job_during_step(MyJob, :my_step, cursor: 6) { perform_enqueued_jobs }
  assert_equal [1, 2, 3, 4, 5], MyJob.items
  perform_enqueued_jobs
  assert_equal [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], MyJob.items
end

A custom interrupt reason can be provided with the reason argument.

Source: show | on GitHub 

# File activejob/lib/active_job/continuation/test_helper.rb, line 38
def interrupt_job_during_step(job_class, step, cursor: nil, reason: true, &block)
  require_active_job_test_adapter!("interrupt_job_during_step")
  stopping = ->(job) { reason if job.is_a?(job_class) && during_step?(job, step, cursor: cursor) }
  queue_adapter.with(stopping: stopping, &block)
end