如何使用 rspec 测试 ActionMailer Deliver_later

如果我理解正确，你可以这样做：

message_delivery = instance_double(ActionMailer::MessageDelivery)
expect(ServiceMailer).to receive(:new_user).with(@user).and_return(message_delivery)
allow(message_delivery).to receive(:deliver_later)

关键是您需要以某种方式为 deliver_later 提供双精度。

---

使用 ActiveJob 和 rspec-rails 3.4+，您可以像这样使用 have_enqueued_job：

expect { 
  YourMailer.your_method.deliver_later 
  # or any other method that eventually would trigger mail enqueuing
}.to( 
  have_enqueued_job.on_queue('mailers').with(
    # `with` isn't mandatory, but it will help if you want to make sure is
    # the correct enqueued mail.
    'YourMailer', 'your_method', 'deliver_now', any_param_you_want_to_check
  )
)

还要仔细检查您拥有的 config/environments/test.rb：

config.action_mailer.delivery_method = :test
config.active_job.queue_adapter = :test

另一种选择是运行内联作业：

config.active_job.queue_adapter = :inline

但请记住，这会影响您的测试套件的整体性能，因为您的所有作业都会在它们入队后立即运行。

---

如果您发现这个问题，但使用的是 ActiveJob 而不是简单地单独使用 DelayedJob，并且使用的是 Rails 5，我建议在 config/environments/test.rb 中配置 ActionMailer：

config.active_job.queue_adapter = :inline

（这是 Rails 5 之前的默认行为）

---

我会添加我的答案，因为其他人对我来说都不够好：

1) 无需模拟 Mailer：Rails 基本上已经为您做到了。

2）没有必要真正触发电子邮件的创建：这会消耗时间并减慢您的测试！

这就是为什么在 environments/test.rb 中您应该设置以下选项：

config.action_mailer.delivery_method = :test
config.active_job.queue_adapter = :test

再次重申：不要使用 deliver_now 发送电子邮件，而始终使用 deliver_later。这可以防止您的用户等待电子邮件的有效传递。如果您在生产中没有 sidekiq、sucker_punch 或任何其他，只需使用 config.active_job.queue_adapter = :async。 async 或 inline 用于开发环境。

给定测试环境的以下配置，您的电子邮件将始终排队并且永远不会执行交付：这可以防止您模拟它们并且您可以检查它们是否正确排队。

在您的测试中，始终将测试分成两部分：1) 一个单元测试来检查电子邮件是否正确入队并使用正确的参数 2) 一个单元测试来检查邮件的主题、发件人、收件人和内容是否正确.

鉴于以下情况：

class User
  after_update :send_email

  def send_email
    ReportMailer.update_mail(id).deliver_later
  end
end

编写测试以检查电子邮件是否正确排队：

include ActiveJob::TestHelper
expect { user.update(name: 'Hello') }.to have_enqueued_job(ActionMailer::DeliveryJob).with('ReportMailer', 'update_mail', 'deliver_now', user.id)

并为您的电子邮件编写单独的测试

Rspec.describe ReportMailer do
    describe '#update_email' do
      subject(:mailer) { described_class.update_email(user.id) }
      it { expect(mailer.subject).to eq 'whatever' }
      ...
    end
end

您已经准确地测试了您的电子邮件已入队，而不是一般工作。

你的测试很快

你不需要嘲笑

当您编写系统测试时，请随意决定是否真的要在那里发送电子邮件，因为速度不再那么重要了。我个人喜欢配置如下：

RSpec.configure do |config|
  config.around(:each, :mailer) do |example|
    perform_enqueued_jobs do
      example.run
    end
  end
end

并将 :mailer 属性分配给我想要实际发送电子邮件的测试。

有关如何在 Rails 中正确配置电子邮件的更多信息，请阅读本文：https://medium.com/@coorasse/the-correct-emails-configuration-in-rails-c1d8418c0bfd

---

添加这个：

# spec/support/message_delivery.rb
class ActionMailer::MessageDelivery
  def deliver_later
    deliver_now
  end
end

参考：http://mrlab.sk/testing-email-delivery-with-deliver-later.html

---

一个更好的解决方案（比猴子补丁 deliver_later）是：

require 'spec_helper'
include ActiveJob::TestHelper

describe YourObject do
  around { |example| perform_enqueued_jobs(&example) }

  it "sends an email" do
    expect { something_that.sends_an_email }.to change(ActionMailer::Base.deliveries, :length)
  end
end

around { |example| perform_enqueued_jobs(&example) } 确保在检查测试值之前运行后台任务。

---

我有同样的疑问，并以一种不太冗长（单行）的方式解决了 this answer

expect(ServiceMailer).to receive_message_chain(:new_user, :deliver_later).with(@user).with(no_args)

请注意，最后一个 with(no_args) 是必不可少的。

但是，如果您不关心是否正在调用 deliver_later，只需执行以下操作：

expect(ServiceMailer).to expect(:new_user).with(@user).and_call_original

---

一个简单的方法是：

expect(ServiceMailer).to(
  receive(:new_user).with(@user).and_call_original
)
# subject

---

这个答案是针对 Rails 测试的，而不是针对 rspec ...

如果您像这样使用 delivery_later：

# app/controllers/users_controller.rb 

class UsersController < ApplicationController 
  … 
  def create 
    … 
    # Yes, Ruby 2.0+ keyword arguments are preferred 
    UserMailer.welcome_email(user: @user).deliver_later 
  end 
end 

如果电子邮件已添加到队列中，您可以检查您的测试：

# test/controllers/users_controller_test.rb 

require 'test_helper' 

class UsersControllerTest < ActionController::TestCase 
  … 
  test 'email is enqueued to be delivered later' do 
    assert_enqueued_jobs 1 do 
      post :create, {…} 
    end 
  end 
end 

如果你这样做，你会惊讶于失败的测试告诉你 assert_enqueued_jobs 没有定义供我们使用。

这是因为我们的测试继承自 ActionController::TestCase，在撰写本文时，它不包括 ActiveJob::TestHelper。

但我们可以快速解决这个问题：

# test/test_helper.rb 

class ActionController::TestCase 
  include ActiveJob::TestHelper 
  … 
end 

参考：https://www.engineyard.com/blog/testing-async-emails-rails-42

---

对于最近的 Google 员工：

allow(YourMailer).to receive(:mailer_method).and_call_original

expect(YourMailer).to have_received(:mailer_method)

---

我认为测试这一点的更好方法之一是检查作业状态以及基本响应 json 检查，例如：

expect(ActionMailer::MailDeliveryJob).to have_been_enqueued.on_queue('mailers').with('mailer_name', 'mailer_method', 'delivery_now', { :params => {}, :args=>[] } )

---

我来这里是为了寻找完整测试的答案，所以，不仅仅是询问是否有一封邮件等待发送，此外，还询问其收件人、主题...等

我有一个解决方案，而不是来自 here，但有一点改变：

正如它所说，curial部分是

mail = perform_enqueued_jobs { ActionMailer::DeliveryJob.perform_now(*enqueued_jobs.first[:args]) }

问题是mailer接收的参数，在这种情况下，与生产中接收的参数不同，生产中，如果第一个参数是模型，现在在测试中会收到一个哈希，所以会崩溃

enqueued_jobs.first[:args]
["UserMailer", "welcome_email", "deliver_now", {"_aj_globalid"=>"gid://forjartistica/User/1"}]

因此，如果我们将邮件程序称为 UserMailer.welcome_email(@user).deliver_later，则邮件程序在生产中会收到一个用户，但在测试中会收到 {"_aj_globalid"=>"gid://forjartistica/User/1"}

所有评论都将不胜感激，我发现的不那么痛苦的解决方案是改变我调用邮件的方式，传递模型的 id 而不是模型：

UserMailer.welcome_email(@user.id).deliver_later

---

这个答案有点不同，但在 Rails API 发生新变化或您想要交付的方式发生变化（如使用 deliver_now 而不是 deliver_later）等情况下可能会有所帮助。

我大部分时间所做的是将邮件程序作为依赖项传递给我正在测试的方法，但我不会从 rails 传递邮件程序，而是传递一个对象，该对象将以“我想”...

例如，如果我想在用户注册后检查我是否发送了正确的邮件......我可以这样做......

class DummyMailer
  def self.send_welcome_message(user)
  end
end

it "sends a welcome email" do
  allow(store).to receive(:create).and_return(user)
  expect(mailer).to receive(:send_welcome_message).with(user)
  register_user(params, store, mailer)
end

然后在我将调用该方法的控制器中，我将编写该邮件程序的“真实”实现......

class RegistrationsController < ApplicationController
  def create
    Registrations.register_user(params[:user], User, Mailer)
    # ...
  end

  class Mailer
    def self.send_welcome_message(user)
      ServiceMailer.new_user(user).deliver_later
    end
  end
end

通过这种方式，我觉得我正在测试我正在使用正确的数据（参数）向正确的对象发送正确的消息。我只需要创建一个没有逻辑的非常简单的对象，只需要知道如何调用 ActionMailer。

我更喜欢这样做，因为我更喜欢对我拥有的依赖项进行更多控制。这是 "Dependency inversion principle" 的一个例子。

我不确定这是否符合您的口味，但这是解决问题的另一种方法=)。

---