unify fake mailers

Author: joaquinco

test/support/bamboo_fake_mailer.ex

@@ -1,19 +1,21 @@
-defmodule Support.SwooshFakeMailer do
-  @moduledoc false
-
-  # Overrides the Swoosh `deliver!/1` function.
-  #
-  # Instead of sending an email it puts the fields in a mailbox so they can be
-  # received in the test.
-  #
-  # Swoosh does include Swoosh.Adapters.Test, but its behaviour seems unreliable
-  # in our case because we are catching then sending mail, meaning tests need
-  # a lot of Process.sleep/1 calls to wait for mailboxes.
-  #
-  # It's also possible to use Swoosh.Adapters.Local and
-  # Swoosh.Adapter.Local.Storage.Memory which you can directly inspect. This
-  # could be used to check for specific mail.
+defmodule BoomNotifier.FakeMailer do
+  @moduledoc """
+  Fake mailer for Swoosh and Bamboo
+  """
+
+  @doc """
+  Bamboo's email deliver that just sends message back
+  """
+  def deliver_later!(email) do
+    # Use email.to to specify test target pid
+    email.to
+    |> to_pid()
+    |> send_back(email.to, email.from, email)
+  end
 
+  @doc """
+  Swoosh's email deliver that just sends message back
+  """
   def deliver!(email) do
     # Swoosh uses a {name, address} tuple for to and from.
     # The `name` will default to `""` when not specified in the email creation,
@@ -23,25 +25,20 @@ defmodule Support.SwooshFakeMailer do
     # this crashes OTP 21, specifically getting the from_addr via tuple match,
     # so get from_addr via elem/2 separately...
     # %{to: [{_name, email_to}], from: {_, from_addr}} = email
-    %{to: [{_name, email_to}]} = email
+    %{to: [{_name, email_to}], from: from} = email
+    email_from = elem(from, 1)
 
     # Use email.to to specify test target pid
-    pid =
-      email_to
-      |> String.to_atom()
-      |> Process.whereis()
-
-    send_back(pid, email)
+    email_to
+    |> to_pid()
+    |> send_back(email_to, email_from, email)
   end
 
-  def send_back(nil, _), do: nil
-
-  def send_back(pid, email) do
-    %{to: [{_name, email_to}], from: from} = email
-    from_addr = elem(from, 1)
+  defp send_back(nil, _, _, _), do: nil
 
+  defp send_back(pid, email_to, email_from, email) do
     send(pid, {:email_subject, email.subject})
-    send(pid, {:email_from, from_addr})
+    send(pid, {:email_from, email_from})
     send(pid, {:email_to, email_to})
     send(pid, {:email_text_body, text_body_lines(email.text_body)})
     send(pid, {:email_html_body, email.html_body})
@@ -52,4 +49,13 @@ defmodule Support.SwooshFakeMailer do
     |> Enum.map(&String.trim/1)
     |> Enum.reject(&(String.length(&1) == 0))
   end
+
+  defp to_pid(value) do
+    value
+    |> String.to_existing_atom()
+    |> Process.whereis()
+  rescue
+    # raised by to_existing_atom
+    ArgumentError -> nil
+  end
 end

test/support/fake_swoosh_mailer.ex test/support/fake_mailer.ex

@@ -37,7 +37,7 @@ defmodule ErrorInfoTest do
     use BoomNotifier,
       notifier: BoomNotifier.MailNotifier.Bamboo,
       options: [
-        mailer: Support.BambooFakeMailer,
+        mailer: BoomNotifier.FakeMailer,
         from: "[email protected]",
         to: "[email protected]",
         subject: "BOOM error caught"

test/unit/error_info_test.exs

@@ -48,11 +48,11 @@ defmodule MailerNotifierTest do
   #       since we are redefining the router modules for each notifier.
 
   notifiers = [
-    {"Bamboo", BoomNotifier.MailNotifier.Bamboo, Support.BambooFakeMailer},
-    {"Swoosh", BoomNotifier.MailNotifier.Swoosh, Support.SwooshFakeMailer}
+    {"Bamboo", BoomNotifier.MailNotifier.Bamboo},
+    {"Swoosh", BoomNotifier.MailNotifier.Swoosh}
   ]
 
-  for {name, mail_notifier_module, fake_mailer_module} <- notifiers do
+  for {name, mail_notifier_module} <- notifiers do
     describe name do
       # Disable "redefining module" warnings, we have intent.
       :elixir_config.put(:ignore_module_conflict, true)
@@ -62,7 +62,7 @@ defmodule MailerNotifierTest do
         import Phoenix.Controller
 
         @mail_notifier_module mail_notifier_module
-        @fake_mailer_module fake_mailer_module
+        @fake_mailer_module BoomNotifier.FakeMailer
         use BoomNotifier,
           notifier: @mail_notifier_module,
           options: [
@@ -95,7 +95,7 @@ defmodule MailerNotifierTest do
         use Phoenix.Router
 
         @mail_notifier_module mail_notifier_module
-        @fake_mailer_module fake_mailer_module
+        @fake_mailer_module BoomNotifier.FakeMailer
         use BoomNotifier,
           notifier: @mail_notifier_module,
           options: [
@@ -376,7 +376,7 @@ defmodule MailerNotifierTest do
   describe "MailNotifier.validate_config" do
     setup do
       options = [
-        mailer: Support.BambooFakeMailer,
+        mailer: BoomNotifier.FakeMailer,
         from: "boom@mailer",
         to: "user@mail",
         subject: "boom mail",