Perform Enqueued Mail Job in Rails Tests

test_helper.rb

# Extend in your test_helper.rb or any other `/supprot` setup you have.

class ActiveSupport::TestCase

  ##
  # === NOTICE: 
  #     Ensure you have `ActionMailer::TestHelper` in the test class ..
  #
  # This method performs any enqueued job during tests manually,
  # Helpful when testing the queueing of your jobs then the result of their execution.
  #
  # === Author: (abarrak)
  # 
  # === returns: the result of the job execution.
  #
  # === example: (integration test for ActiveJob/ActionMailer)
  #
  # test "my action mailer" do
  #   post signup_url, params: @valid_params
  #   
  #   # .. other assertions ..
  #   
  #   assert_enqueued_jobs 1
  #   assert_enqueued_emails 1
  #   assert_no_emails
  #   assert_empty ActionMailer::Base.deliveries
  # 
  #   perform_lastest_mail_job
  # 
  #   assert_emails 1
  #   assert_not_empty ActionMailer::Base.deliveries
  #   mail = ActionMailer::Base.deliveries.last
  #   assert_not_nil mail
  #   assert_equal mail.to, [user.email]
  #   assert_equal mail.from, ["no-replay@example.com"]
  #   # ....
  # end
  #
  # ====
  def perform_lastest_mail_job
    last_job = enqueued_jobs.first[:args]
    gid = last_job.pop['_aj_globalid']
    last_job << GlobalID::Locator.locate(gid)
    perform_enqueued_jobs { ActionMailer::DeliveryJob.perform_now(*last_job) }
  end
end

Links

• lib/action_mailer/message_delivery.rb
• actionmailer/test/message_delivery_test.rb
• lib/action_mailer/delivery_job.rb
• lib/action_mailer/test_helper.rb
• rails/globalid
• Testing ActionMailer "deliver_later" with rspec
• Testing Mailers in Rails