berrypod/test/support/conn_case.ex

defmodule BerrypodWeb.ConnCase do
  @moduledoc """
  This module defines the test case to be used by
  tests that require setting up a connection.

  Such tests rely on `Phoenix.ConnTest` and also
  import other functionality to make it easier
  to build common data structures and query the data layer.

  Finally, if the test case interacts with the database,
  we enable the SQL sandbox, so changes done to the database
  are reverted at the end of every test. If you are using
  PostgreSQL, you can even run database tests asynchronously
  by setting `use BerrypodWeb.ConnCase, async: true`, although
  this option is not recommended for other databases.
  """

  use ExUnit.CaseTemplate

  using do
    quote do
      # The default endpoint for testing
      @endpoint BerrypodWeb.Endpoint

      use BerrypodWeb, :verified_routes

      # Import conveniences for testing with connections
      import Plug.Conn
      import Phoenix.ConnTest
      import BerrypodWeb.ConnCase
    end
  end

  setup tags do
    pid = Berrypod.DataCase.setup_sandbox(tags)
    Berrypod.Settings.SettingsCache.invalidate_all()
    # Clear caches without re-warming from DB (which would bypass sandbox)
    BerrypodWeb.R.clear()
    Berrypod.Pages.PageCache.invalidate_all()
    Berrypod.Redirects.clear_cache()

    # Add sandbox metadata to conn so Phoenix.Ecto.SQL.Sandbox plug
    # can allow LiveView processes to access the test's DB connection
    metadata = Phoenix.Ecto.SQL.Sandbox.metadata_for(Berrypod.Repo, pid)
    encoded_metadata = Phoenix.Ecto.SQL.Sandbox.encode_metadata(metadata)

    conn =
      Phoenix.ConnTest.build_conn()
      |> Plug.Conn.put_req_header("user-agent", encoded_metadata)

    {:ok, conn: conn}
  end

  @doc """
  Setup helper that registers and logs in users.

      setup :register_and_log_in_user

  It stores an updated connection and a registered user in the
  test context.
  """
  def register_and_log_in_user(%{conn: conn} = context) do
    user = Berrypod.AccountsFixtures.user_fixture()
    scope = Berrypod.Accounts.Scope.for_user(user)

    opts =
      context
      |> Map.take([:token_authenticated_at])
      |> Enum.into([])

    %{conn: log_in_user(conn, user, opts), user: user, scope: scope}
  end

  @doc """
  Logs the given `user` into the `conn`.

  It returns an updated `conn`.
  """
  def log_in_user(conn, user, opts \\ []) do
    token = Berrypod.Accounts.generate_user_session_token(user)

    maybe_set_token_authenticated_at(token, opts[:token_authenticated_at])

    conn
    |> Phoenix.ConnTest.init_test_session(%{})
    |> Plug.Conn.put_session(:user_token, token)
  end

  defp maybe_set_token_authenticated_at(_token, nil), do: nil

  defp maybe_set_token_authenticated_at(token, authenticated_at) do
    Berrypod.AccountsFixtures.override_token_authenticated_at(token, authenticated_at)
  end
end