модуль ActiveJob::TestHelper

Подключенные модули:: ActiveSupport::Testing::Assertions

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

Открытые методы экземпляра

assert_enqueued_jobs (number, only: nil, except: nil, queue: nil, &block) Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 122
def assert_enqueued_jobs(number, only: nil, except: nil, queue: nil, &block)
  require_active_job_test_adapter!("assert_enqueued_jobs")

  if block_given?
    original_jobs = enqueued_jobs_with(only: only, except: except, queue: queue)

    _assert_nothing_raised_or_warn("assert_enqueued_jobs", &block)

    new_jobs = enqueued_jobs_with(only: only, except: except, queue: queue)

    actual_count = (new_jobs - original_jobs).count
  else
    actual_count = enqueued_jobs_with(only: only, except: except, queue: queue).count
  end

  assert_equal number, actual_count, "#{number} jobs expected, but #{actual_count} were enqueued"
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

Проверяет, сколько раз было поставлено в очередь задание определённого класса, передав параметр :only.

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

Проверяет, сколько раз в очередь было поставлено задание, не относящееся к определённому классу, передав параметр :except.

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

Параметры :only и :except принимают Class, Array из Class или Proc. Если передан Proc, ему в качестве аргумента передаётся хеш, содержащий класс задания и его аргументы.

Проверяет, сколько раз задание было поставлено в очередь определённой очереди, передав параметр :queue.

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

assert_enqueued_with (job: nil, args: nil, at: nil, queue: nil, priority: nil, &block) Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 406
def assert_enqueued_with(job: nil, args: nil, at: nil, queue: nil, priority: nil, &block)
  require_active_job_test_adapter!("assert_enqueued_with")

  expected = { job: job, args: args, at: at, queue: queue, priority: priority }.compact
  expected_args = prepare_args_for_assertion(expected)
  potential_matches = []

  if block_given?
    original_enqueued_jobs = enqueued_jobs.dup

    _assert_nothing_raised_or_warn("assert_enqueued_with", &block)

    jobs = enqueued_jobs - original_enqueued_jobs
  else
    jobs = enqueued_jobs
  end

  matching_job = jobs.find do |enqueued_job|
    deserialized_job = deserialize_args_for_assertion(enqueued_job)
    potential_matches << deserialized_job

    expected_args.all? do |key, value|
      if value.respond_to?(:call)
        value.call(deserialized_job[key])
      else
        value == deserialized_job[key]
      end
    end
  end

  matching_class = potential_matches.select do |enqueued_job|
    enqueued_job["job_class"] == job.to_s
  end

  message = +"No enqueued job found with #{expected}"
  if potential_matches.empty?
    message << "\n\nNo jobs were enqueued"
  elsif matching_class.empty?
    message << "\n\nNo jobs of class #{expected[:job]} were enqueued, job classes enqueued: "
    message << potential_matches.map { |job| job["job_class"] }.join(", ")
  else
    message << "\n\nPotential matches: #{matching_class.join("\n")}"
  end

  assert matching_job, message
  instantiate_job(matching_job)
end

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

def test_assert_enqueued_with
  MyJob.perform_later(1,2,3)
  assert_enqueued_with(job: MyJob, args: [1,2,3])

  MyJob.set(wait_until: Date.tomorrow.noon, queue: "my_queue").perform_later
  assert_enqueued_with(at: Date.tomorrow.noon, queue: "my_queue")
end

Именованные аргументы указываются в виде хеша внутри массива:

def test_assert_enqueued_with_keyword_arguments
  MyJob.perform_later(arg1: 'value1', arg2: 'value2')
  assert_enqueued_with(job: MyJob, args: [{ arg1: 'value1', arg2: 'value2' }])
end

Указанные аргументы также можно задать в виде Proc-сопоставителей, возвращающих логическое значение, которое указывает, соответствует ли атрибут задания заданным критериям.

Например, Proc можно использовать для сопоставления диапазона времени:

def test_assert_enqueued_with
  at_matcher = ->(job_at) { (Date.yesterday..Date.tomorrow).cover?(job_at) }

  MyJob.set(wait_until: Date.today.noon).perform_later

  assert_enqueued_with(job: MyJob, at: at_matcher)
end

Proc также можно использовать для сопоставления подмножества аргументов задания:

def test_assert_enqueued_with
  args_matcher = ->(job_args) { job_args[0].key?(:foo) }

  MyJob.perform_later(foo: "bar", other_arg: "No need to check in the test")

  assert_enqueued_with(job: MyJob, args: args_matcher)
end

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

def test_assert_enqueued_with
  assert_enqueued_with(job: MyJob, args: [1,2,3]) 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 (only: nil, except: nil, queue: nil, &block) Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 186
def assert_no_enqueued_jobs(only: nil, except: nil, queue: nil, &block)
  require_active_job_test_adapter!("assert_no_enqueued_jobs")

  assert_enqueued_jobs 0, only: only, except: except, queue: queue, &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

Проверяет, что в очередь не поставлено ни одного задания определённого типа, передав параметр :only.

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

Проверяет, что в очередь не поставлено ни одного задания, кроме заданий определённого класса, передав параметр :except.

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

Проверяет, что ни одно задание не поставлено в определённую очередь, передав параметр :queue

def test_no_logging
  assert_no_enqueued_jobs queue: 'default' do
    LoggingJob.set(queue: :some_queue).perform_later
  end
end

Примечание: эта проверка представляет собой сокращённую запись:

assert_enqueued_jobs 0, &block

assert_no_performed_jobs (only: nil, except: nil, queue: nil, &block) Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 348
def assert_no_performed_jobs(only: nil, except: nil, queue: nil, &block)
  require_active_job_test_adapter!("assert_no_performed_jobs")

  assert_performed_jobs 0, only: only, except: except, queue: queue, &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

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

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

Если указан параметр :except, будут выполнены задания, не относящиеся к определённому классу.

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

Параметры :only и :except принимают Class, Array из Class или Proc. Если передан Proc, ему в качестве аргумента передаётся экземпляр задания.

Если указан параметр :queue, будут выполнены только задания, поставленные в определённую очередь.

def test_assert_no_performed_jobs_with_queue_option
  assert_no_performed_jobs queue: :some_queue do
    HelloJob.set(queue: :other_queue).perform_later("jeremy")
  end
end

Примечание: эта проверка представляет собой сокращённую запись:

assert_performed_jobs 0, &block

assert_performed_jobs (number, only: nil, except: nil, queue: nil, &block) Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 278
def assert_performed_jobs(number, only: nil, except: nil, queue: nil, &block)
  require_active_job_test_adapter!("assert_performed_jobs")

  if block_given?
    original_count = performed_jobs.size

    perform_enqueued_jobs(only: only, except: except, queue: queue, &block)

    new_count = performed_jobs.size

    performed_jobs_size = new_count - original_count
  else
    performed_jobs_size = performed_jobs_with(only: only, except: except, queue: queue).count
  end

  assert_equal number, performed_jobs_size, "#{number} jobs expected, but #{performed_jobs_size} were performed"
end

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

def test_jobs
  assert_performed_jobs 0

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

  HelloJob.perform_later('yves')

  perform_enqueued_jobs

  assert_performed_jobs 2
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

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

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

Если указан параметр :except, будут выполнены задания, не относящиеся к определённому классу.

def test_hello_job
  assert_performed_jobs 1, except: LoggingJob 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

Также можно указать Proc. Если передан Proc, ему в качестве аргумента передаётся экземпляр задания.

def test_hello_and_logging_jobs
  assert_nothing_raised do
    assert_performed_jobs(1, only: ->(job) { job.is_a?(HelloJob) }) do
      HelloJob.perform_later('jeremy')
      LoggingJob.perform_later('stewie')
      RescueJob.perform_later('david')
    end
  end
end

Если указан параметр :queue, будут выполнены только задания, поставленные в определённую очередь.

def test_assert_performed_jobs_with_queue_option
  assert_performed_jobs 1, queue: :some_queue do
    HelloJob.set(queue: :some_queue).perform_later("jeremy")
    HelloJob.set(queue: :other_queue).perform_later("bogdan")
  end
end

assert_performed_with (job: nil, args: nil, at: nil, queue: nil, priority: nil, &block) Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 510
def assert_performed_with(job: nil, args: nil, at: nil, queue: nil, priority: nil, &block)
  require_active_job_test_adapter!("assert_performed_with")

  expected = { job: job, args: args, at: at, queue: queue, priority: priority }.compact
  expected_args = prepare_args_for_assertion(expected)
  potential_matches = []

  if block_given?
    original_performed_jobs_count = performed_jobs.count

    perform_enqueued_jobs(&block)

    jobs = performed_jobs.drop(original_performed_jobs_count)
  else
    jobs = performed_jobs
  end

  matching_job = jobs.find do |enqueued_job|
    deserialized_job = deserialize_args_for_assertion(enqueued_job)
    potential_matches << deserialized_job

    expected_args.all? do |key, value|
      if value.respond_to?(:call)
        value.call(deserialized_job[key])
      else
        value == deserialized_job[key]
      end
    end
  end

  matching_class = potential_matches.select do |enqueued_job|
    enqueued_job["job_class"] == job.to_s
  end

  message = +"No performed job found with #{expected}"
  if potential_matches.empty?
    message << "\n\nNo jobs were performed"
  elsif matching_class.empty?
    message << "\n\nNo jobs of class #{expected[:job]} were performed, job classes performed: "
    message << potential_matches.map { |job| job["job_class"] }.join(", ")
  else
    message << "\n\nPotential matches: #{matching_class.join("\n")}"
  end

  assert matching_job, message

  instantiate_job(matching_job)
end

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

def test_assert_performed_with
  MyJob.perform_later(1,2,3)

  perform_enqueued_jobs

  assert_performed_with(job: MyJob, args: [1,2,3])

  MyJob.set(wait_until: Date.tomorrow.noon, queue: "my_queue").perform_later

  perform_enqueued_jobs

  assert_performed_with(at: Date.tomorrow.noon, queue: "my_queue")
end

Например, Proc можно использовать для сопоставления диапазона времени:

def test_assert_performed_with
  at_matcher = ->(job_at) { (Date.yesterday..Date.tomorrow).cover?(job_at) }

  MyJob.set(wait_until: Date.today.noon).perform_later

  perform_enqueued_jobs

  assert_performed_with(job: MyJob, at: at_matcher)
end

Proc также можно использовать для сопоставления подмножества аргументов задания:

def test_assert_performed_with
  args_matcher = ->(job_args) { job_args[0].key?(:foo) }

  MyJob.perform_later(foo: "bar", other_arg: "No need to check in the test")

  perform_enqueued_jobs

  assert_performed_with(job: MyJob, args: args_matcher)
end

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

def test_assert_performed_with
  assert_performed_with(job: MyJob, args: [1,2,3]) 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 (only: nil, except: nil, queue: nil, at: nil, &block) Показать исходный код

# File activejob/lib/active_job/test_helper.rb, line 620
def perform_enqueued_jobs(only: nil, except: nil, queue: nil, at: nil, &block)
  unless block_given?
    require_active_job_test_adapter!("perform_enqueued_jobs (without a block)")
    return flush_enqueued_jobs(only: only, except: except, queue: queue, at: at)
  end

  return _assert_nothing_raised_or_warn("perform_enqueued_jobs", &block) unless using_test_adapter?

  validate_option(only: only, except: except)

  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
  old_reject = queue_adapter.reject
  old_queue = queue_adapter.queue
  old_at = queue_adapter.at

  begin
    queue_adapter.perform_enqueued_jobs = true
    queue_adapter.perform_enqueued_at_jobs = true
    queue_adapter.filter = only
    queue_adapter.reject = except
    queue_adapter.queue = queue
    queue_adapter.at = at

    _assert_nothing_raised_or_warn("perform_enqueued_jobs", &block)
  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
    queue_adapter.reject = old_reject
    queue_adapter.queue = old_queue
    queue_adapter.at = old_at
  end
end

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

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

def test_perform_enqueued_jobs_without_block
  MyJob.perform_later(1, 2, 3)

  perform_enqueued_jobs

  assert_performed_jobs 1
end

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

Если указан параметр :except, будут выполнены задания, не относящиеся к определённому классу.

def test_perform_enqueued_jobs_with_except
  perform_enqueued_jobs(except: HelloJob) 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, будут выполнены только задания, поставленные в определённую очередь.

def test_perform_enqueued_jobs_with_queue
  perform_enqueued_jobs queue: :some_queue do
    MyJob.set(queue: :some_queue).perform_later(1, 2, 3) # will be performed
    HelloJob.set(queue: :other_queue).perform_later(1, 2, 3) # will not be performed
  end
  assert_performed_jobs 1
end

Если указан параметр :at, будут выполнены только задания, поставленные в очередь на указанное время или раньше. Сюда входят задания, поставленные в очередь без указания времени.

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

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

# File activejob/lib/active_job/test_helper.rb, line 661
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 66
def queue_adapter_for_test
end

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