Graham McIntire
d85b42c3ee
Production code (lib/): all Process.sleep calls replaced with receive after timeout - retry backoff, exponential backoff, batch delays, poll intervals, and settle waits. Test code: poll_until helpers across 4 agent channel test files now use receive after instead of Process.sleep. Various standalone Process.sleep(N) calls replaced with :sys.get_state sync barriers or receive after. deferred_discovery test simulation sleeps reduced 500ms -> 30ms.
144 lines
4.1 KiB
Elixir
144 lines
4.1 KiB
Elixir
defmodule ToweropsWeb.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 ToweropsWeb.ConnCase, async: true`, although
|
|
this option is not recommended for other databases.
|
|
"""
|
|
|
|
use ExUnit.CaseTemplate
|
|
|
|
alias Towerops.Accounts.Scope
|
|
|
|
using do
|
|
quote do
|
|
use ToweropsWeb, :verified_routes
|
|
|
|
import Phoenix.ConnTest
|
|
import Plug.Conn
|
|
import ToweropsWeb.ConnCase
|
|
import ToweropsWeb.LiveViewTestHelpers
|
|
# The default endpoint for testing
|
|
@endpoint ToweropsWeb.Endpoint
|
|
end
|
|
end
|
|
|
|
setup tags do
|
|
Towerops.DataCase.setup_sandbox(tags)
|
|
{: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.
|
|
"""
|
|
def register_and_log_in_user(%{conn: conn} = context) do
|
|
user = Towerops.AccountsFixtures.user_fixture(enable_totp: true)
|
|
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 """
|
|
Registers and logs in a user with sudo mode enabled.
|
|
|
|
It stores an updated connection and a registered user in the
|
|
test context.
|
|
"""
|
|
def register_and_log_in_user_with_sudo(%{conn: conn} = context) do
|
|
user = Towerops.AccountsFixtures.user_fixture(enable_totp: true)
|
|
{:ok, user} = Towerops.Accounts.grant_sudo_mode(user)
|
|
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`.
|
|
"""
|
|
def log_in_user(conn, user, opts \\ []) do
|
|
token = Towerops.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
|
|
Towerops.AccountsFixtures.override_token_authenticated_at(token, authenticated_at)
|
|
end
|
|
|
|
@doc """
|
|
Asserts that a condition eventually becomes true within a timeout.
|
|
|
|
Retries the given function until it returns true or the timeout is reached.
|
|
Useful for waiting for async operations like PubSub messages to be processed.
|
|
|
|
## Examples
|
|
|
|
assert_eventually(fn -> render(view) =~ "Updated Name" end)
|
|
assert_eventually(fn -> has_element?(view, "#some-element") end, timeout: 1000, interval: 50)
|
|
|
|
"""
|
|
def assert_eventually(fun, opts \\ []) do
|
|
timeout = Keyword.get(opts, :timeout, 500)
|
|
interval = Keyword.get(opts, :interval, 10)
|
|
deadline = System.monotonic_time(:millisecond) + timeout
|
|
|
|
do_assert_eventually(fun, deadline, interval)
|
|
end
|
|
|
|
defp do_assert_eventually(fun, deadline, interval) do
|
|
if fun.() do
|
|
true
|
|
else
|
|
now = System.monotonic_time(:millisecond)
|
|
|
|
if now >= deadline do
|
|
raise ExUnit.AssertionError,
|
|
message: "Condition did not become true within timeout"
|
|
else
|
|
# Use receive with a timeout instead of Process.sleep so the test
|
|
# remains responsive to messages (e.g. IEx breakpoints, test
|
|
# framework interrupts). The timeout is the remaining interval.
|
|
remaining = min(interval, deadline - now)
|
|
|
|
receive do
|
|
after
|
|
remaining -> :ok
|
|
end
|
|
|
|
do_assert_eventually(fun, deadline, interval)
|
|
end
|
|
end
|
|
end
|
|
end
|