提供 Active Job 測試的輔助方法
- A
- P
- Q
實例公開方法
assert_enqueued_jobs(number, only: nil, except: nil, queue: nil, &block) 連結
斷言排程的作業數目符合指定的數目。
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
選項接受 類別
、陣列
的 類別
或程序。當傳遞一個程序時,會傳遞一個包含作業類別和其參數的雜湊作參數。
通過傳遞 :queue
選項,斷言作業被排程到特定佇列的次數。
def test_logging_job
assert_enqueued_jobs 2, queue: 'default' do
LoggingJob.perform_later
HelloJob.perform_later('elfassy')
end
end
來源: 顯示 | 在 GitHub 上
# 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
assert_enqueued_with(job: nil, args: nil, at: nil, queue: nil, priority: nil, &block) 連結
斷言作業已使用提供的參數排程。
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
也會指定提供的參數作為匹配器程序,它回傳布林值來表示作業的屬性是否符合某些標準。
例如,可以使用程序來匹配時間範圍
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
也可以使用程序來匹配作業部分參數
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
來源: 顯示 | 在 GitHub 上
# 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
assert_no_enqueued_jobs(only: nil, except: nil, queue: nil, &block) 連結
斷言尚未排程任何作業。
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
:only
和 :except
選項接受 類別
、陣列
的 類別
或程序。當傳遞一個程序時,會傳遞一個包含作業類別和其參數的雜湊作參數。
通過傳遞 :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) 連結
聲明未執行任何工作。
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
選項接受 類別
、陣列
(類別
)或 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) 連結
聲明已執行的工作的數量與給定的數量相符。如果未傳遞區塊,則必須在呼叫工作的周圍或在其呼叫之後,呼叫 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
# 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
assert_performed_with(job: nil, args: nil, at: nil, queue: nil, priority: nil, &block) 連結
聲明已使用特定引數執行工作。
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
也會指定提供的參數作為匹配器程序,它回傳布林值來表示作業的屬性是否符合某些標準。
例如,可以使用程序來匹配時間範圍
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
也可以使用程序來匹配作業部分參數
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
# 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
perform_enqueued_jobs(only: nil, except: nil, queue: nil, at: nil, &block) 連結
執行所有排入佇列的工作。如果提供了區塊,則執行在該區塊持續期間內所排入的所有工作。如果未提供區塊,則執行測試中時至此刻所排入的所有工作。
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
此方法也支援篩選。如果指定了 :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
此外,如果指定了 :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
:only
和 :except
選項接受 類別
、陣列
(類別
)或 Proc。傳遞 Proc 時,工作執行個體會傳遞為引數。
如果指定了 :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
僅會執行區塊。
來源:顯示 | 於 GitHub 中
# 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
queue_adapter() 連結
存取 queue_adapter
由 ActiveJob::Base
設定。
def test_assert_job_has_custom_queue_adapter_set
assert_instance_of CustomQueueAdapter, HelloJob.queue_adapter
end
來源:顯示 | 於 GitHub 中
# File activejob/lib/active_job/test_helper.rb, line 661 def queue_adapter ActiveJob::Base.queue_adapter end
queue_adapter_for_test() 連結
傳回一個佇列介面器實體用於所有 Active Job 測試輔助程式。預設傳回 ActiveJob::QueueAdapters::TestAdapter
的一個實體。覆寫此方法以指定不同的介面器。介面器必須實作 ActiveJob::QueueAdapters::TestAdapter
相同的介面。
來源:顯示 | 於 GitHub 中
# File activejob/lib/active_job/test_helper.rb, line 66 def queue_adapter_for_test end