prop/test/support/conn_case.ex
Graham McIntire 933397d246
Some checks failed
Build and Push / Build and Push Docker Image (push) Failing after 6m41s
chore: remove all APRS-related code and fix credo issues
- Delete Microwaveprop.Aprs, AprsRepo, Aprs.PathParser modules
- Delete Mix.Tasks.Calibrate.Aprs144 mix task
- Remove AprsRepo from application.ex children and config files
- Remove APRS test files and sandbox references in test_helper
- Fix credo nested-module alias suggestions in conn_case.ex
2026-08-04 12:12:28 -05:00

101 lines
3 KiB
Elixir

defmodule MicrowavepropWeb.ConnCase do
@moduledoc """
Test case template for HTTP connection tests.
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 MicrowavepropWeb.ConnCase, async: true`, although
this option is not recommended for other databases.
"""
use ExUnit.CaseTemplate
alias Microwaveprop.Accounts
alias Microwaveprop.Accounts.Scope
alias Microwaveprop.Accounts.User
alias Microwaveprop.AccountsFixtures
alias Microwaveprop.DataCase
alias Microwaveprop.Propagation.ScoreCache
alias Microwaveprop.Weather.GridCache
alias Phoenix.Ecto.SQL.Sandbox
using do
quote do
use MicrowavepropWeb, :verified_routes
import MicrowavepropWeb.ConnCase
import Phoenix.ConnTest
import Plug.Conn
# The default endpoint for testing
@endpoint MicrowavepropWeb.Endpoint
# Import conveniences for testing with connections
end
end
setup tags do
owner = DataCase.setup_sandbox(tags)
DataCase.reset_score_files()
DataCase.stub_nexrad_default()
GridCache.clear()
ScoreCache.clear()
# Stamp the sandbox metadata onto the "user-agent" header so a
# LiveView's connected mount (a separate process from this one, per
# `MicrowavepropWeb.SandboxHook`) can see this test's transaction.
metadata = Sandbox.metadata_for(Microwaveprop.Repo, owner)
conn = Plug.Conn.put_req_header(Phoenix.ConnTest.build_conn(), "user-agent", Sandbox.encode_metadata(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.
"""
@spec register_and_log_in_user(map()) :: %{conn: Plug.Conn.t(), user: User.t(), scope: Scope.t()}
def register_and_log_in_user(%{conn: conn} = context) do
user = AccountsFixtures.user_fixture()
scope = Scope.for_user(user)
opts =
context
|> Map.take([:token_authenticated_at])
|> Enum.to_list()
%{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`.
"""
@spec log_in_user(Plug.Conn.t(), User.t(), Keyword.t()) :: Plug.Conn.t()
def log_in_user(conn, user, opts \\ []) do
token = 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
AccountsFixtures.override_token_authenticated_at(token, authenticated_at)
end
end