prop/test/test_helper.exs
Graham McIntire 82bcaa5a54
Some checks failed
Build and Push / Build and Push Docker Image (push) Has been cancelled
refactor: idiomatic test sandbox setup (manual mode, single reset hook)
Replace the non-idiomatic :auto sandbox mode with :manual, eliminating
the root cause of stale data across test runs. The :auto mode let any
process auto-checkout and commit outside test transactions — Oban in
testing:inline already disables plugins/queues, so :auto was never
needed.

Changes:
- test_helper: Sandbox.mode(Repo, :manual); drop manual app boot (mix
  now starts the app idiomatically), drop --no-start alias, drop
  table-cleanup loop
- DataCase: single reset_test_state/0 consolidates GridCache.clear,
  ScoreCache.clear, score-file wipe, and default HTTP stubs; drop
  the :auto-restore on_exit hack; setup_sandbox now just start_owner
- ConnCase: delegates shared reset to DataCase, removes duplicate
  cache clears and stub installs
- config: pool Ecto.Adapters.SQL.Sandbox (idiomatic canonical form)

Note: GridCache/ScoreCache are globally-registered GenServers, so
the architecturally clean per-test start_supervised! approach
conflicts with async:true (parallel tests can't register the same
name). The centralized clear in reset_test_state is the practical
compromise — one place, documented, single call.
2026-08-04 17:47:49 -05:00

64 lines
2.9 KiB
Elixir

alias Ecto.Adapters.SQL.Sandbox
# Elixir 1.20 loads test_helper before dependency ebin dirs are on the
# code path. Add them manually so `use` / `import` in test files can
# resolve modules from :only test deps (Mox, ExUnitProperties, etc.).
for dep_dir <- Path.wildcard("_build/test/lib/*/ebin") do
:code.add_patha(String.to_charlist(dep_dir))
end
# Ensure test support modules are compiled and loaded before ExUnit
# starts lazily compiling the test suite. The parallel compiler workers
# inherit the code server state, so loading them here makes them visible
# everywhere.
Code.require_file("test/support/data_case.ex")
Code.require_file("test/support/conn_case.ex")
Code.require_file("test/support/fixtures/accounts_fixtures.ex")
Code.require_file("test/support/fixtures/beacons_fixtures.ex")
Code.require_file("test/support/fixtures/contacts_fixtures.ex")
ExUnit.start()
# :manual mode: only the test process (via start_owner! / checkout) and
# processes explicitly allowed via Sandbox.allow/4 or Caller Tracking
# ($callers) can access the database. Background processes (Oban plugins,
# boot Tasks) that auto-checked out during app boot are checked in here,
# preventing any stale data from leaking across tests or across runs.
Sandbox.mode(Microwaveprop.Repo, :manual)
# stream_data is a test-only dep — its ebin is on the code path from the
# wildcard above, but the application isn't started. `check all` etc.
# call Application.fetch_env!(:stream_data, :initial_size), which needs
# the app to be loaded.
Application.ensure_all_started(:stream_data)
# lazy_html provides an Enumerable protocol implementation for the
# LazyHTML struct. When protocol consolidation is enabled (the default),
# the consolidated Elixir.Enumerable.beam file is generated during
# `mix compile`. If that consolidation pass runs before lazy_html is on
# the code path, the dispatch table omits LazyHTML — causing every test
# that uses Phoenix.LiveViewTest (which calls Enum.each/2 on LazyHTML
# structs via DOM.parse_document/2) to crash with:
#
# (Protocol.UndefinedError) protocol Enumerable not implemented for
# LazyHTML (a struct)
#
# mix.exs disables `consolidate_protocols` in the test environment so
# the protocol uses dynamic dispatch instead, which always finds the
# Enumerable.LazyHTML implementation at runtime.
# Silence sandbox-cleanup disconnect noise. When a test process exits
# while still owning a Postgrex connection, the protocol logs an
# `[error] Postgrex.Protocol ... disconnected: ... client #PID<...>
# exited`. It's benign — the connection is being torn down on purpose
# — but at :error level it bypasses `capture_log: true` (which only
# captures logs from the test process). Pinning these modules to
# :critical drops the noise without affecting real DB error logging.
Logger.put_module_level(
[Postgrex.Protocol, DBConnection.Connection],
:critical
)
if Code.ensure_loaded?(Mox) do
Mox.defmock(Microwaveprop.Valkey.MockAdapter, for: Microwaveprop.Valkey.Adapter)
end