269 lines
11 KiB
Elixir
269 lines
11 KiB
Elixir
defmodule Firehose.MixProject do
|
|
use Mix.Project
|
|
|
|
def project do
|
|
[
|
|
app: :firehose,
|
|
version: "0.2.0",
|
|
elixir: "~> 1.15",
|
|
elixirc_paths: elixirc_paths(Mix.env()),
|
|
start_permanent: Mix.env() == :prod,
|
|
aliases: aliases(),
|
|
deps: deps(),
|
|
test_coverage: test_coverage(),
|
|
compilers: extra_compilers(Mix.env()) ++ [:phoenix_live_view] ++ Mix.compilers(),
|
|
listeners: [Phoenix.CodeReloader]
|
|
]
|
|
end
|
|
|
|
# Configuration for the OTP application.
|
|
#
|
|
# Type `mix help compile.app` for more information.
|
|
def application do
|
|
[
|
|
mod: {Firehose.Application, []},
|
|
extra_applications: [:logger, :runtime_tools]
|
|
]
|
|
end
|
|
|
|
def cli do
|
|
[
|
|
preferred_envs: [precommit: :test]
|
|
]
|
|
end
|
|
|
|
# Specifies which paths to compile per environment.
|
|
#
|
|
# `lib_dev/` is deliberately NOT compiled in any environment: it holds
|
|
# credo-only checks (Firehose.Checks.NoConnShadowing), and credo loads them
|
|
# itself from source via `requires:` in .credo.exs. Compiling that path as
|
|
# well gave every run two load paths for the same module, which surfaces as
|
|
# "warning: redefining module Firehose.Checks.NoConnShadowing" on a warm
|
|
# `_build/dev`. Keep the single source load: if you add code under lib_dev/
|
|
# that is NOT a credo check, give it its own compiled path instead.
|
|
defp elixirc_paths(:test), do: ["lib", "test/support"]
|
|
defp elixirc_paths(_), do: ["lib"]
|
|
|
|
# The boundary compiler must be listed *before* `:elixir`: it enforces by
|
|
# registering an `after_compiler(:elixir, ...)` callback, so a later position
|
|
# would look wired and report nothing. It stays out of `:prod` on boundary's
|
|
# own advice (a violation must not be able to fail a release build); `:dev`
|
|
# and `:test` are where code is written.
|
|
defp extra_compilers(env) when env in [:dev, :test], do: [:boundary]
|
|
defp extra_compilers(_), do: []
|
|
|
|
# Specifies your project dependencies.
|
|
#
|
|
# Type `mix help deps` for examples and options.
|
|
defp deps do
|
|
[
|
|
{:bcrypt_elixir, "~> 3.0"},
|
|
{:phoenix, "~> 1.8.1"},
|
|
{:phoenix_ecto, "~> 4.5"},
|
|
{:ecto_sql, "~> 3.14"},
|
|
{:postgrex, ">= 0.0.0"},
|
|
{:phoenix_html, "~> 4.1"},
|
|
{:phoenix_live_reload, "~> 1.2", only: :dev},
|
|
{:phoenix_live_view, "~> 1.2"},
|
|
{:lazy_html, ">= 0.1.0", only: :test},
|
|
{:phoenix_live_dashboard, "~> 0.8.3"},
|
|
{:esbuild, "~> 0.10", runtime: Mix.env() == :dev},
|
|
{:tailwind, "~> 0.3", runtime: Mix.env() == :dev},
|
|
{:heroicons,
|
|
github: "tailwindlabs/heroicons",
|
|
tag: "v2.2.0",
|
|
sparse: "optimized",
|
|
app: false,
|
|
compile: false,
|
|
depth: 1},
|
|
{:swoosh, "~> 1.16"},
|
|
{:gen_smtp, "~> 1.0"},
|
|
{:req, "~> 0.7"},
|
|
{:telemetry_metrics, "~> 1.0"},
|
|
{:telemetry_poller, "~> 1.0"},
|
|
{:gettext, "~> 0.26"},
|
|
{:jason, "~> 1.2"},
|
|
{:dns_cluster, "~> 0.2.0"},
|
|
{:bandit, "~> 1.5"},
|
|
{:blogex, path: "../blogex"},
|
|
{:microprints,
|
|
git: "https://gitea.apps.sustainabledelivery.com/QWAN/microprints-phoenix.git",
|
|
branch: "main"},
|
|
# Compile-time boundary enforcement (Firehose / FirehoseWeb / Firehose.Repo).
|
|
# Declared directly even though `ex_crap` already pulls it in transitively:
|
|
# dropping a test-only metric tool must not silently take the boundary
|
|
# compiler with it.
|
|
{:boundary, "~> 0.11", runtime: false},
|
|
{:credo, "~> 1.7", only: [:dev, :test], runtime: false},
|
|
{:ex_crap, "~> 0.1.1", only: [:dev, :test], runtime: false},
|
|
{:muex, "~> 0.12", only: [:dev, :test], runtime: false},
|
|
{:sobelow, "~> 0.16", only: [:dev, :test], runtime: false}
|
|
]
|
|
end
|
|
|
|
# Aliases are shortcuts or tasks specific to the current project.
|
|
# For example, to install project dependencies and perform other setup tasks, run:
|
|
#
|
|
# $ mix setup
|
|
#
|
|
# See the documentation for `Mix` for more info on aliases.
|
|
#
|
|
# `mutate` / `mutate.fast` are a sensor, not a gate: they are deliberately
|
|
# absent from Makefile's VERIFY_SENSORS and always pass `--fail-at 0`, so a
|
|
# survivor is reported rather than fatal. The scope lives in the plain-text
|
|
# files beside this one; the aliases read them at run time, so the text file
|
|
# stays the single source of truth. Both are empty today because the app's
|
|
# candidate modules are only tested through the database-backed DataCase;
|
|
# an empty scope raises instead of silently running over nothing.
|
|
defp aliases do
|
|
[
|
|
setup: ["deps.get", "ecto.setup", "assets.setup", "assets.build"],
|
|
"ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
|
|
"ecto.reset": ["ecto.drop", "ecto.setup"],
|
|
test: ["ecto.create --quiet", "ecto.migrate --quiet", "test"],
|
|
"assets.setup": ["tailwind.install --if-missing", "esbuild.install --if-missing"],
|
|
"assets.build": ["compile", "tailwind firehose", "esbuild firehose"],
|
|
"assets.deploy": [
|
|
"tailwind firehose --minify",
|
|
"esbuild firehose --minify",
|
|
"phx.digest"
|
|
],
|
|
precommit: ["compile --warning-as-errors", "deps.unlock --unused", "format", "test"],
|
|
mutate: &mutate/1,
|
|
"mutate.fast": &mutate_fast/1
|
|
]
|
|
end
|
|
|
|
# No macro/`use` mutators: the web layer (where the DSLs live) is out of
|
|
# scope, and an empty scope never reaches muex at all. Spellings are muex
|
|
# 0.12's CLI names.
|
|
@mutation_mutators "arithmetic,boolean,comparison,conditional,function_call,literal,return_value"
|
|
|
|
defp mutate(args), do: run_mutation("mutation_scope.txt", args)
|
|
|
|
defp mutate_fast(args), do: run_mutation("mutation_scope_fast.txt", args)
|
|
|
|
defp run_mutation(scope_file, args) do
|
|
Mix.Task.run("muex", mutation_args(scope_file, args))
|
|
end
|
|
|
|
@doc false
|
|
def mutation_args(scope_file, extra_args \\ []) do
|
|
files = read_mutation_scope(scope_file)
|
|
|
|
# `--fail-at 0` comes first so an ad-hoc override cannot turn the sensor
|
|
# into a gate. Extra args come before our defaults, and OptionParser keeps
|
|
# the first value, so `mix mutate --files lib/foo.ex` targets one file.
|
|
["--fail-at", "0"] ++
|
|
extra_args ++
|
|
["--files", Enum.join(files, ","), "--mutators", @mutation_mutators]
|
|
end
|
|
|
|
@doc false
|
|
def read_mutation_scope(scope_file) do
|
|
path = Path.expand(scope_file, Path.dirname(Mix.Project.project_file()))
|
|
|
|
files =
|
|
case File.read(path) do
|
|
{:ok, contents} ->
|
|
contents
|
|
|> String.split("\n", trim: true)
|
|
|> Enum.map(&String.trim/1)
|
|
|> Enum.reject(&(&1 == ""))
|
|
|
|
{:error, reason} ->
|
|
Mix.raise(
|
|
"mutation scope #{scope_file} is unreadable (#{:file.format_error(reason)}); " <>
|
|
"refusing to run the mutation sensor over an unknown scope"
|
|
)
|
|
end
|
|
|
|
if files == [] do
|
|
Mix.raise(
|
|
"mutation scope #{scope_file} is empty; refusing to run the mutation sensor over nothing"
|
|
)
|
|
end
|
|
|
|
files
|
|
end
|
|
|
|
# The coverage floor the Lens pass enforces (`make verify` -> `make coverage`
|
|
# in app/). Rule: the threshold is a FLOOR. Raise it as behavior-test yaks
|
|
# land; never lower it. A drop means the change (or an exclusion) is wrong,
|
|
# not the floor.
|
|
#
|
|
# Measured 2026-10-29 (PostgreSQL on localhost:5432, exclusions below):
|
|
# 94.01% on `main` = 9c0f33e, with boundary enforcement, credo, the mutation
|
|
# scope and the core-components behavior tests all landed (88.19% after the
|
|
# web-controller/auth edge-case tests, 87.56% after the editorial-LiveView
|
|
# ones, 86.97% before them, and 86.79% / 86.17% at earlier exclusion
|
|
# revisions), identical via `mix test --cover` and via
|
|
# `mix test --cover --export-coverage default` + `mix test.coverage`. Floor is
|
|
# the integer below that — so a floor of 94 means "at least 94.00%".
|
|
#
|
|
# `test.coverage` deletes stale exports before sampling: `mix test.coverage`
|
|
# imports *every* .coverdata it finds, so leftover exports from earlier runs
|
|
# pool into the total and quietly inflate it.
|
|
#
|
|
# Excluded are modules the suite cannot or should not exercise; counting them
|
|
# would move the number without saying anything about app behavior:
|
|
#
|
|
# * framework glue generated by `use`:
|
|
# Firehose.Repo `use Ecto.Repo`
|
|
# Firehose.Mailer `use Swoosh.Mailer`
|
|
# FirehoseWeb.Telemetry Phoenix's telemetry supervisor + metric list
|
|
# FirehoseWeb.ErrorHTML Phoenix error renderers, both delegating to
|
|
# FirehoseWeb.ErrorJSON Phoenix.Controller.status_message_from_template/1
|
|
# * FirehoseWeb the `use FirehoseWeb` macro: imports and aliases
|
|
# only, nothing that executes
|
|
# * embed_templates wrappers FirehoseWeb.BlogHTML,
|
|
# FirehoseWeb.UserRegistrationHTML,
|
|
# FirehoseWeb.UserSettingsHTML: each is `use` +
|
|
# `embed_templates`, so every function in them is
|
|
# generated by the macro. Their TEMPLATES are
|
|
# exercised through the controller tests; the
|
|
# wrapper modules hold no hand-written code.
|
|
# NOTE: PageHTML and UserSessionHTML are
|
|
# deliberately NOT excluded — both carry private
|
|
# helpers with real logic (blog_label,
|
|
# post_base_path, local_mail_adapter?), so their
|
|
# gaps are behavior gaps, not macro noise.
|
|
# * Firehose.Application start/2 is proven by the suite booting at all (a
|
|
# broken supervision tree fails every test), and
|
|
# config_change/3 only runs on a release hot
|
|
# upgrade, which no test can reach.
|
|
# * Firehose.Release production release tasks (`mix ecto.migrate` on
|
|
# Dokku); the suite never runs them
|
|
# * test scaffolding Firehose.DataCase, FirehoseWeb.ConnCase,
|
|
# Firehose.AccountsFixtures, Firehose.Test.FakeBlog:
|
|
# fixtures measure the tests, not the app
|
|
#
|
|
# `Firehose.Checks.NoConnShadowing` needs no entry: lib_dev/ is no longer in
|
|
# elixirc_paths (credo loads it from source), so it is not measurable here.
|
|
#
|
|
# Everything else counts — CoreComponents, controllers, LiveViews included:
|
|
# that is where the behavior-test work shows up as a higher floor.
|
|
defp test_coverage do
|
|
[
|
|
summary: [threshold: 94],
|
|
ignore_modules: [
|
|
Firehose.Repo,
|
|
Firehose.Mailer,
|
|
Firehose.Release,
|
|
Firehose.Application,
|
|
FirehoseWeb,
|
|
FirehoseWeb.Telemetry,
|
|
FirehoseWeb.ErrorHTML,
|
|
FirehoseWeb.ErrorJSON,
|
|
FirehoseWeb.BlogHTML,
|
|
FirehoseWeb.UserRegistrationHTML,
|
|
FirehoseWeb.UserSettingsHTML,
|
|
Firehose.DataCase,
|
|
FirehoseWeb.ConnCase,
|
|
Firehose.AccountsFixtures,
|
|
Firehose.Test.FakeBlog
|
|
]
|
|
]
|
|
end
|
|
end
|