提供用于测试 Action Mailer 的辅助方法,包括 assert_emails 和 assert_no_emails。
方法
- A
- C
- D
包含的模块
实例公共方法
assert_emails(number, &block) 链接
断言发送的邮件数量与给定的数量匹配。
def test_emails assert_emails 0 ContactMailer.welcome.deliver_now assert_emails 1 ContactMailer.welcome.deliver_now assert_emails 2 end
如果传递了块,该块应导致发送指定数量的邮件。
def test_emails_again assert_emails 1 do ContactMailer.welcome.deliver_now end assert_emails 2 do ContactMailer.welcome.deliver_now ContactMailer.welcome.deliver_later end end
源文件: 显示 | 在 GitHub 上
# File actionmailer/lib/action_mailer/test_helper.rb, line 35 def assert_emails(number, &block) if block_given? diff = capture_emails(&block).length assert_equal number, diff, "#{number} emails expected, but #{diff} were sent" else assert_equal number, ActionMailer::Base.deliveries.size end end
assert_enqueued_email_with(mailer, method, params: nil, args: nil, queue: nil, &block) 链接
断言特定电子邮件已加入队列,可选择匹配参数和/或 params。
def test_email ContactMailer.welcome.deliver_later assert_enqueued_email_with ContactMailer, :welcome end def test_email_with_parameters ContactMailer.with(greeting: "Hello").welcome.deliver_later assert_enqueued_email_with ContactMailer, :welcome, args: { greeting: "Hello" } end def test_email_with_arguments ContactMailer.welcome("Hello", "Goodbye").deliver_later assert_enqueued_email_with ContactMailer, :welcome, args: ["Hello", "Goodbye"] end def test_email_with_named_arguments ContactMailer.welcome(greeting: "Hello", farewell: "Goodbye").deliver_later assert_enqueued_email_with ContactMailer, :welcome, args: [{ greeting: "Hello", farewell: "Goodbye" }] end def test_email_with_parameters_and_arguments ContactMailer.with(greeting: "Hello").welcome("Cheers", "Goodbye").deliver_later assert_enqueued_email_with ContactMailer, :welcome, params: { greeting: "Hello" }, args: ["Cheers", "Goodbye"] end def test_email_with_parameters_and_named_arguments ContactMailer.with(greeting: "Hello").welcome(farewell: "Goodbye").deliver_later assert_enqueued_email_with ContactMailer, :welcome, params: { greeting: "Hello" }, args: [{farewell: "Goodbye"}] end def test_email_with_parameterized_mailer ContactMailer.with(greeting: "Hello").welcome.deliver_later assert_enqueued_email_with ContactMailer.with(greeting: "Hello"), :welcome end def test_email_with_matchers ContactMailer.with(greeting: "Hello").welcome("Cheers", "Goodbye").deliver_later assert_enqueued_email_with ContactMailer, :welcome, params: ->(params) { /hello/i.match?(params[:greeting]) }, args: ->(args) { /cheers/i.match?(args[0]) } end
如果传递了块,该块应导致将指定的电子邮件加入队列。
def test_email_in_block assert_enqueued_email_with ContactMailer, :welcome do ContactMailer.welcome.deliver_later end end
如果 args 被提供为 Hash,则会匹配参数化电子邮件。
def test_parameterized_email assert_enqueued_email_with ContactMailer, :welcome, args: {email: 'user@example.com'} do ContactMailer.with(email: 'user@example.com').welcome.deliver_later end end
源文件: 显示 | 在 GitHub 上
# File actionmailer/lib/action_mailer/test_helper.rb, line 157 def assert_enqueued_email_with(mailer, method, params: nil, args: nil, queue: nil, &block) if mailer.is_a? ActionMailer::Parameterized::Mailer params = mailer.instance_variable_get(:@params) mailer = mailer.instance_variable_get(:@mailer) end args = Array(args) unless args.is_a?(Proc) queue ||= mailer.deliver_later_queue_name || ActiveJob::Base.default_queue_name expected = ->(job_args) do job_kwargs = job_args.extract_options! [mailer.to_s, method.to_s, "deliver_now"] == job_args && params === job_kwargs[:params] && args === job_kwargs[:args] end assert_enqueued_with(job: mailer.delivery_job, args: expected, queue: queue.to_s, &block) end
assert_enqueued_emails(number, &block) 链接
断言稍后发送的已加入队列的邮件数量与给定的数量匹配。
def test_emails assert_enqueued_emails 0 ContactMailer.welcome.deliver_later assert_enqueued_emails 1 ContactMailer.welcome.deliver_later assert_enqueued_emails 2 end
如果传递了块,该块应导致将指定数量的邮件加入队列。
def test_emails_again assert_enqueued_emails 1 do ContactMailer.welcome.deliver_later end assert_enqueued_emails 2 do ContactMailer.welcome.deliver_later ContactMailer.welcome.deliver_later end end
源文件: 显示 | 在 GitHub 上
# File actionmailer/lib/action_mailer/test_helper.rb, line 91 def assert_enqueued_emails(number, &block) assert_enqueued_jobs(number, only: ->(job) { delivery_job_filter(job) }, &block) end
assert_no_emails(&block) 链接
断言没有发送任何电子邮件。
def test_emails assert_no_emails ContactMailer.welcome.deliver_now assert_emails 1 end
如果传递了块,该块不应导致发送任何电子邮件。
def test_emails_again assert_no_emails do # No emails should be sent from this block end end
注意: 此断言只是一个快捷方式
assert_emails 0, &block
源文件: 显示 | 在 GitHub 上
# File actionmailer/lib/action_mailer/test_helper.rb, line 63 def assert_no_emails(&block) assert_emails 0, &block end
assert_no_enqueued_emails(&block) 链接
断言没有电子邮件被加入队列以供稍后发送。
def test_no_emails assert_no_enqueued_emails ContactMailer.welcome.deliver_later assert_enqueued_emails 1 end
如果提供了块,则不应导致任何电子邮件被加入队列。
def test_no_emails assert_no_enqueued_emails do # No emails should be enqueued from this block end end
源文件: 显示 | 在 GitHub 上
# File actionmailer/lib/action_mailer/test_helper.rb, line 191 def assert_no_enqueued_emails(&block) assert_enqueued_emails 0, &block end
capture_emails(&block) 链接
返回块中发送的所有电子邮件。
def test_emails emails = capture_emails do ContactMailer.welcome.deliver_now end assert_equal "Hi there", emails.first.subject emails = capture_emails do ContactMailer.welcome.deliver_now ContactMailer.welcome.deliver_later end assert_equal "Hi there", emails.first.subject end
源文件: 显示 | 在 GitHub 上
# File actionmailer/lib/action_mailer/test_helper.rb, line 249 def capture_emails(&block) original_count = ActionMailer::Base.deliveries.size deliver_enqueued_emails(&block) new_count = ActionMailer::Base.deliveries.size diff = new_count - original_count ActionMailer::Base.deliveries.last(diff) end
deliver_enqueued_emails(queue: nil, at: nil, &block) 链接
发送所有已加入队列的电子邮件。如果给出了块,则发送在块持续期间加入队列的所有电子邮件。如果未给出块,则发送测试中到目前为止已加入队列的所有电子邮件。
def test_deliver_enqueued_emails deliver_enqueued_emails do ContactMailer.welcome.deliver_later end assert_emails 1 end def test_deliver_enqueued_emails_without_block ContactMailer.welcome.deliver_later deliver_enqueued_emails assert_emails 1 end
如果指定了 :queue 选项,则只执行已加入特定队列的电子邮件。
def test_deliver_enqueued_emails_with_queue deliver_enqueued_emails queue: :external_mailers do CustomerMailer.deliver_later_queue_name = :external_mailers CustomerMailer.welcome.deliver_later # will be performed EmployeeMailer.deliver_later_queue_name = :internal_mailers EmployeeMailer.welcome.deliver_later # will not be performed end assert_emails 1 end
如果指定了 :at 选项,则只发送立即发送或在给定时间之前发送的已加入队列的电子邮件。
源文件: 显示 | 在 GitHub 上
# File actionmailer/lib/action_mailer/test_helper.rb, line 231 def deliver_enqueued_emails(queue: nil, at: nil, &block) perform_enqueued_jobs(only: ->(job) { delivery_job_filter(job) }, queue: queue, at: at, &block) end