跳到內容 跳到搜尋

提供用於測試 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)

斷言已排入佇列的特定電子郵件，選擇性地與參數和/或參數相符。

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

如果以 Hash 提供 args，則匹配參數化電子郵件。

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(佇列：無，在：無，&區塊)

傳遞所有佇列中的電子郵件。如果給了一個區塊，傳遞在區塊期間佇列中的所有電子郵件。如果沒有給區塊，傳遞所有到目前為止測試中佇列的電子郵件。

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

如果指定：佇列選項，則僅會執行佇列在特定佇列中的電子郵件。

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

如果指定：在選項，則僅傳遞立即或在指定時間之前佇列的電子郵件。

來源：顯示 | 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