如何严谨测试依赖AMQP与AWS S3的Elixir应用？

一、核心思路：依赖注入+Mock/Stub+测试环境配置隔离 #

要解决测试时监督树启动失败、依赖外部服务的问题，核心是把外部服务的调用逻辑抽象出来，通过配置切换实现测试环境用Mock/Stub替代真实客户端，同时阻止测试时启动真实的AMQP连接进程。

二、具体实现方案 #

1. 架构调整：抽象外部服务依赖 #

把AMQP和S3的操作封装成独立的行为（Behaviour），让业务代码依赖行为而非具体实现，这样测试时可以轻松替换成Mock实现。

AMQP行为抽象示例

# lib/amqp_client.ex
defmodule MyApp.AMQPClient do
  @callback connect() :: {:ok, pid()} | {:error, term()}
  @callback publish(pid(), String.t(), String.t()) :: :ok | {:error, term()}
end

# lib/amqp_client/real.ex
defmodule MyApp.AMQPClient.Real do
  @behaviour MyApp.AMQPClient

  def connect do
    AMQP.Connection.open()
  end

  def publish(conn, exchange, payload) do
    # 真实的消息发布逻辑
  end
end

S3行为抽象示例

# lib/s3_client.ex
defmodule MyApp.S3Client do
  @callback upload(String.t(), binary()) :: {:ok, map()} | {:error, term()}
end

# lib/s3_client/real.ex
defmodule MyApp.S3Client.Real do
  @behaviour MyApp.S3Client

  def upload(bucket, data) do
    ExAws.S3.put_object(bucket, "key", data) |> ExAws.request()
  end
end

2. 配置切换：测试环境使用Mock实现 #

在config/test.exs中配置测试环境使用Mock客户端：

# config/test.exs
config :my_app, amqp_client: MyApp.AMQPClient.Mock
config :my_app, s3_client: MyApp.S3Client.Mock

业务代码中通过配置获取客户端模块，避免硬编码依赖：

client = Application.get_env(:my_app, :amqp_client)
client.connect()

3. 选择合适的Mock库 #

推荐使用mox（Elixir官方推荐，类型安全）实现AMQP的Mock逻辑：

• 安装：在mix.exs的test依赖中添加

defp deps do
  [
    {:mox, "~> 1.0", only: :test}
  ]
end

• 定义Mock模块：

# test/support/amqp_client_mock.ex
defmodule MyApp.AMQPClient.Mock do
  use Mox, only: [connect: 0, publish: 3]
  @behaviour MyApp.AMQPClient
end

• 测试中设置预期：

test "发布消息到AMQP" do
  MyApp.AMQPClient.Mock
  |> expect(:connect, fn -> {:ok, :mock_conn} end)
  |> expect(:publish, fn :mock_conn, "exchange", "payload" -> :ok end)

  # 调用业务代码
  assert MyApp.MyService.publish_message("payload") == :ok
end

4. 抑制测试时AMQP连接启动 #

有两种可靠方式阻止测试环境启动真实的AMQP监督进程：

方式一：条件启动监督树

修改lib/my_app/application.ex，根据环境判断是否启动AMQP相关监督者：

def start(_type, _args) do
  children = [
    # 其他通用子进程
    if Application.get_env(:my_app, :env) != :test do
      MyApp.AMQP.Supervisor
    end
  ] |> Enum.filter(& &1)

  Supervisor.start_link(children, strategy: :one_for_one)
end

方式二：测试环境替换监督者

在config/test.exs中把AMQP监督者替换成空进程：

config :my_app, amqp_supervisor: MyApp.AMQP.MockSupervisor

然后定义一个空的监督者：

# test/support/amqp_mock_supervisor.ex
defmodule MyApp.AMQP.MockSupervisor do
  use Supervisor

  def start_link(_opts) do
    Supervisor.start_link(__MODULE__, [], name: __MODULE__)
  end

  def init(_opts) do
    Supervisor.init([], strategy: :one_for_one)
  end
end

5. S3的Stub方案 #

对于S3，除了mox，还可以用ExAws官方提供的ex_aws_mock做Stub：

• 安装：在mix.exs的test依赖中添加

defp deps do
  [
    {:ex_aws_mock, "~> 2.0", only: :test}
  ]
end

• 测试中使用：

test "上传文件到S3" do
  ExAws.Mock.start()

  ExAws.Mock
  |> expect(:request, fn %ExAws.Operation.S3{action: :put_object}, _opts ->
    {:ok, %{status_code: 200}}
  end)

  assert MyApp.MyService.upload_to_s3("bucket", "data") == {:ok, %{status_code: 200}}
end

三、方案总结 #

最可靠的组合是：

1. 架构调整：用Behaviour抽象AMQP和S3的操作，实现依赖反转
2. Mock/Stub库：mox处理AMQP的Mock逻辑，ex_aws_mock处理S3的Stub
3. 配置隔离：测试环境配置使用Mock客户端，通过条件判断或替换监督者阻止真实AMQP连接启动
4. 依赖注入：业务代码通过配置获取客户端模块，避免硬编码依赖

内容的提问来源于stack exchange，提问作者Stephan Meijer