memEx/test/support/conn_case.ex

78 lines
2.2 KiB
Elixir
Raw Normal View History

2022-07-25 19:31:54 -04:00
defmodule MemexWeb.ConnCase do
2021-03-11 21:12:55 -05:00
@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
2022-07-25 19:31:54 -04:00
by setting `use MemexWeb.ConnCase, async: true`, although
2021-03-11 21:12:55 -05:00
this option is not recommended for other databases.
"""
use ExUnit.CaseTemplate
2022-07-25 19:31:54 -04:00
import Memex.Fixtures
2022-01-22 20:44:38 -05:00
alias Ecto.Adapters.SQL.Sandbox
2022-07-25 19:31:54 -04:00
alias Memex.{Accounts, Accounts.User, Repo}
2021-03-11 21:12:55 -05:00
using do
quote do
# Import conveniences for testing with connections
import Plug.Conn
import Phoenix.ConnTest
2022-07-25 19:31:54 -04:00
import Memex.Fixtures
import MemexWeb.ConnCase
2021-03-11 21:12:55 -05:00
2022-07-25 19:31:54 -04:00
alias MemexWeb.Router.Helpers, as: Routes
2021-03-11 21:12:55 -05:00
# The default endpoint for testing
2022-07-25 19:31:54 -04:00
@endpoint MemexWeb.Endpoint
2021-03-11 21:12:55 -05:00
end
end
setup tags do
2022-07-25 19:31:54 -04:00
pid = Sandbox.start_owner!(Memex.Repo, shared: not tags[:async])
2022-01-22 20:44:38 -05:00
on_exit(fn -> Sandbox.stop_owner(pid) end)
2021-03-11 21:12:55 -05:00
{:ok, conn: Phoenix.ConnTest.build_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.
"""
2022-02-25 21:53:15 -05:00
@spec register_and_log_in_user(%{conn: Plug.Conn.t()}) ::
2022-11-17 22:32:27 -05:00
%{conn: Plug.Conn.t(), user: User.t()}
2021-03-11 21:12:55 -05:00
def register_and_log_in_user(%{conn: conn}) do
2022-11-17 22:32:27 -05:00
user = user_fixture() |> confirm_user()
%{conn: log_in_user(conn, user), user: user}
2022-02-25 21:53:15 -05:00
end
2022-02-25 21:53:15 -05:00
@spec confirm_user(User.t()) :: User.t()
def confirm_user(user) do
{:ok, %{user: user}} = user |> Accounts.confirm_user_multi() |> Repo.transaction()
2022-02-25 21:53:15 -05:00
user
2021-03-11 21:12:55 -05:00
end
@doc """
Logs the given `user` into the `conn`.
It returns an updated `conn`.
"""
def log_in_user(conn, user) do
2022-07-25 19:31:54 -04:00
token = Memex.Accounts.generate_user_session_token(user)
2021-03-11 21:12:55 -05:00
conn
|> Phoenix.ConnTest.init_test_session(%{})
|> Plug.Conn.put_session(:user_token, token)
end
end