blockscout/apps/ethereum_jsonrpc/test/support/ethereum_jsonrpc/case.ex

defmodule EthereumJSONRPC.Case do
  @moduledoc """
  Adds `json_rpc_named_arguments` and `subscribe_named_arguments` to context.

  ## `json_rpc_named_arguments`

  Reads `ETHEREUM_JSONRPC_JSON_RPC_TRANSPORT` environment variable to determine which module to use
  `:json_rpc_named_arguments` `:transport`:

  * `EthereumJSONRPC.HTTP` - Allow testing of HTTP-only behavior like status codes
  * `EthereumJSONRPC.Mox` - mock, transport neutral responses.  The default for local testing.
  * `EthereumJSONRPC.WebSocket` - Allow testing of WebSocket-only behavior like subscriptions

  When `ETHEREUM_JSONRPC_JSON_RPC_TRANSPORT` is `EthereumJSONRPC.HTTP`, then reads `ETHEREUM_JSONRPC_HTTP_URL`
  environment variable to determine `:json_rpc_named_arguments` `:transport_options` `:url`.  Failure to set
  `ETHEREUM_JSONRPC_HTTP_URL` in this case will raise an `ArgumentError`.

  * `EthereumJSONRPC.HTTP.HTTPoison` - HTTP responses from calls to real chain URLs
  * `EthereumJSONRPC.HTTP.Mox` - mock HTTP responses, so can be used for HTTP-only behavior like status codes.

  ## `subscribe_named_arguments`

  Reads `ETHEREUM_JSONRPC_
  """

  use ExUnit.CaseTemplate

  require Logger

  setup do
    module("ETHEREUM_JSONRPC_CASE", "EthereumJSONRPC.Case.Parity.Mox").setup()
  end

  def log_bad_gateway(under_test, assertions) do
    case under_test.() do
      {:error, {:bad_gateway, url}} -> Logger.error(fn -> ["Bad Gateway to ", url, ".  Check CloudFlare."] end)
      other -> assertions.(other)
    end
  end

  def module(environment_variable, default) do
    alias =
      environment_variable
      |> System.get_env()
      |> Kernel.||(default)

    module = Module.concat([alias])

    with {:error, reason} <- Code.ensure_loaded(module) do
      raise ArgumentError,
            "Could not load `#{environment_variable}` environment variable module (#{module}) due to #{reason}"
    end

    module
  end
end