модуль ActiveJob::TestHelper

Включенные модули:: ActiveJob::TestHelper::TestQueueAdapter

Предоставляет вспомогательные методы для тестирования Active Job

Общедоступные методы экземпляров

assert_enqueued_jobs(количество, только: nil, очередь: nil) { || ... } Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 107
def assert_enqueued_jobs(number, only: nil, queue: nil)
  if block_given?
    original_count = enqueued_jobs_size(only: only, queue: queue)
    yield
    new_count = enqueued_jobs_size(only: only, queue: queue)
    assert_equal number, new_count - original_count, "#{number} jobs expected, but #{new_count - original_count} were enqueued"
  else
    actual_count = enqueued_jobs_size(only: only, queue: queue)
    assert_equal number, actual_count, "#{number} jobs expected, but #{actual_count} were enqueued"
  end
end

Утверждает, что количество очередированных заданий соответствует заданному числу.

def test_jobs
  assert_enqueued_jobs 0
  HelloJob.perform_later('david')
  assert_enqueued_jobs 1
  HelloJob.perform_later('abdelkader')
  assert_enqueued_jobs 2
end

Если передан блок, этот блок приведет к очередированию указанного количества заданий.

def test_jobs_again
  assert_enqueued_jobs 1 do
    HelloJob.perform_later('cristian')
  end

  assert_enqueued_jobs 2 do
    HelloJob.perform_later('aaron')
    HelloJob.perform_later('rafael')
  end
end

Можно утверждать о количестве раз, когда конкретная задача была очередирована.

def test_logging_job
  assert_enqueued_jobs 1, only: LoggingJob do
    LoggingJob.perform_later
    HelloJob.perform_later('jeremy')
  end
end

Также можно утверждать о количестве раз, когда задача была очередирована в определённую очередь.

def test_logging_job
  assert_enqueued_jobs 2, queue: 'default' do
    LoggingJob.perform_later
    HelloJob.perform_later('elfassy')
  end
end

assert_enqueued_with(задача: nil, аргументы: nil, в: nil, очередь: nil) { || ... } Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 262
def assert_enqueued_with(job: nil, args: nil, at: nil, queue: nil)
  original_enqueued_jobs_count = enqueued_jobs.count
  expected = { job: job, args: args, at: at, queue: queue }.compact
  serialized_args = serialize_args_for_assertion(expected)
  yield
  in_block_jobs = enqueued_jobs.drop(original_enqueued_jobs_count)
  matching_job = in_block_jobs.find do |in_block_job|
    serialized_args.all? { |key, value| value == in_block_job[key] }
  end
  assert matching_job, "No enqueued job found with #{expected}"
  instantiate_job(matching_job)
end

Утверждает, что задача, переданная в блоке, была очередирована с указанными аргументами.

def test_assert_enqueued_with
  assert_enqueued_with(job: MyJob, args: [1,2,3], queue: 'low') do
    MyJob.perform_later(1,2,3)
  end

  assert_enqueued_with(job: MyJob, at: Date.tomorrow.noon) do
    MyJob.set(wait_until: Date.tomorrow.noon).perform_later
  end
end

assert_no_enqueued_jobs(только: nil, &блок) Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 146
def assert_no_enqueued_jobs(only: nil, &block)
  assert_enqueued_jobs 0, only: only, &block
end

Утверждает, что задачи не были очередированы.

def test_jobs
  assert_no_enqueued_jobs
  HelloJob.perform_later('jeremy')
  assert_enqueued_jobs 1
end

Если передан блок, этот блок не должен вызывать очередирование какой-либо задачи.

def test_jobs_again
  assert_no_enqueued_jobs do
    # No job should be enqueued from this block
  end
end

Можно утверждать, что задачи определённого типа не были очередированы:

def test_no_logging
  assert_no_enqueued_jobs only: LoggingJob do
    HelloJob.perform_later('jeremy')
  end
end

Примечание: Это утверждение — просто сокращение для:

assert_enqueued_jobs 0, &block

assert_no_performed_jobs(только: nil, &блок) Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 247
def assert_no_performed_jobs(only: nil, &block)
  assert_performed_jobs 0, only: only, &block
end

Утверждает, что задачи не были выполнены.

def test_jobs
  assert_no_performed_jobs

  perform_enqueued_jobs do
    HelloJob.perform_later('matthew')
    assert_performed_jobs 1
  end
end

Если передан блок, этот блок не должен вызывать выполнение какой-либо задачи.

def test_jobs_again
  assert_no_performed_jobs do
    # No job should be performed from this block
  end
end

Форма блока поддерживает фильтрацию. Если задан параметр :только, то будут проверены только перечисленные задачи.

def test_no_logging
  assert_no_performed_jobs only: LoggingJob do
    HelloJob.perform_later('jeremy')
  end
end

Примечание: Это утверждение — просто сокращение для:

assert_performed_jobs 0, &block

assert_performed_jobs(количество, только: nil) { || ... } Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 203
def assert_performed_jobs(number, only: nil)
  if block_given?
    original_count = performed_jobs.size
    perform_enqueued_jobs(only: only) { yield }
    new_count = performed_jobs.size
    assert_equal number, new_count - original_count,
      "#{number} jobs expected, but #{new_count - original_count} were performed"
  else
    performed_jobs_size = performed_jobs.size
    assert_equal number, performed_jobs_size, "#{number} jobs expected, but #{performed_jobs_size} were performed"
  end
end

Утверждает, что количество выполненных заданий соответствует заданному числу. Если блок не передан, perform_enqueued_jobs должен быть вызван вокруг вызова задачи.

def test_jobs
  assert_performed_jobs 0

  perform_enqueued_jobs do
    HelloJob.perform_later('xavier')
  end
  assert_performed_jobs 1

  perform_enqueued_jobs do
    HelloJob.perform_later('yves')
    assert_performed_jobs 2
  end
end

Если передан блок, этот блок должен вызвать выполнение указанного количества заданий.

def test_jobs_again
  assert_performed_jobs 1 do
    HelloJob.perform_later('robin')
  end

  assert_performed_jobs 2 do
    HelloJob.perform_later('carlos')
    HelloJob.perform_later('sean')
  end
end

def test_hello_job
  assert_performed_jobs 1, only: HelloJob do
    HelloJob.perform_later('jeremy')
    LoggingJob.perform_later
  end
end

Также может быть указан массив для тестирования нескольких задач.

def test_hello_and_logging_jobs
  assert_nothing_raised do
    assert_performed_jobs 2, only: [HelloJob, LoggingJob] do
      HelloJob.perform_later('jeremy')
      LoggingJob.perform_later('stewie')
      RescueJob.perform_later('david')
    end
  end
end

assert_performed_with(задача: nil, аргументы: nil, в: nil, очередь: nil) { || ... } Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 286
def assert_performed_with(job: nil, args: nil, at: nil, queue: nil)
  original_performed_jobs_count = performed_jobs.count
  expected = { job: job, args: args, at: at, queue: queue }.compact
  serialized_args = serialize_args_for_assertion(expected)
  perform_enqueued_jobs { yield }
  in_block_jobs = performed_jobs.drop(original_performed_jobs_count)
  matching_job = in_block_jobs.find do |in_block_job|
    serialized_args.all? { |key, value| value == in_block_job[key] }
  end
  assert matching_job, "No performed job found with #{expected}"
  instantiate_job(matching_job)
end

Утверждает, что задача, переданная в блоке, была выполнена с указанными аргументами.

def test_assert_performed_with
  assert_performed_with(job: MyJob, args: [1,2,3], queue: 'high') do
    MyJob.perform_later(1,2,3)
  end

  assert_performed_with(job: MyJob, at: Date.tomorrow.noon) do
    MyJob.set(wait_until: Date.tomorrow.noon).perform_later
  end
end

perform_enqueued_jobs(только: nil) { || ... } Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 318
def perform_enqueued_jobs(only: nil)
  old_perform_enqueued_jobs = queue_adapter.perform_enqueued_jobs
  old_perform_enqueued_at_jobs = queue_adapter.perform_enqueued_at_jobs
  old_filter = queue_adapter.filter

  begin
    queue_adapter.perform_enqueued_jobs = true
    queue_adapter.perform_enqueued_at_jobs = true
    queue_adapter.filter = only
    yield
  ensure
    queue_adapter.perform_enqueued_jobs = old_perform_enqueued_jobs
    queue_adapter.perform_enqueued_at_jobs = old_perform_enqueued_at_jobs
    queue_adapter.filter = old_filter
  end
end

Выполняет все очередированные задания в течение блока.

def test_perform_enqueued_jobs
  perform_enqueued_jobs do
    MyJob.perform_later(1, 2, 3)
  end
  assert_performed_jobs 1
end

Этот метод также поддерживает фильтрацию. Если задан параметр :only, то будут выполнены только перечисленные задачи.

def test_perform_enqueued_jobs_with_only
  perform_enqueued_jobs(only: MyJob) do
    MyJob.perform_later(1, 2, 3) # will be performed
    HelloJob.perform_later(1, 2, 3) # will not be performed
  end
  assert_performed_jobs 1
end

queue_adapter() Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 340
def queue_adapter
  ActiveJob::Base.queue_adapter
end

Получает доступ к #queue_adapter, заданному ActiveJob::Base.

def test_assert_job_has_custom_queue_adapter_set
  assert_instance_of CustomQueueAdapter, HelloJob.queue_adapter
end

queue_adapter_for_test() Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 62
def queue_adapter_for_test
  ActiveJob::QueueAdapters::TestAdapter.new
end

Указывает адаптер очереди, который будет использоваться всеми тестами Active Job.

Возвращает экземпляр адаптера очереди и по умолчанию использует ActiveJob::QueueAdapters::TestAdapter.

Примечание: адаптер, предоставляемый этим методом, должен предоставлять дополнительные методы, помимо тех, которые ожидаются от стандартного ActiveJob::QueueAdapter, для использования с вспомогательными методами тестов Active Job. Обратитесь к ActiveJob::QueueAdapters::TestAdapter.