Module: ActionMailer::TestHelper

Includes:
ActiveJob::TestHelper
Included in:
ActionMailer::TestCase::Behavior
Defined in:
actionmailer/lib/action_mailer/test_helper.rb

Overview

Provides helper methods for testing Action Mailer, including #assert_emails and #assert_no_emails.

Instance Method Summary collapse

Methods included from ActiveJob::TestHelper

#after_teardown, #assert_enqueued_jobs, #assert_enqueued_with, #assert_no_enqueued_jobs, #assert_no_performed_jobs, #assert_performed_jobs, #assert_performed_with, #before_setup, #perform_enqueued_jobs, #queue_adapter, #queue_adapter_for_test

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included

Instance Method Details

#assert_emails(number, &block) ⇒ Object

Asserts that the number of emails sent matches the given number.

def test_emails
  assert_emails 0
  ContactMailer.welcome.deliver_now
  assert_emails 1
  ContactMailer.welcome.deliver_now
  assert_emails 2
end

If a block is passed, that block should cause the specified number of emails to be sent.

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



34
35
36
37
38
39
40
41
42
43
 
# File 'actionmailer/lib/action_mailer/test_helper.rb', line 34

def assert_emails(number, &block)
  if block_given?
    original_count = ActionMailer::Base.deliveries.size
    perform_enqueued_jobs(only: ->(job) { delivery_job_filter(job) }, &block)
    new_count = ActionMailer::Base.deliveries.size
    assert_equal number, new_count - original_count, "#{number} emails expected, but #{new_count - original_count} were sent"
  else
    assert_equal number, ActionMailer::Base.deliveries.size
  end
end

#assert_enqueued_email_with(mailer, method, args: nil, queue: "mailers", &block) ⇒ Object

Asserts that a specific email has been enqueued, optionally matching arguments.

def test_email
  ContactMailer.welcome.deliver_later
  assert_enqueued_email_with ContactMailer, :welcome
end

def test_email_with_arguments
  ContactMailer.welcome("Hello", "Goodbye").deliver_later
  assert_enqueued_email_with ContactMailer, :welcome, args: ["Hello", "Goodbye"]
end

If a block is passed, that block should cause the specified email to be enqueued.

def test_email_in_block
  assert_enqueued_email_with ContactMailer, :welcome do
    ContactMailer.welcome.deliver_later
  end
end

If args is provided as a Hash, a parameterized email is matched.

def test_parameterized_email
  assert_enqueued_email_with ContactMailer, :welcome,
    args: {email: '[email protected]'} do
    ContactMailer.with(email: '[email protected]').welcome.deliver_later
  end
end



126
127
128
129
130
131
132
133
 
# File 'actionmailer/lib/action_mailer/test_helper.rb', line 126

def assert_enqueued_email_with(mailer, method, args: nil, queue: "mailers", &block)
  args = if args.is_a?(Hash)
    [mailer.to_s, method.to_s, "deliver_now", params: args, args: []]
  else
    [mailer.to_s, method.to_s, "deliver_now", args: Array(args)]
  end
  assert_enqueued_with(job: mailer.delivery_job, args: args, queue: queue, &block)
end

#assert_enqueued_emails(number, &block) ⇒ Object

Asserts that the number of emails enqueued for later delivery matches the given number.

def test_emails
  assert_enqueued_emails 0
  ContactMailer.welcome.deliver_later
  assert_enqueued_emails 1
  ContactMailer.welcome.deliver_later
  assert_enqueued_emails 2
end

If a block is passed, that block should cause the specified number of emails to be enqueued.

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



92
93
94
 
# File 'actionmailer/lib/action_mailer/test_helper.rb', line 92

def assert_enqueued_emails(number, &block)
  assert_enqueued_jobs(number, only: ->(job) { delivery_job_filter(job) }, &block)
end

#assert_no_emails(&block) ⇒ Object

Asserts that no emails have been sent.

def test_emails
  assert_no_emails
  ContactMailer.welcome.deliver_now
  assert_emails 1
end

If a block is passed, that block should not cause any emails to be sent.

def test_emails_again
  assert_no_emails do
    # No emails should be sent from this block
  end
end

Note: This assertion is simply a shortcut for:

assert_emails 0, &block



64
65
66
 
# File 'actionmailer/lib/action_mailer/test_helper.rb', line 64

def assert_no_emails(&block)
  assert_emails 0, &block
end

#assert_no_enqueued_emails(&block) ⇒ Object

Asserts that no emails are enqueued for later delivery.

def test_no_emails
  assert_no_enqueued_emails
  ContactMailer.welcome.deliver_later
  assert_enqueued_emails 1
end

If a block is provided, it should not cause any emails to be enqueued.

def test_no_emails
  assert_no_enqueued_emails do
    # No emails should be enqueued from this block
  end
end



150
151
152
 
# File 'actionmailer/lib/action_mailer/test_helper.rb', line 150

def assert_no_enqueued_emails(&block)
  assert_enqueued_emails 0, &block
end