测试Elixir / Phoenix服务模块

Question

我一直在玩Elixir / Phoenix第三方模块。 （用于从第三方服务获取某些数据的模块）其中一个模块如下所示：

module TwitterService do
  @twitter_url "https://api.twitter.com/1.1"

  def fetch_tweets(user) do
     # The actual code to fetch tweets
     HTTPoison.get(@twitter_url)
     |> process_response
  end      

  def process_response({:ok, resp}) do
    {:ok, Poison.decode! resp}
  end

  def process_response(_fail), do: {:ok, []}
end

在我的问题中，实际数据无关紧要。所以现在，我对如何在测试中动态配置@twitter_url模块变量感兴趣，以使某些测试失败。例如：

module TwitterServiceTest
  test "Module returns {:ok, []} when Twitter API isn't available"
    # I'd like this to be possible ( coming from the world of Rails )
    TwitterService.configure(:twitter_url, "new_value") # This line isn't possible
    # Now the TwiterService shouldn't get anything from the url
    tweets = TwitterService.fetch_tweets("test")
    assert {:ok, []} = tweets
  end
end

我怎样才能做到这一点？注意：我知道我可以使用:configs在@twiter_url和dev环境中单独配置test，但我希望能够测试来自Twitter API的真实响应，这将改变整个测试环境中的URL。 我想出的解决方案之一是

def fetch_tweets(user, opts \\ []) do
  _fetch_tweets(user, opts[:fail_on_test] || false)
end

defp _fetch_tweets(user, [fail_on_test: true]) do
  # Fails
end

defp _fetch_tweets(user, [fail_on_test: false]) do
  # Normal fetching
end

但这似乎是愚蠢和愚蠢的，必须有一个更好的解决方案。

Answer 1

正如José在Mocks And Explicit Contracts中所建议的那样，最好的方法可能是使用依赖注入：

module TwitterService do
  @twitter_url "https://api.twitter.com/1.1"

  def fetch_tweets(user, service_url \\ @twitter_url) do
     # The actual code to fetch tweets
     service_url
     |> HTTPoison.get()
     |> process_response
  end      

  ...
end

现在在测试中，您只需在必要时注入另一个依赖项

# to test against real service
fetch_tweets(user)

# to test against mocked service
fetch_tweets(user, SOME_MOCK_URL)

这种方法还可以使将来更容易插入不同的服务。处理器实现不应该依赖于它的底层服务，假设服务遵循一些契约（在这种特定情况下用json给出一个url响应。）

Answer 2

config听起来像是一个很好的方式。您可以在测试中在运行时修改配置中的值，然后在测试后将其恢复。

首先，在您的实际代码中，使用@twitter_url而不是Application.get_env(:my_app, :twitter_url)。

然后，在测试中，您可以使用这样的包装函数：

def with_twitter_url(new_twitter_url, func) do
  old_twitter_url = Application.get_env(:my_app, :twitter_url)
  Application.set_env(:my_app, :twitter_url, new_twitter_url)
  func.()
  Application.set_env(:my_app, :twitter_url, old_twitter_url)
end

现在在你的测试中，做：

with_twitter_url "<new url>", fn ->
  # All calls to your module here will use the new url.
end

确保您没有使用异步测试，因为此技术会修改全局环境。